Class: Datadog::Core::Configuration::Settings::DSL::Telemetry

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog/core/configuration/settings.rb

Overview

Client-side telemetry configuration

Instance Attribute Summary collapse

Instance Attribute Details

#debug ⇒ Boolean

For internal use only. Enables telemetry debugging through the Datadog platform.

Returns:

  • (Boolean)

Defaults to:

  • false.



1015
1016
1017
# File 'lib/datadog/core/configuration/settings.rb', line 1015

def debug
  @debug
end

#dependency_collection ⇒ Boolean

Whether the bundled Ruby gems as reported through telemetry.

Returns:

  • (Boolean)

Defaults to:

  • DD_TELEMETRY_DEPENDENCY_COLLECTION_ENABLED environment variable, otherwise true.



860
861
862
# File 'lib/datadog/core/configuration/settings.rb', line 860

def dependency_collection
  @dependency_collection
end

#enabled ⇒ Boolean

Enable telemetry collection. This allows telemetry events to be emitted to the telemetry API.

Returns:

  • (Boolean)

Defaults to:

  • DD_INSTRUMENTATION_TELEMETRY_ENABLED environment variable, otherwise true. Can be disabled as documented here. By default, telemetry is disabled in development environments.



872
873
874
# File 'lib/datadog/core/configuration/settings.rb', line 872

def enabled
  @enabled
end

#log_collection_enabled ⇒ Boolean

Enable log collection for telemetry. Log collection only works when telemetry is enabled and logs are enabled.

Returns:

  • (Boolean)

Defaults to:

  • DD_TELEMETRY_LOG_COLLECTION_ENABLED environment variable, otherwise true.



1004
1005
1006
# File 'lib/datadog/core/configuration/settings.rb', line 1004

def log_collection_enabled
  @log_collection_enabled
end

#metrics_enabled ⇒ Boolean

Enable metrics collection for telemetry. Metrics collection only works when telemetry is enabled and metrics are enabled.

Returns:

  • (Boolean)

Defaults to:

  • DD_TELEMETRY_METRICS_ENABLED environment variable, otherwise true.



911
912
913
# File 'lib/datadog/core/configuration/settings.rb', line 911

def metrics_enabled
  @metrics_enabled
end