Class: Datadog::Core::Configuration::Components

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

Overview

Global components for the trace library.

Constant Summary collapse

AT_FORK_ONLY_ONCE =

Class-level constant to ensure fork patch is applied only once

Utils::OnlyOnce.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(settings) ⇒ Components 



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/datadog/core/configuration/components.rb', line 123

def initialize(settings)
  @settings = settings
  @logger = self.class.build_logger(settings)
  @environment_logger_extra = {}
  StableConfig.log_result(@logger)
  Deprecations.log_deprecations_from_all_sources(@logger)

  # Register fork handling once globally
  self.class::AT_FORK_ONLY_ONCE.run do
    Utils::AtForkMonkeyPatch.apply!

    # Register callback that calls Components.after_fork
    Utils::AtForkMonkeyPatch.at_fork(:child) do
      # Access via global to avoid capturing 'self'
      Datadog.send(:components, allow_initialization: false)&.after_fork
    end
  end

  # This agent_settings is intended for use within Core. If you require
  # agent_settings within a product outside of core you should extend
  # the Core resolver from within your product/component's namespace.
  @agent_settings = AgentSettingsResolver.call(settings, logger: @logger)

  # Exposes agent capability information for detection by any components
  @agent_info = Core::Environment::AgentInfo.new(agent_settings, logger: @logger)

  @telemetry = self.class.build_telemetry(settings, agent_settings, @logger)

  @remote = Remote::Component.build(settings, agent_settings, logger: @logger, telemetry: telemetry)
  @tracer = Datadog::Tracing::Component.build_tracer(settings, agent_settings, logger: @logger)
  @crashtracker = self.class.build_crashtracker(settings, agent_settings, logger: @logger)

  @profiler, profiler_logger_extra = Datadog::Profiling::Component.build_profiler_component(
    settings: settings,
    agent_settings: agent_settings,
    optional_tracer: @tracer,
    logger: @logger,
  )
  @environment_logger_extra.merge!(profiler_logger_extra) if profiler_logger_extra

  @runtime_metrics = self.class.build_runtime_metrics_worker(settings, @logger, telemetry)
  @health_metrics = self.class.build_health_metrics(settings, @logger, telemetry)
  @appsec = Datadog::AppSec::Component.build_appsec_component(settings, telemetry: telemetry)
  @ai_guard = Datadog::AIGuard::Component.build(settings, logger: @logger, telemetry: telemetry)
  @open_feature = OpenFeature::Component.build(settings, agent_settings, logger: @logger, telemetry: telemetry)
  @dynamic_instrumentation = Datadog::DI::Component.build(settings, agent_settings, @logger, telemetry: telemetry)
  @error_tracking = Datadog::ErrorTracking::Component.build(settings, @tracer, @logger)
  @data_streams = self.class.build_data_streams(settings, agent_settings, @logger, @agent_info)
  @environment_logger_extra[:dynamic_instrumentation_enabled] = !!@dynamic_instrumentation

  # Configure non-privileged components.
  Datadog::Tracing::Contrib::Component.configure(settings)
end

Instance Attribute Details

#agent_info ⇒ Object (readonly)

Returns the value of attribute agent_info.



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

def agent_info
  @agent_info
end

#agent_settings ⇒ Object (readonly)

Returns the value of attribute agent_settings.



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

def agent_settings
  @agent_settings
end

#ai_guard ⇒ Object (readonly)

Returns the value of attribute ai_guard.



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

def ai_guard
  @ai_guard
end

#appsec ⇒ Object (readonly)

Returns the value of attribute appsec.



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

def appsec
  @appsec
end

#crashtracker ⇒ Object (readonly)

Returns the value of attribute crashtracker.



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

def crashtracker
  @crashtracker
end

#data_streams ⇒ Object (readonly)

Returns the value of attribute data_streams.



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

def data_streams
  @data_streams
end

#dynamic_instrumentation ⇒ Object (readonly)

Returns the value of attribute dynamic_instrumentation.



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

def dynamic_instrumentation
  @dynamic_instrumentation
end

#error_tracking ⇒ Object (readonly)

Returns the value of attribute error_tracking.



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

def error_tracking
  @error_tracking
end

#health_metrics ⇒ Object (readonly)

Returns the value of attribute health_metrics.



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

def health_metrics
  @health_metrics
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

#open_feature ⇒ Object (readonly)

Returns the value of attribute open_feature.



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

def open_feature
  @open_feature
end

#profiler ⇒ Object (readonly)

Returns the value of attribute profiler.



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

def profiler
  @profiler
end

#remote ⇒ Object (readonly)

Returns the value of attribute remote.



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

def remote
  @remote
end

#runtime_metrics ⇒ Object (readonly)

Returns the value of attribute runtime_metrics.



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

def runtime_metrics
  @runtime_metrics
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



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

def settings
  @settings
end

#telemetry ⇒ Object (readonly)

Returns the value of attribute telemetry.



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

def telemetry
  @telemetry
end

#tracer ⇒ Object (readonly)

Returns the value of attribute tracer.



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

def tracer
  @tracer
end

Class Method Details

.build_crashtracker(settings, agent_settings, logger:) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/datadog/core/configuration/components.rb', line 77

def build_crashtracker(settings, agent_settings, logger:)
  return unless settings.crashtracking.enabled

  if (libdatadog_api_failure = Datadog::Core::LIBDATADOG_API_FAILURE)
    logger.debug("Cannot enable crashtracking: #{libdatadog_api_failure}")
    return
  end

  Datadog::Core::Crashtracking::Component.build(settings, agent_settings, logger: logger)
end

.build_data_streams(settings, agent_settings, logger, agent_info) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/datadog/core/configuration/components.rb', line 88

def build_data_streams(settings, agent_settings, logger, agent_info)
  return unless settings.data_streams.enabled

  Datadog::DataStreams::Processor.new(
    interval: settings.data_streams.interval,
    logger: logger,
    settings: settings,
    agent_settings: agent_settings,
    agent_info: agent_info
  )
rescue => e
  logger.warn("Failed to initialize Data Streams Monitoring: #{e.class}: #{e}")
  nil
end

.build_health_metrics(settings, logger, telemetry) ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/datadog/core/configuration/components.rb', line 37

def build_health_metrics(settings, logger, telemetry)
  settings = settings.health_metrics
  options = {enabled: settings.enabled}
  options[:statsd] = settings.statsd unless settings.statsd.nil?

  Core::Diagnostics::Health::Metrics.new(telemetry: telemetry, logger: logger, **options)
end

.build_logger(settings) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/datadog/core/configuration/components.rb', line 45

def build_logger(settings)
  logger = settings.logger.instance || Core::Logger.new($stderr)
  logger.level = settings.diagnostics.debug ? ::Logger::DEBUG : settings.logger.level

  logger
end

.build_runtime_metrics(settings, logger, telemetry) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/datadog/core/configuration/components.rb', line 52

def build_runtime_metrics(settings, logger, telemetry)
  options = {enabled: settings.runtime_metrics.enabled}
  options[:statsd] = settings.runtime_metrics.statsd unless settings.runtime_metrics.statsd.nil?
  options[:services] = [settings.service] unless settings.service.nil?
  options[:experimental_runtime_id_enabled] = settings.runtime_metrics.experimental_runtime_id_enabled
  options[:experimental_propagate_process_tags_enabled] = settings.experimental_propagate_process_tags_enabled

  Core::Runtime::Metrics.new(logger: logger, telemetry: telemetry, **options)
end

.build_runtime_metrics_worker(settings, logger, telemetry) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/datadog/core/configuration/components.rb', line 62

def build_runtime_metrics_worker(settings, logger, telemetry)
  # NOTE: Should we just ignore building the worker if its not enabled?
  options = settings.runtime_metrics.opts.merge(
    enabled: settings.runtime_metrics.enabled,
    metrics: build_runtime_metrics(settings, logger, telemetry),
    logger: logger,
  )

  Core::Workers::RuntimeMetrics.new(telemetry: telemetry, **options)
end

.build_telemetry(settings, agent_settings, logger) ⇒ Object 



73
74
75
 
# File 'lib/datadog/core/configuration/components.rb', line 73

def build_telemetry(settings, agent_settings, logger)
  Telemetry::Component.build(settings, agent_settings, logger)
end

Instance Method Details

#after_fork ⇒ Object

Called when a fork is detected



178
179
180
181
182
183
 
# File 'lib/datadog/core/configuration/components.rb', line 178

def after_fork
  telemetry.after_fork
  remote&.after_fork
  crashtracker&.update_on_fork
  ProcessDiscovery.after_fork
end

#reconfigure_sampler(settings = Datadog.configuration) ⇒ Object

Hot-swaps with a new sampler. This operation acquires the Components lock to ensure there is no concurrent modification of the sampler.



188
189
190
191
 
# File 'lib/datadog/core/configuration/components.rb', line 188

def reconfigure_sampler(settings = Datadog.configuration)
  sampler = Datadog::Tracing::Component.build_sampler(settings)
  Datadog.send(:safely_synchronize) { tracer.sampler.sampler = sampler }
end

#shutdown!(replacement = nil) ⇒ Object

Shuts down all the components in use. If it has another instance to compare to, it will compare and avoid tearing down parts still in use.



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
 
# File 'lib/datadog/core/configuration/components.rb', line 228

def shutdown!(replacement = nil)
  # Shutdown remote configuration
  remote&.shutdown!

  # Shutdown DI after remote, since remote config triggers DI operations.
  dynamic_instrumentation&.shutdown!

  # Shutdown OpenFeature component
  open_feature&.shutdown!

  # Decommission AppSec
  appsec&.shutdown!

  # Shutdown AIGuard component
  ai_guard&.shutdown!

  # Shutdown the old tracer, unless it's still being used.
  # (e.g. a custom tracer instance passed in.)
  tracer.shutdown! unless replacement && tracer.equal?(replacement.tracer)

  # Shutdown old profiler
  profiler&.shutdown!

  # Shutdown workers
  runtime_metrics.stop(true, close_metrics: false)

  # Shutdown Data Streams Monitoring processor
  data_streams&.stop(true)

  # Shutdown the old metrics, unless they are still being used.
  # (e.g. custom Statsd instances.)
  #
  # TODO: This violates the encapsulation created by Runtime::Metrics and
  # Health::Metrics, by directly manipulating `statsd` and changing
  # it's lifecycle management.
  # If we need to directly have ownership of `statsd` lifecycle, we should
  # have direct ownership of it.
  old_statsd = [
    runtime_metrics.metrics.statsd,
    health_metrics.statsd
  ].compact.uniq

  new_statsd = if replacement
    [
      replacement.runtime_metrics.metrics.statsd,
      replacement.health_metrics.statsd
    ].compact.uniq
  else
    []
  end

  unused_statsd = (old_statsd - (old_statsd & new_statsd))
  unused_statsd.each(&:close)

  # enqueue closing event before stopping telemetry so it will be sent out on shutdown
  telemetry.emit_closing! unless replacement&.telemetry&.enabled
  telemetry.shutdown!

  Core::ProcessDiscovery.shutdown!
end

#startup!(settings, old_state: nil) ⇒ Object

Starts up components



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/datadog/core/configuration/components.rb', line 194

def startup!(settings, old_state: nil)
  telemetry.start(old_state&.telemetry_enabled?, components: self)

  if settings.profiling.enabled
    if profiler
      profiler.start
    else
      # Display a warning for users who expected profiling to be enabled
      unsupported_reason = Profiling.unsupported_reason
      logger.warn("Profiling was requested but is not supported, profiling disabled: #{unsupported_reason}")
    end
  end

  if settings.remote.enabled && old_state&.remote_started?
    # The library was reconfigured and previously it already started
    # the remote component (i.e., it received at least one request
    # through the installed Rack middleware which started the remote).
    # If the new configuration also has remote enabled, start the
    # new remote right away.
    # remote should always be not nil here but steep doesn't know this.
    remote&.start
  end

  # This should stay here, not in initialize. During reconfiguration, the order of the calls is:
  # initialize new components, shutdown old components, startup new components.
  # Because this is a singleton, if we call it in initialize, it will be shutdown right away.
  Core::ProcessDiscovery.publish(settings)

  Core::Diagnostics::EnvironmentLogger.collect_and_log!(@environment_logger_extra)
end

#state ⇒ Object

Returns the current state of various components.



290
291
292
293
294
295
 
# File 'lib/datadog/core/configuration/components.rb', line 290

def state
  ComponentsState.new(
    telemetry_enabled: telemetry.enabled,
    remote_started: remote&.started?,
  )
end