ddtrace 1.2.0 → 1.4.0

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

@@ -1,15 +1,16 @@
 # 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_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'
 
 module Datadog
   module Core
@@ -51,6 +52,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.)
@@ -198,7 +203,7 @@ module Datadog
             # 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 'datadog/profiling'
+            require_relative '../../profiling'
             return unless Profiling.supported?
 
             unless defined?(Profiling::Tasks::Setup)
@@ -235,18 +240,27 @@ 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
+              recorder = Datadog::Profiling::StackRecorder.new
+              collector = Datadog::Profiling::Collectors::CpuAndWallTimeWorker.new(
+                recorder: recorder,
+                max_frames: settings.profiling.advanced.max_frames
+              )
+            else
+              trace_identifiers_helper = Profiling::TraceIdentifiers::Helper.new(
+                tracer: tracer,
+                endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
+              )
+
+              recorder = build_profiler_old_recorder(settings)
+              collector = build_profiler_oldstack_collector(settings, recorder, trace_identifiers_helper)
+            end
 
-            old_recorder = build_profiler_old_recorder(settings)
-            exporter = build_profiler_exporter(settings, old_recorder)
-            collectors = build_profiler_collectors(settings, old_recorder, trace_identifiers_helper)
+            exporter = build_profiler_exporter(settings, recorder)
             transport = build_profiler_transport(settings, agent_settings)
-            scheduler = build_profiler_scheduler(settings, exporter, transport)
+            scheduler = Profiling::Scheduler.new(exporter: exporter, transport: transport)
 
-            Profiling::Profiler.new(collectors, scheduler)
+            Profiling::Profiler.new([collector], scheduler)
           end
 
           private
@@ -279,42 +293,28 @@ module Datadog
           end
 
           def build_profiler_old_recorder(settings)
-            event_classes = [Profiling::Events::StackSample]
-
-            Profiling::OldRecorder.new(
-              event_classes,
-              settings.profiling.advanced.max_events,
-            )
+            Profiling::OldRecorder.new([Profiling::Events::StackSample], settings.profiling.advanced.max_events)
           end
 
-          def build_profiler_exporter(settings, old_recorder)
+          def build_profiler_exporter(settings, recorder)
             code_provenance_collector =
               (Profiling::Collectors::CodeProvenance.new if settings.profiling.advanced.code_provenance_enabled)
 
-            Profiling::Exporter.new(
-              # NOTE: Using the OldRecorder as a pprof_recorder is temporary and will be removed once libpprof is
-              # being used for aggregation
-              pprof_recorder: old_recorder,
-              code_provenance_collector: code_provenance_collector,
-            )
+            Profiling::Exporter.new(pprof_recorder: recorder, code_provenance_collector: code_provenance_collector)
           end
 
-          def build_profiler_collectors(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
-                # 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_transport(settings, agent_settings)
             settings.profiling.exporter.transport ||
               if settings.profiling.advanced.legacy_transport_enabled
-                require 'datadog/profiling/transport/http'
+                require_relative '../../profiling/transport/http'
 
                 Datadog.logger.warn('Using legacy profiling transport. Do not use unless instructed to by support.')
 
@@ -332,10 +332,6 @@ module Datadog
                 upload_timeout_seconds: settings.profiling.upload.timeout_seconds,
               )
           end
-
-          def build_profiler_scheduler(_settings, exporter, transport)
-            Profiling::Scheduler.new(exporter: exporter, transport: transport)
-          end
         end
 
         attr_reader \
@@ -343,6 +339,7 @@ module Datadog
           :logger,
           :profiler,
           :runtime_metrics,
+          :telemetry,
           :tracer
 
         def initialize(settings)
@@ -362,6 +359,9 @@ module Datadog
 
           # Health metrics
           @health_metrics = self.class.build_health_metrics(settings)
+
+          # Telemetry
+          @telemetry = self.class.build_telemetry(settings)
         end
 
         # Starts up components
@@ -418,6 +418,9 @@ 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

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

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

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

@@ -2,11 +2,12 @@
 
 require 'logger'
 
-require 'datadog/core/configuration/base'
-require 'datadog/core/environment/ext'
-require 'datadog/core/runtime/ext'
-require 'datadog/profiling/ext'
-require 'datadog/tracing/configuration/ext'
+require_relative 'base'
+require_relative '../environment/ext'
+require_relative '../runtime/ext'
+require_relative '../telemetry/ext'
+require_relative '../../profiling/ext'
+require_relative '../../tracing/configuration/ext'
 
 module Datadog
   module Core
@@ -240,6 +241,16 @@ module Datadog
               o.default { env_to_bool('DD_PROFILING_LEGACY_TRANSPORT_ENABLED', false) }
               o.lazy
             end
+
+            # Forces enabling the new profiler. We do not yet recommend turning on this option.
+            #
+            # Note that setting this to "false" (or not setting it) will not prevent the new profiler from
+            # being automatically used in the future.
+            # This option will be deprecated for removal once the new profiler gets enabled by default for all customers.
+            option :force_enable_new_profiler do |o|
+              o.default { env_to_bool('DD_PROFILING_FORCE_ENABLE_NEW', false) }
+              o.lazy
+            end
           end
 
           # @public_api
@@ -419,7 +430,8 @@ module Datadog
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG,
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3,
                     Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER
-                  ], comma_separated_only: true
+                  ],
+                  comma_separated_only: true
                 )
               end
 
@@ -437,7 +449,8 @@ module Datadog
               o.default do
                 env_to_list(
                   Tracing::Configuration::Ext::Distributed::ENV_PROPAGATION_STYLE_INJECT,
-                  [Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG], comma_separated_only: true # Only inject Datadog headers by default
+                  [Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG],
+                  comma_separated_only: true # Only inject Datadog headers by default
                 )
               end
 
@@ -616,6 +629,20 @@ module Datadog
           o.default { ENV.fetch(Core::Environment::Ext::ENV_VERSION, nil) }
           o.lazy
         end
+
+        # Client-side telemetry configuration
+        # @public_api
+        settings :telemetry do
+          # Enable telemetry collection. This allows telemetry events to be emitted to the telemetry API.
+          #
+          # @default `DD_INSTRUMENTATION_TELEMETRY_ENABLED` environment variable, otherwise `false`. In a future release,
+          #   this value will be changed to `true` by default as documented [here](https://docs.datadoghq.com/tracing/configure_data_security/#telemetry-collection).
+          # @return [Boolean]
+          option :enabled do |o|
+            o.default { env_to_bool(Core::Telemetry::Ext::ENV_ENABLED, false) }
+            o.lazy
+          end
+        end
       end
       # rubocop:enable Metrics/BlockLength
       # rubocop:enable Metrics/ClassLength

data/lib/datadog/core/configuration.rb

@@ -1,9 +1,10 @@
 # typed: true
 
-require 'datadog/core/configuration/components'
-require 'datadog/core/configuration/settings'
-require 'datadog/core/logger'
-require 'datadog/core/pin'
+require_relative 'configuration/components'
+require_relative 'configuration/settings'
+require_relative 'telemetry/emitter'
+require_relative 'logger'
+require_relative 'pin'
 
 module Datadog
   module Core
@@ -89,7 +90,9 @@ module Datadog
             if components?
               replace_components!(configuration, @components)
             else
-              build_components(configuration)
+              components = build_components(configuration)
+              components.telemetry.started!
+              components
             end
           )
         end

data/lib/datadog/core/diagnostics/environment_logger.rb

@@ -151,7 +151,7 @@ module Datadog
         def sampling_rules
           sampler = Datadog.configuration.tracing.sampler
           return nil unless sampler.is_a?(Tracing::Sampling::PrioritySampler) &&
-                            sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
+            sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
 
           sampler.priority_sampler.rules.map do |rule|
             next unless rule.is_a?(Tracing::Sampling::SimpleRule)

data/lib/datadog/core/diagnostics/health.rb

@@ -1,7 +1,7 @@
 # typed: strict
 
-require 'datadog/core/diagnostics/ext'
-require 'datadog/core/metrics/client'
+require_relative 'ext'
+require_relative '../metrics/client'
 
 module Datadog
   module Core

data/lib/datadog/core/environment/cgroup.rb

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

data/lib/datadog/core/environment/container.rb

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

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

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'ddtrace/version'
+require_relative '../../../ddtrace/version'
 
 module Datadog
   module Core

data/lib/datadog/core/environment/identity.rb

@@ -2,8 +2,8 @@
 
 require 'securerandom'
 
-require 'datadog/core/environment/ext'
-require 'datadog/core/utils/forking'
+require_relative 'ext'
+require_relative '../utils/forking'
 
 module Datadog
   module Core

data/lib/datadog/core/environment/platform.rb

@@ -2,7 +2,7 @@
 
 require 'etc'
 
-require 'datadog/core/environment/identity'
+require_relative 'identity'
 
 module Datadog
   module Core

data/lib/datadog/core/environment/socket.rb

@@ -1,7 +1,7 @@
 # typed: false
 
 require 'socket'
-require 'datadog/core/utils/forking'
+require_relative '../utils/forking'
 
 module Datadog
   module Core

data/lib/datadog/core/error.rb

@@ -2,7 +2,7 @@
 
 # typed: false
 
-require 'datadog/core/utils'
+require_relative 'utils'
 
 module Datadog
   module Core

data/lib/datadog/core/extensions.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/configuration'
+require_relative 'configuration'
 
 # Global namespace that includes all Datadog functionality.
 # @public_api

data/lib/datadog/core/metrics/client.rb

@@ -1,13 +1,13 @@
 # typed: false
 
-require 'datadog/core/utils/time'
-require 'datadog/core/utils/only_once'
-
-require 'datadog/core/metrics/ext'
-require 'datadog/core/metrics/options'
-require 'datadog/core/metrics/helpers'
-require 'datadog/core/metrics/logging'
-require 'datadog/core/metrics/metric'
+require_relative '../utils/time'
+require_relative '../utils/only_once'
+
+require_relative 'ext'
+require_relative 'options'
+require_relative 'helpers'
+require_relative 'logging'
+require_relative 'metric'
 
 module Datadog
   module Core

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

@@ -1,8 +1,8 @@
 # typed: true
 
-require 'datadog/core/metrics/ext'
-require 'datadog/core/environment/ext'
-require 'datadog/core/environment/identity'
+require_relative 'ext'
+require_relative '../environment/ext'
+require_relative '../environment/identity'
 
 module Datadog
   module Core

data/lib/datadog/core/runtime/metrics.rb

@@ -1,12 +1,12 @@
 # typed: true
 
-require 'datadog/core/runtime/ext'
+require_relative 'ext'
 
-require 'datadog/core/metrics/client'
-require 'datadog/core/environment/class_count'
-require 'datadog/core/environment/gc'
-require 'datadog/core/environment/thread_count'
-require 'datadog/core/environment/vm_cache'
+require_relative '../metrics/client'
+require_relative '../environment/class_count'
+require_relative '../environment/gc'
+require_relative '../environment/thread_count'
+require_relative '../environment/vm_cache'
 
 module Datadog
   module Core

data/lib/datadog/core/telemetry/client.rb

@@ -0,0 +1,79 @@
+# typed: true
+
+require_relative 'emitter'
+require_relative 'heartbeat'
+require_relative '../utils/forking'
+
+module Datadog
+  module Core
+    module Telemetry
+      # Telemetry entrypoint, coordinates sending telemetry events at various points in app lifecyle
+      class Client
+        attr_reader \
+          :emitter,
+          :enabled,
+          :unsupported,
+          :worker
+
+        include Core::Utils::Forking
+
+        # @param enabled [Boolean] Determines whether telemetry events should be sent to the API
+        def initialize(enabled: true)
+          @enabled = enabled
+          @emitter = Emitter.new
+          @stopped = false
+          @unsupported = false
+          @worker = Telemetry::Heartbeat.new(enabled: @enabled) do
+            heartbeat!
+          end
+        end
+
+        def disable!
+          @enabled = false
+          @worker.enabled = false
+        end
+
+        def started!
+          return if !@enabled || forked?
+
+          res = @emitter.request(:'app-started')
+
+          if res.not_found? # Telemetry is only supported by agent versions 7.34 and up
+            Datadog.logger.debug('Agent does not support telemetry; disabling future telemetry events.')
+            disable!
+            @unsupported = true # Prevent telemetry from getting re-enabled
+          end
+
+          res
+        end
+
+        def emit_closing!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-closing')
+        end
+
+        def stop!
+          return if @stopped
+
+          @worker.stop(true, 0)
+          @stopped = true
+        end
+
+        def integrations_change!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-integrations-change')
+        end
+
+        private
+
+        def heartbeat!
+          return if !@enabled || forked?
+
+          @emitter.request(:'app-heartbeat')
+        end
+      end
+    end
+  end
+end