ddtrace 1.0.0 → 1.9.0

data/lib/datadog/core/configuration/components.rb

@@ -1,23 +1,23 @@
 # typed: false
 
-require 'datadog/core/configuration/agent_settings_resolver'
-require 'datadog/core/diagnostics/environment_logger'
-require 'datadog/core/diagnostics/health'
-require 'datadog/core/logger'
-require 'datadog/core/runtime/metrics'
-require 'datadog/core/workers/runtime_metrics'
-
-require 'datadog/tracing/tracer'
-require 'datadog/tracing/flush'
-require 'datadog/tracing/sync_writer'
-
-require 'datadog/profiling'
+require_relative 'agent_settings_resolver'
+require_relative '../diagnostics/environment_logger'
+require_relative '../diagnostics/health'
+require_relative '../logger'
+require_relative '../runtime/metrics'
+require_relative '../telemetry/client'
+require_relative '../workers/runtime_metrics'
+
+require_relative '../../tracing/tracer'
+require_relative '../../tracing/flush'
+require_relative '../../tracing/sync_writer'
+require_relative '../../tracing/sampling/span/rule_parser'
+require_relative '../../tracing/sampling/span/sampler'
 
 module Datadog
   module Core
     module Configuration
       # Global components for the trace library.
-      # rubocop:disable Metrics/ClassLength
       class Components
         class << self
           def build_health_metrics(settings)
@@ -53,6 +53,10 @@ module Datadog
             Core::Workers::RuntimeMetrics.new(options)
           end
 
+          def build_telemetry(settings)
+            Telemetry::Client.new(enabled: settings.telemetry.enabled)
+          end
+
           def build_tracer(settings, agent_settings)
             # If a custom tracer has been provided, use it instead.
             # Ignore all other options (they should already be configured.)
@@ -77,6 +81,7 @@ module Datadog
               enabled: settings.tracing.enabled,
               trace_flush: trace_flush,
               sampler: sampler,
+              span_sampler: build_span_sampler(settings),
               writer: writer,
               tags: build_tracer_tags(settings),
             )
@@ -176,12 +181,37 @@ module Datadog
 
               next unless response && !response.internal_error? && response.service_rates
 
-              sampler.update(response.service_rates)
+              sampler.update(response.service_rates, decision: Tracing::Sampling::Ext::Decision::AGENT_RATE)
             end
           end
 
+          def build_span_sampler(settings)
+            rules = Tracing::Sampling::Span::RuleParser.parse_json(settings.tracing.sampling.span_rules)
+            Tracing::Sampling::Span::Sampler.new(rules || [])
+          end
+
           def build_profiler(settings, agent_settings, tracer)
-            return unless Profiling.supported? && settings.profiling.enabled
+            return unless settings.profiling.enabled
+
+            # Workaround for weird dependency direction: the Core::Configuration::Components class currently has a
+            # dependency on individual products, in this case the Profiler.
+            # (Note "currently": in the future we want to change this so core classes don't depend on specific products)
+            #
+            # If the current file included a `require 'datadog/profiler'` at its beginning, we would generate circular
+            # requires when used from profiling:
+            #
+            # datadog/profiling
+            #     └─requires─> datadog/core
+            #                      └─requires─> datadog/core/configuration/components
+            #                                       └─requires─> datadog/profiling       # Loop!
+            #
+            # ...thus in #1998 we removed such a require.
+            #
+            # On the other hand, if datadog/core is loaded by a different product and no general `require 'ddtrace'` is
+            # done, then profiling may not be loaded, and thus to avoid this issue we do a require here (which is a
+            # no-op if profiling is already loaded).
+            require_relative '../../profiling'
+            return unless Profiling.supported?
 
             unless defined?(Profiling::Tasks::Setup)
               # In #1545 a user reported a NameError due to this constant being uninitialized
@@ -217,24 +247,31 @@ module Datadog
 
             # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
 
-            trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
-              tracer: tracer,
-              endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
-            )
+            if settings.profiling.advanced.force_enable_new_profiler
+              print_new_profiler_warnings
+
+              recorder = Datadog::Profiling::StackRecorder.new
+              collector = Datadog::Profiling::Collectors::CpuAndWallTimeWorker.new(
+                recorder: recorder,
+                max_frames: settings.profiling.advanced.max_frames,
+                tracer: tracer,
+                gc_profiling_enabled: should_enable_gc_profiling?(settings)
+              )
+            else
+              trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
+                tracer: tracer,
+                endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
+              )
 
-            # TODO: It's a bit weird to treat this collector differently from others. See the TODO on the
-            # Datadog::Profiling::Recorder class for a discussion of this choice.
-            if settings.profiling.advanced.code_provenance_enabled
-              code_provenance_collector =
-                Profiling::Collectors::CodeProvenance.new
+              recorder = build_profiler_old_recorder(settings)
+              collector = build_profiler_oldstack_collector(settings, recorder, trace_identifiers_helper)
             end
 
-            recorder = build_profiler_recorder(settings, code_provenance_collector)
-            collectors = build_profiler_collectors(settings, recorder, trace_identifiers_helper)
-            exporters = build_profiler_exporters(settings, agent_settings)
-            scheduler = build_profiler_scheduler(settings, recorder, exporters)
+            exporter = build_profiler_exporter(settings, recorder)
+            transport = build_profiler_transport(settings, agent_settings)
+            scheduler = Profiling::Scheduler.new(exporter: exporter, transport: transport)
 
-            Profiling::Profiler.new(collectors, scheduler)
+            Profiling::Profiler.new([collector], scheduler)
           end
 
           private
@@ -266,42 +303,68 @@ module Datadog
             Tracing::SyncWriter.new(agent_settings: agent_settings, **writer_options)
           end
 
-          def build_profiler_recorder(settings, code_provenance_collector)
-            event_classes = [Profiling::Events::StackSample]
+          def build_profiler_old_recorder(settings)
+            Profiling::OldRecorder.new([Profiling::Events::StackSample], settings.profiling.advanced.max_events)
+          end
 
-            Profiling::Recorder.new(
-              event_classes,
-              settings.profiling.advanced.max_events,
-              code_provenance_collector: code_provenance_collector
-            )
+          def build_profiler_exporter(settings, recorder)
+            code_provenance_collector =
+              (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
+
+            Profiling::Exporter.new(pprof_recorder: recorder, code_provenance_collector: code_provenance_collector)
           end
 
-          def build_profiler_collectors(settings, recorder, trace_identifiers_helper)
-            [
-              Profiling::Collectors::Stack.new(
-                recorder,
-                trace_identifiers_helper: trace_identifiers_helper,
-                max_frames: settings.profiling.advanced.max_frames
-                # TODO: Provide proc that identifies Datadog worker threads?
-                # ignore_thread: settings.profiling.ignore_profiler
-              )
-            ]
+          def build_profiler_oldstack_collector(settings, old_recorder, trace_identifiers_helper)
+            Profiling::Collectors::OldStack.new(
+              old_recorder,
+              trace_identifiers_helper: trace_identifiers_helper,
+              max_frames: settings.profiling.advanced.max_frames
+            )
           end
 
-          def build_profiler_exporters(settings, agent_settings)
-            transport =
-              settings.profiling.exporter.transport || Profiling::Transport::HTTP.default(
+          def build_profiler_transport(settings, agent_settings)
+            settings.profiling.exporter.transport ||
+              Profiling::HttpTransport.new(
                 agent_settings: agent_settings,
                 site: settings.site,
                 api_key: settings.api_key,
-                profiling_upload_timeout_seconds: settings.profiling.upload.timeout_seconds
+                upload_timeout_seconds: settings.profiling.upload.timeout_seconds,
               )
+          end
+
+          def should_enable_gc_profiling?(settings)
+            # See comments on the setting definition for more context on why it exists.
+            if settings.profiling.advanced.force_enable_gc_profiling
+              if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3')
+                Datadog.logger.debug(
+                  'Profiling time/resources spent in Garbage Collection force enabled. Do not use Ractors in combination ' \
+                  'with this option as profiles will be incomplete.'
+                )
+              end
 
-            [Profiling::Exporter.new(transport)]
+              true
+            else
+              false
+            end
           end
 
-          def build_profiler_scheduler(settings, recorder, exporters)
-            Profiling::Scheduler.new(recorder, exporters)
+          def print_new_profiler_warnings
+            if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6')
+              Datadog.logger.warn(
+                'New Ruby profiler has been force-enabled. This feature is in beta state. We do not yet recommend ' \
+                'running it in production environments. Please report any issues ' \
+                'you run into to Datadog support or via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+              )
+            else
+              # For more details on the issue, see the "BIG Issue" comment on `gvl_owner` function in
+              # `private_vm_api_access.c`.
+              Datadog.logger.warn(
+                'New Ruby profiler has been force-enabled on a legacy Ruby version (< 2.6). This is not recommended in ' \
+                'production environments, as due to limitations in Ruby APIs, we suspect it may lead to crashes in very ' \
+                'rare situations. Please report any issues you run into to Datadog support or ' \
+                'via <https://github.com/datadog/dd-trace-rb/issues/new>!'
+              )
+            end
           end
         end
 
@@ -310,6 +373,7 @@ module Datadog
           :logger,
           :profiler,
           :runtime_metrics,
+          :telemetry,
           :tracer
 
         def initialize(settings)
@@ -329,6 +393,9 @@ module Datadog
 
           # Health metrics
           @health_metrics = self.class.build_health_metrics(settings)
+
+          # Telemetry
+          @telemetry = self.class.build_telemetry(settings)
         end
 
         # Starts up components
@@ -385,9 +452,11 @@ module Datadog
 
           unused_statsd = (old_statsd - (old_statsd & new_statsd))
           unused_statsd.each(&:close)
+
+          telemetry.stop!
+          telemetry.emit_closing! unless replacement
         end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/datadog/core/configuration/ext.rb

@@ -0,0 +1,26 @@
+# typed: true
+
+module Datadog
+  module Core
+    module Configuration
+      # Constants for configuration settings
+      # e.g. Env vars, default values, enums, etc...
+      module Ext
+        # @public_api
+        module Diagnostics
+          ENV_DEBUG_ENABLED = 'DD_TRACE_DEBUG'.freeze
+          ENV_HEALTH_METRICS_ENABLED = 'DD_HEALTH_METRICS_ENABLED'.freeze
+          ENV_STARTUP_LOGS_ENABLED = 'DD_TRACE_STARTUP_LOGS'.freeze
+        end
+
+        module Metrics
+          ENV_DEFAULT_PORT = 'DD_METRIC_AGENT_PORT'.freeze
+        end
+
+        module Transport
+          ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/configuration/option_definition.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/configuration/option'
+require_relative 'option'
 
 module Datadog
   module Core
@@ -17,7 +17,8 @@ module Datadog
           :name,
           :on_set,
           :resetter,
-          :setter
+          :setter,
+          :type
 
         def initialize(name, meta = {}, &block)
           @default = meta[:default]
@@ -28,6 +29,7 @@ module Datadog
           @on_set = meta[:on_set]
           @resetter = meta[:resetter]
           @setter = meta[:setter] || block || IDENTITY
+          @type = meta[:type]
         end
 
         # Creates a new Option, bound to the context provided.
@@ -51,6 +53,7 @@ module Datadog
             @on_set = nil
             @resetter = nil
             @setter = OptionDefinition::IDENTITY
+            @type = nil
 
             # If options were supplied, apply them.
             apply_options!(options)
@@ -91,6 +94,10 @@ module Datadog
             @setter = block
           end
 
+          def type(value = nil)
+            @type = value
+          end
+
           # For applying options for OptionDefinition
           def apply_options!(options = {})
             return if options.nil? || options.empty?
@@ -102,6 +109,7 @@ module Datadog
             on_set(&options[:on_set]) if options.key?(:on_set)
             resetter(&options[:resetter]) if options.key?(:resetter)
             setter(&options[:setter]) if options.key?(:setter)
+            type(&options[:type]) if options.key?(:type)
           end
 
           def to_definition
@@ -116,7 +124,8 @@ module Datadog
               lazy: @lazy,
               on_set: @on_set,
               resetter: @resetter,
-              setter: @setter
+              setter: @setter,
+              type: @type
             }
           end
         end

data/lib/datadog/core/configuration/option_definition_set.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/configuration/dependency_resolver'
+require_relative 'dependency_resolver'
 
 module Datadog
   module Core

data/lib/datadog/core/configuration/options.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/core/configuration/option_set'
-require 'datadog/core/configuration/option_definition'
-require 'datadog/core/configuration/option_definition_set'
+require_relative 'option_set'
+require_relative 'option_definition'
+require_relative 'option_definition_set'
 
 module Datadog
   module Core