Class: Datadog::Core::Configuration::Settings::DSL::Diagnostics

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

Overview

Datadog diagnostic settings.

Enabling these surfaces debug information that can be helpful to diagnose issues related to Datadog internals.

Defined Under Namespace

Classes: HealthMetrics, StartupLogs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#debug ⇒ Boolean

Outputs all spans created by the host application to Datadog.logger.

This option is very verbose! It's only recommended for non-production environments.

This option is helpful when trying to understand what information the Datadog features are sending to the Agent or backend.

Returns:

  • (Boolean)

Defaults to:

  • DD_TRACE_DEBUG environment variable, otherwise false



102
103
104
 
# File 'lib/datadog/core/configuration/settings.rb', line 102

def debug
  @debug
end

Instance Method Details

#health_metrics ⇒ Datadog::Core::Configuration::Settings::DSL::Diagnostics::HealthMetrics

Internal Statsd metrics collection.

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/datadog/core/configuration/settings.rb', line 115

settings :health_metrics do
  # Enable health metrics collection.
  #
  # @default `DD_HEALTH_METRICS_ENABLED` environment variable, otherwise `false`
  # @return [Boolean]
  option :enabled do |o|
    o.env Datadog::Core::Configuration::Ext::Diagnostics::ENV_HEALTH_METRICS_ENABLED
    o.default false
    o.type :bool
  end

  # {Datadog::Statsd} instance to collect health metrics.
  #
  # If `nil`, health metrics creates a new {Datadog::Statsd} client with default agent configuration.
  #
  # @default `nil`
  # @return [Datadog::Statsd,nil] a custom {Datadog::Statsd} instance
  # @return [nil] an instance with default agent configuration will be lazily created
  option :statsd
end

#startup_logs ⇒ Datadog::Core::Configuration::Settings::DSL::Diagnostics::StartupLogs

Tracer startup debug log statement configuration.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/datadog/core/configuration/settings.rb', line 138

settings :startup_logs do
  # Enable startup logs collection.
  #
  # If `nil`, defaults to logging startup logs when `ddtrace` detects that the application
  # is *not* running in a development environment.
  #
  # @default `DD_TRACE_STARTUP_LOGS` environment variable, otherwise `nil`
  # @return [Boolean, nil]
  option :enabled do |o|
    o.env Datadog::Core::Configuration::Ext::Diagnostics::ENV_STARTUP_LOGS_ENABLED
    # Defaults to nil as we want to know when the default value is being used
    o.type :bool, nilable: true
  end
end