Class: Datadog::Core::Configuration::Settings

Inherits:
Object
  • Object
show all
Extended by:
Tracing::Configuration::Settings
Includes:
Base
Defined in:
lib/datadog/core/configuration/settings.rb

Overview

Global configuration settings for the Datadog library.

Defined Under Namespace

Modules: DSL

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Tracing::Configuration::Settings

extended

Methods included from Base

included

Instance Attribute Details

#api_key ⇒ String?

Datadog API key.

For internal use only.

Returns:

  • (String, nil)

Defaults to:

  • DD_API_KEY environment variable, otherwise nil



104
105
106
 
# File 'lib/datadog/core/configuration/settings.rb', line 104

def api_key
  @api_key
end

#env ⇒ String?

The env tag in Datadog. Use it to separate out your staging, development, and production environments.

Returns:

  • (String, nil)

See Also:

Defaults to:

  • DD_ENV environment variable, otherwise nil



166
167
168
 
# File 'lib/datadog/core/configuration/settings.rb', line 166

def env
  @env
end

#get_time_provider ⇒ Proc<Numeric>

The monotonic clock time provider used by Datadog. This option is internal and is used by datadog-ci gem to avoid traces' durations being skewed by timecop.

It must respect the interface of [Datadog::Core::Utils::Time#get_time] method.

For Timecop, for example, ->(unit = :float_second) { ::Process.clock_gettime_without_mock(::Process::CLOCK_MONOTONIC, unit) } allows Datadog features to use the real monotonic time when time is frozen with Timecop.mock_process_clock = true.

Returns:

  • (Proc<Numeric>)

Defaults to:

  • ->(unit = :float_second) { ::Process.clock_gettime(::Process::CLOCK_MONOTONIC, unit)}



724
725
726
 
# File 'lib/datadog/core/configuration/settings.rb', line 724

def get_time_provider
  @get_time_provider
end

#service ⇒ String

The service tag in Datadog. Use it to group related traces into a service.

Returns:

  • (String)

See Also:

Defaults to:

  • DD_SERVICE environment variable, otherwise the program name (e.g. 'ruby', 'rails', 'pry')



587
588
589
 
# File 'lib/datadog/core/configuration/settings.rb', line 587

def service
  @service
end

#site ⇒ String?

The Datadog site host to send data to. By default, data is sent to the Datadog US site: app.datadoghq.com.

If your organization is on another site, you must update this value to the new site.

For internal use only.

Returns:

  • (String, nil)

See Also:

Defaults to:

  • DD_SITE environment variable, otherwise nil which sends data to app.datadoghq.com



613
614
615
 
# File 'lib/datadog/core/configuration/settings.rb', line 613

def site
  @site
end

#tags ⇒ Hash<String,String>

Default tags

These tags are used by all Datadog products, when applicable. e.g. trace spans, profiles, etc.

Returns:

  • (Hash<String,String>)

Defaults to:

  • DD_TAGS environment variable (in the format 'tag1:value1,tag2:value2'), otherwise {}



624
625
626
 
# File 'lib/datadog/core/configuration/settings.rb', line 624

def tags
  @tags
end

#time_now_provider ⇒ Proc<Time>

The time provider used by Datadog. It must respect the interface of Time.

When testing, it can be helpful to use a different time provider.

For Timecop, for example, ->{ Time.now_without_mock_time } allows Datadog features to use the real wall time when time is frozen.

Returns:

  • (Proc<Time>)

Defaults to:

  • ->{ Time.now }



695
696
697
 
# File 'lib/datadog/core/configuration/settings.rb', line 695

def time_now_provider
  @time_now_provider
end

#version ⇒ String?

The version tag in Datadog. Use it to enable Deployment Tracking.

Returns:

  • (String, nil)

See Also:

Defaults to:

  • DD_VERSION environment variable, otherwise nils



743
744
745
 
# File 'lib/datadog/core/configuration/settings.rb', line 743

def version
  @version
end

Instance Method Details

#agent ⇒ Datadog::Core::Configuration::Settings::DSL::Agent

Datadog Agent configuration.

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/datadog/core/configuration/settings.rb', line 54

settings :agent do
  # Agent hostname or IP.
  # @default `DD_AGENT_HOST` environment variable, otherwise `127.0.0.1`
  # @return [String,nil]
  option :host

  # Agent APM TCP port.
  # @see https://docs.datadoghq.com/getting_started/tracing/#datadog-apm
  # @default `DD_TRACE_AGENT_PORT` environment variable, otherwise `8126`
  # @return [String,nil]
  option :port

  # Agent APM SSL.
  # @see https://docs.datadoghq.com/getting_started/tracing/#datadog-apm
  # @default defined as part of `DD_TRACE_AGENT_URL` environment variable, otherwise `false`
  # Only applies to http connections.
  # @return [Boolean,nil]
  option :use_ssl

  # Agent APM Timeout.
  # @see https://docs.datadoghq.com/getting_started/tracing/#datadog-apm
  # @default `DD_TRACE_AGENT_TIMEOUT_SECONDS` environment variable, otherwise `30` for http, '1' for UDS
  # @return [Integer,nil]
  option :timeout_seconds

  # Agent unix domain socket path.
  # @default defined in `DD_TRACE_AGENT_URL` environment variable, otherwise '/var/run/datadog/apm.socket'
  # Agent connects via HTTP by default, but will use UDS if this is set or if unix scheme defined in
  # DD_TRACE_AGENT_URL.
  # @return [String,nil]
  option :uds_path

  # TODO: add declarative statsd configuration. Currently only usable via an environment variable.
  # Statsd configuration for agent access.
  # @public_api
  # settings :statsd do
  #   # Agent Statsd UDP port.
  #   # @configure_with {Datadog::Statsd}
  #   # @default `DD_AGENT_HOST` environment variable, otherwise `8125`
  #   # @return [String,nil]
  #   option :port
  # end
end

#apm ⇒ Datadog::Core::Configuration::Settings::DSL::Apm

Tracer specific configuration starting with APM (e.g. DD_APM_TRACING_ENABLED).

Returns:



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
 
# File 'lib/datadog/core/configuration/settings.rb', line 962

settings :apm do
  # Tracing as a transport
  # @public_api
  settings :tracing do
    # Enables tracing as transport.
    # Disabling it will set sampling priority to -1 (FORCE_DROP) on most traces,
    # (which tells to the agent to drop these traces)
    # except heartbeat ones (1 per minute) and manually kept ones (sampling priority to 2) (e.g. appsec events)
    #
    # This is different than `DD_TRACE_ENABLED`, which completely disables tracing (sends no trace at all),
    # while this will send heartbeat traces (1 per minute) so that the service is considered alive in the backend.
    #
    # @default `DD_APM_TRACING_ENABLED` environment variable, otherwise `true`
    # @return [Boolean]
    option :enabled do |o|
      o.env Configuration::Ext::APM::ENV_TRACING_ENABLED
      o.default true
      o.type :bool
    end
  end
end

#crashtracking ⇒ Datadog::Core::Configuration::Settings::DSL::Crashtracking

Returns a configuration object.

Returns:

  • (Datadog::Core::Configuration::Settings::DSL::Crashtracking) —

    a configuration object



951
952
953
954
955
956
957
958
 
# File 'lib/datadog/core/configuration/settings.rb', line 951

settings :crashtracking do
  # Enables reporting of information when Ruby VM crashes.
  option :enabled do |o|
    o.type :bool
    o.default true
    o.env 'DD_CRASHTRACKING_ENABLED'
  end
end

#diagnostics ⇒ Datadog::Core::Configuration::Settings::DSL::Diagnostics

Datadog diagnostic settings.

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

Returns:



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/datadog/core/configuration/settings.rb', line 114

settings :diagnostics do
  # 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.
  # @default `DD_TRACE_DEBUG` environment variable, otherwise `false`
  # @return [Boolean]
  option :debug do |o|
    o.env [Datadog::Core::Configuration::Ext::Diagnostics::ENV_DEBUG_ENABLED,
           Datadog::Core::Configuration::Ext::Diagnostics::ENV_OTEL_LOG_LEVEL]
    o.default false
    o.type :bool
    o.env_parser do |value|
      if value
        value = value.strip.downcase
        # Debug is enabled when DD_TRACE_DEBUG is true or 1 OR
        # when OTEL_LOG_LEVEL is set to debug
        ['true', '1', 'debug'].include?(value)
      end
    end
    o.after_set do |enabled|
      # Enable rich debug print statements.
      # We do not need to unnecessarily load 'pp' unless in debugging mode.
      require 'pp' if enabled
    end
  end

  # Tracer startup debug log statement configuration.
  # @public_api
  settings :startup_logs do
    # Enable startup logs collection.
    #
    # If `nil`, defaults to logging startup logs when `datadog` 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
end

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

Internal Statsd metrics collection.

Returns:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/datadog/core/configuration/settings.rb', line 175

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

#logger ⇒ Datadog::Core::Configuration::Settings::DSL::Logger

Internal Datadog.logger configuration.

This logger instance is only used internally by the gem.

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/datadog/core/configuration/settings.rb', line 200

settings :logger do
  # The `Datadog.logger` object.
  #
  # Can be overwritten with a custom logger object that respects the
  # [built-in Ruby Logger](https://ruby-doc.org/stdlib-3.0.1/libdoc/logger/rdoc/Logger.html)
  # interface.
  #
  # @return Logger::Severity
  option :instance do |o|
    o.after_set { |value| set_option(:level, value.level) unless value.nil? }
  end

  # Log level for `Datadog.logger`.
  # @see Logger::Severity
  # @return Logger::Severity
  option :level, default: ::Logger::INFO
end

#profiling ⇒ Datadog::Core::Configuration::Settings::DSL::Profiling

Datadog Profiler-specific configurations.

Returns:

See Also:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/datadog/core/configuration/settings.rb', line 222

settings :profiling do
  # Enable profiling.
  #
  # @default `DD_PROFILING_ENABLED` environment variable, otherwise `false`
  # @return [Boolean]
  option :enabled do |o|
    o.env Profiling::Ext::ENV_ENABLED
    o.default false
    o.type :bool
  end

  # @public_api
  settings :exporter do
    option :transport
  end

  # Can be used to enable/disable collection of allocation profiles.
  #
  # This feature is disabled by default
  #
  # @warn Due to bugs in Ruby we only recommend enabling this feature in
  #       Ruby versions 2.x, 3.1.4+, 3.2.3+ and 3.3.0+
  #       (more details in {Datadog::Profiling::Component.enable_allocation_profiling?})
  #
  # @default `DD_PROFILING_ALLOCATION_ENABLED` environment variable as a boolean, otherwise `false`
  option :allocation_enabled do |o|
    o.type :bool
    o.env 'DD_PROFILING_ALLOCATION_ENABLED'
    o.default false
  end

  # @public_api
  settings :advanced do
    # Controls the maximum number of frames for each thread sampled. Can be tuned to avoid omitted frames in the
    # produced profiles. Increasing this may increase the overhead of profiling.
    #
    # @default `DD_PROFILING_MAX_FRAMES` environment variable, otherwise 400
    option :max_frames do |o|
      o.type :int
      o.env Profiling::Ext::ENV_MAX_FRAMES
      o.default 400
    end

    # @public_api
    settings :endpoint do
      settings :collection do
        # When using profiling together with tracing, this controls if endpoint names
        # are gathered and reported together with profiles.
        #
        # @default `DD_PROFILING_ENDPOINT_COLLECTION_ENABLED` environment variable, otherwise `true`
        # @return [Boolean]
        option :enabled do |o|
          o.env Profiling::Ext::ENV_ENDPOINT_COLLECTION_ENABLED
          o.default true
          o.type :bool
        end
      end
    end

    # Can be used to disable the gathering of names and versions of gems in use by the service, used to power
    # grouping and categorization of stack traces.
    option :code_provenance_enabled do |o|
      o.type :bool
      o.default true
    end

    # Can be used to enable/disable garbage collection profiling.
    #
    # @warn To avoid https://bugs.ruby-lang.org/issues/18464 even when enabled, GC profiling is only started
    #       for Ruby versions 2.x, 3.1.4+, 3.2.3+ and 3.3.0+
    #       (more details in {Datadog::Profiling::Component.enable_gc_profiling?})
    #
    # @warn Due to a VM bug in the Ractor implementation (https://bugs.ruby-lang.org/issues/19112) this feature
    #       stops working when Ractors get garbage collected.
    #
    # @default `DD_PROFILING_GC_ENABLED` environment variable, otherwise `true`
    option :gc_enabled do |o|
      o.type :bool
      o.env 'DD_PROFILING_GC_ENABLED'
      o.default true
    end

    # Can be used to enable/disable the Datadog::Profiling.allocation_count feature.
    #
    # Requires allocation profiling to be enabled.
    #
    # @default false
    option :allocation_counting_enabled do |o|
      o.type :bool
      o.default false
    end

    # Can be used to enable/disable the collection of heap profiles.
    #
    # This feature is alpha and disabled by default
    #
    # @warn To enable heap profiling you are required to also enable allocation profiling.
    #
    # @default `DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED` environment variable as a boolean, otherwise `false`
    option :experimental_heap_enabled do |o|
      o.type :bool
      o.env 'DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED'
      o.default false
    end

    # Can be used to enable/disable the collection of heap size profiles.
    #
    # This feature is alpha and enabled by default when heap profiling is enabled.
    #
    # @warn To enable heap size profiling you are required to also enable allocation and heap profiling.
    #
    # @default `DD_PROFILING_EXPERIMENTAL_HEAP_SIZE_ENABLED` environment variable as a boolean, otherwise
    # whatever the value of DD_PROFILING_EXPERIMENTAL_HEAP_ENABLED is.
    option :experimental_heap_size_enabled do |o|
      o.type :bool
      o.env 'DD_PROFILING_EXPERIMENTAL_HEAP_SIZE_ENABLED'
      o.default true # This gets ANDed with experimental_heap_enabled in the profiler component.
    end

    # Can be used to configure the heap sampling rate: a heap sample will be collected for every x allocation
    # samples.
    #
    # The lower the value, the more accuracy in heap tracking but the bigger the overhead. In particular, a
    # value of 1 will track ALL allocations samples for heap profiles.
    #
    # The effective heap sampling rate in terms of allocations (not allocation samples) can be calculated via
    # effective_heap_sample_rate = allocation_sample_rate * heap_sample_rate.
    #
    # @default `DD_PROFILING_EXPERIMENTAL_HEAP_SAMPLE_RATE` environment variable, otherwise `10`.
    option :experimental_heap_sample_rate do |o|
      o.type :int
      o.env 'DD_PROFILING_EXPERIMENTAL_HEAP_SAMPLE_RATE'
      o.default 10
    end

    # Can be used to disable checking which version of `libmysqlclient` is being used by the `mysql2` gem.
    #
    # This setting is only used when the `mysql2` gem is installed.
    #
    # @default `DD_PROFILING_SKIP_MYSQL2_CHECK` environment variable, otherwise `false`
    option :skip_mysql2_check do |o|
      o.type :bool
      o.env 'DD_PROFILING_SKIP_MYSQL2_CHECK'
      o.default false
    end

    # Controls data collection for the timeline feature.
    #
    # If you needed to disable this, please tell us why on <https://github.com/DataDog/dd-trace-rb/issues/new>,
    # so we can fix it!
    #
    # @default `DD_PROFILING_TIMELINE_ENABLED` environment variable as a boolean, otherwise `true`
    option :timeline_enabled do |o|
      o.type :bool
      o.env 'DD_PROFILING_TIMELINE_ENABLED'
      o.default true
    end

    # The profiler gathers data by sending `SIGPROF` unix signals to Ruby application threads.
    #
    # Sending `SIGPROF` is a common profiling approach, and may cause system calls from native
    # extensions/libraries to be interrupted with a system
    # [EINTR error code.](https://man7.org/linux/man-pages/man7/signal.7.html#:~:text=Interruption%20of%20system%20calls%20and%20library%20functions%20by%20signal%20handlers)
    # Rarely, native extensions or libraries called by them may have missing or incorrect error handling for the
    # `EINTR` error code.
    #
    # The "no signals" workaround, when enabled, enables an alternative mode for the profiler where it does not
    # send `SIGPROF` unix signals. The downside of this approach is that the profiler data will have lower
    # quality.
    #
    # This workaround is automatically enabled when gems that are known to have issues handling
    # `EINTR` error codes are detected. If you suspect you may be seeing an issue due to the profiler's use of
    # signals, you can try manually enabling this mode as a fallback.
    # Please also report these issues to us on <https://github.com/DataDog/dd-trace-rb/issues/new>, so we can
    # work with the gem authors to fix them!
    #
    # @default `DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED` environment variable as a boolean, otherwise `:auto`
    option :no_signals_workaround_enabled do |o|
      o.env 'DD_PROFILING_NO_SIGNALS_WORKAROUND_ENABLED'
      o.default :auto
      o.env_parser do |value|
        if value
          value = value.strip.downcase
          ['true', '1'].include?(value)
        end
      end
    end

    # The profiler gathers data by sending `SIGPROF` unix signals to Ruby application threads.
    #
    # We've discovered that this can trigger a bug in a number of Ruby APIs in the `Dir` class, as
    # described in https://bugs.ruby-lang.org/issues/20586 .
    # This was fixed for Ruby 3.4+, and this setting is a no-op for those versions.
    #
    # @default `DD_PROFILING_DIR_INTERRUPTION_WORKAROUND_ENABLED` environment variable as a boolean,
    # otherwise `true`
    option :dir_interruption_workaround_enabled do |o|
      o.env 'DD_PROFILING_DIR_INTERRUPTION_WORKAROUND_ENABLED'
      o.type :bool
      o.default true
    end

    # Configures how much wall-time overhead the profiler targets. The profiler will dynamically adjust the
    # interval between samples it takes so as to try and maintain the property that it spends no longer than
    # this amount of wall-clock time profiling. For example, with the default value of 2%, the profiler will
    # try and cause no more than 1.2 seconds per minute of overhead. Decreasing this value will reduce the
    # accuracy of the data collected. Increasing will impact the application.
    #
    # We do not recommend tweaking this value.
    #
    # This value should be a percentage i.e. a number between 0 and 100, not 0 and 1.
    #
    # @default `DD_PROFILING_OVERHEAD_TARGET_PERCENTAGE` as a float, otherwise 2.0
    option :overhead_target_percentage do |o|
      o.type :float
      o.env 'DD_PROFILING_OVERHEAD_TARGET_PERCENTAGE'
      o.default 2.0
    end

    # Controls how often the profiler reports data, in seconds. Cannot be lower than 60 seconds.
    #
    # We do not recommend tweaking this value.
    #
    # @default `DD_PROFILING_UPLOAD_PERIOD` environment variable, otherwise 60
    option :upload_period_seconds do |o|
      o.type :int
      o.env 'DD_PROFILING_UPLOAD_PERIOD'
      o.default 60
    end

    # DEV-3.0: Remove `experimental_crash_tracking_enabled` option
    option :experimental_crash_tracking_enabled do |o|
      o.after_set do |_, _, precedence|
        unless precedence == Datadog::Core::Configuration::Option::Precedence::DEFAULT
          Core.log_deprecation(key: :experimental_crash_tracking_enabled) do
            'The profiling.advanced.experimental_crash_tracking_enabled setting has been deprecated for removal '\
            'and no longer does anything. Please remove it from your Datadog.configure block.'
          end
        end
      end
    end

    # @deprecated Use {:gvl_enabled} instead.
    option :preview_gvl_enabled do |o|
      o.type :bool
      o.default false
      o.after_set do |_, _, precedence|
        unless precedence == Datadog::Core::Configuration::Option::Precedence::DEFAULT
          Datadog.logger.warn(
            'The profiling.advanced.preview_gvl_enabled setting has been deprecated for removal and ' \
            'no longer does anything. Please remove it from your Datadog.configure block. ' \
            'GVL profiling is now controlled by the profiling.advanced.gvl_enabled setting instead.'
          )
        end
      end
    end

    # Controls GVL profiling. This will show when threads are waiting for GVL in the timeline view.
    #
    # This feature requires Ruby 3.2+.
    #
    # @default `DD_PROFILING_GVL_ENABLED` environment variable as a boolean, otherwise `true`
    option :gvl_enabled do |o|
      o.type :bool
      o.deprecated_env 'DD_PROFILING_PREVIEW_GVL_ENABLED'
      o.env 'DD_PROFILING_GVL_ENABLED'
      o.default true
    end

    # Controls the smallest time period the profiler will report a thread waiting for the GVL.
    #
    # The default value was set to minimize overhead. Periods smaller than the set value will not be reported (e.g.
    # the thread will be reported as whatever it was doing before it waited for the GVL).
    #
    # We do not recommend setting this to less than 1ms. Tweaking this value can increase application latency and
    # memory use.
    #
    # @default 10_000_000 (10ms)
    option :waiting_for_gvl_threshold_ns do |o|
      o.type :int
      o.default 10_000_000
    end

    # Controls if the profiler should attempt to read context from the otel library
    #
    # @default false
    option :preview_otel_context_enabled do |o|
      o.env 'DD_PROFILING_PREVIEW_OTEL_CONTEXT_ENABLED'
      o.default false
      o.env_parser do |value|
        if value
          value = value.strip.downcase
          if ['only', 'both'].include?(value)
            value
          elsif ['true', '1'].include?(value)
            'both'
          else
            'false'
          end
        end
      end
      o.setter do |value|
        if value == true
          :both
        elsif ['only', 'both', :only, :both].include?(value)
          value.to_sym
        else
          false
        end
      end
    end

    # Controls if the heap profiler should attempt to clean young objects after GC, rather than just at
    # serialization time. This lowers memory usage and high percentile latency.
    #
    # Only has effect when used together with `gc_enabled: true` and `experimental_heap_enabled: true`.
    #
    # @default true
    option :heap_clean_after_gc_enabled do |o|
      o.type :bool
      o.env 'DD_PROFILING_HEAP_CLEAN_AFTER_GC_ENABLED'
      o.default true
    end
  end

  # @public_api
  settings :upload do
    # Network timeout for reporting profiling data to Datadog.
    #
    # @default `DD_PROFILING_UPLOAD_TIMEOUT` environment variable, otherwise `30.0`
    option :timeout_seconds do |o|
      o.type :float
      o.env Profiling::Ext::ENV_UPLOAD_TIMEOUT
      o.default 30.0
    end
  end
end

#remote ⇒ Datadog::Core::Configuration::Settings::DSL::Remote

Remote configuration

Returns:



895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
 
# File 'lib/datadog/core/configuration/settings.rb', line 895

settings :remote do
  # Enable remote configuration. This allows fetching of remote configuration for live updates.
  #
  # @default `DD_REMOTE_CONFIGURATION_ENABLED` environment variable, otherwise `true`.
  #   By default, remote configuration is disabled in development environments.
  # @return [Boolean]
  option :enabled do |o|
    o.env Core::Remote::Ext::ENV_ENABLED
    o.default do
      if Datadog::Core::Environment::Execution.development?
        Datadog.logger.debug do
          'Development environment detected, disabling Remote Configuration. ' \
            'You can enable it with DD_REMOTE_CONFIGURATION_ENABLED=true.'
        end
        false
      else
        true
      end
    end
    o.type :bool
  end

  # Tune remote configuration polling interval.
  # This is a private setting. Do not use outside of Datadog. It might change at any point in time.
  #
  # @default `DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS` environment variable, otherwise `5.0` seconds.
  # @return [Float]
  # @!visibility private
  option :poll_interval_seconds do |o|
    o.env Core::Remote::Ext::ENV_POLL_INTERVAL_SECONDS
    o.type :float
    o.default 5.0
  end

  # Tune remote configuration boot timeout.
  # Early operations such as requests are blocked until RC is ready. In
  # order to not block the application indefinitely a timeout is
  # enforced allowing requests to proceed with the local configuration.
  #
  # @default `DD_REMOTE_CONFIG_BOOT_TIMEOUT` environment variable, otherwise `1.0` seconds.
  # @return [Float]
  option :boot_timeout_seconds do |o|
    o.env Core::Remote::Ext::ENV_BOOT_TIMEOUT_SECONDS
    o.type :float
    o.default 1.0
  end

  # Declare service name to bind to remote configuration. Use when
  # DD_SERVICE does not match the correct integration for which remote
  # configuration applies.
  #
  # @default `nil`.
  # @return [String,nil]
  option :service
end

#runtime_metrics ⇒ Datadog::Core::Configuration::Settings::DSL::RuntimeMetrics

Runtime Metrics are StatsD metrics collected by the tracer to gain additional insights into an application's performance.

Returns:



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/datadog/core/configuration/settings.rb', line 563

settings :runtime_metrics do
  # Enable runtime metrics.
  # @default `DD_RUNTIME_METRICS_ENABLED` environment variable, otherwise `false`
  # @return [Boolean]
  option :enabled do |o|
    o.env Core::Runtime::Ext::Metrics::ENV_ENABLED
    o.default false
    o.type :bool
  end

  option :experimental_runtime_id_enabled do |o|
    o.type :bool
    o.env 'DD_TRACE_EXPERIMENTAL_RUNTIME_ID_ENABLED'
    o.default false
  end

  option :opts, default: {}, type: :hash
  option :statsd
end

#telemetry ⇒ Datadog::Core::Configuration::Settings::DSL::Telemetry

Client-side telemetry configuration

Returns:



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
 
# File 'lib/datadog/core/configuration/settings.rb', line 751

settings :telemetry do
  # Whether the bundled Ruby gems as reported through telemetry.
  #
  # @default `DD_TELEMETRY_DEPENDENCY_COLLECTION_ENABLED` environment variable, otherwise `true`.
  # @return [Boolean]
  option :dependency_collection do |o|
    o.type :bool
    o.env Core::Telemetry::Ext::ENV_DEPENDENCY_COLLECTION
    o.default true
  end

  # Enable telemetry collection. This allows telemetry events to be emitted to the telemetry API.
  #
  # @default `DD_INSTRUMENTATION_TELEMETRY_ENABLED` environment variable, otherwise `true`.
  #   Can be disabled as documented [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection).
  #   By default, telemetry is disabled in development environments.
  # @return [Boolean]
  option :enabled do |o|
    o.env Core::Telemetry::Ext::ENV_ENABLED
    o.default do
      if Datadog::Core::Environment::Execution.development?
        Datadog.logger.debug do
          'Development environment detected, disabling Telemetry. ' \
            'You can enable it with DD_INSTRUMENTATION_TELEMETRY_ENABLED=true.'
        end
        false
      else
        true
      end
    end
    o.type :bool
  end

  # Enable agentless mode for telemetry: submit telemetry events directly to the intake without Datadog Agent.
  #
  # @return [Boolean]
  # @!visibility private
  option :agentless_enabled do |o|
    o.type :bool
    o.default false
  end

  # Overrides agentless telemetry URL. To be used internally for testing purposes only.
  #
  # @return [String]
  # @!visibility private
  option :agentless_url_override do |o|
    o.type :string, nilable: true
    o.env Core::Telemetry::Ext::ENV_AGENTLESS_URL_OVERRIDE
  end

  # Enable metrics collection for telemetry. Metrics collection only works when telemetry is enabled and
  # metrics are enabled.
  # @default `DD_TELEMETRY_METRICS_ENABLED` environment variable, otherwise `true`.
  # @return [Boolean]
  option :metrics_enabled do |o|
    o.type :bool
    o.env Core::Telemetry::Ext::ENV_METRICS_ENABLED
    o.default true
  end

  # The interval in seconds when telemetry must be sent.
  #
  # This method is used internally, for testing purposes only.
  #
  # @default `DD_TELEMETRY_HEARTBEAT_INTERVAL` environment variable, otherwise `60`.
  # @return [Float]
  # @!visibility private
  option :heartbeat_interval_seconds do |o|
    o.type :float
    o.env Core::Telemetry::Ext::ENV_HEARTBEAT_INTERVAL
    o.default 60.0
  end

  # The interval in seconds when telemetry metrics are aggregated.
  # Should be a denominator of `heartbeat_interval_seconds`.
  #
  # This method is used internally, for testing purposes only.
  # @default `DD_TELEMETRY_METRICS_AGGREGATION_INTERVAL` environment variable, otherwise `10`.
  # @return [Float]
  # @!visibility private
  option :metrics_aggregation_interval_seconds do |o|
    o.type :float
    o.env Core::Telemetry::Ext::ENV_METRICS_AGGREGATION_INTERVAL
    o.default 10.0
  end

  # The install id of the application.
  #
  # This method is used internally, by library injection.
  #
  # @default `DD_INSTRUMENTATION_INSTALL_ID` environment variable, otherwise `nil`.
  # @return [String,nil]
  # @!visibility private
  option :install_id do |o|
    o.type :string, nilable: true
    o.env Core::Telemetry::Ext::ENV_INSTALL_ID
  end

  # The install type of the application.
  #
  # This method is used internally, by library injection.
  #
  # @default `DD_INSTRUMENTATION_INSTALL_TYPE` environment variable, otherwise `nil`.
  # @return [String,nil]
  # @!visibility private
  option :install_type do |o|
    o.type :string, nilable: true
    o.env Core::Telemetry::Ext::ENV_INSTALL_TYPE
  end

  # The install time of the application.
  #
  # This method is used internally, by library injection.
  #
  # @default `DD_INSTRUMENTATION_INSTALL_TIME` environment variable, otherwise `nil`.
  # @return [String,nil]
  # @!visibility private
  option :install_time do |o|
    o.type :string, nilable: true
    o.env Core::Telemetry::Ext::ENV_INSTALL_TIME
  end

  # Telemetry shutdown timeout in seconds
  #
  # @!visibility private
  option :shutdown_timeout_seconds do |o|
    o.type :float
    o.default 1.0
  end

  # Enable log collection for telemetry. Log collection only works when telemetry is enabled and
  # logs are enabled.
  # @default `DD_TELEMETRY_LOG_COLLECTION_ENABLED` environment variable, otherwise `true`.
  # @return [Boolean]
  option :log_collection_enabled do |o|
    o.type :bool
    o.env Core::Telemetry::Ext::ENV_LOG_COLLECTION
    o.default true
  end
end