ddtrace 0.51.1 → 0.54.2

data/lib/ddtrace/configuration/agent_settings_resolver.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'uri'
 
 require 'ddtrace/ext/transport'
@@ -19,25 +20,49 @@ module Datadog
     class AgentSettingsResolver
       AgentSettings = \
         Struct.new(
+          :adapter,
           :ssl,
           :hostname,
           :port,
+          :uds_path,
           :timeout_seconds,
           :deprecated_for_removal_transport_configuration_proc,
           :deprecated_for_removal_transport_configuration_options
         ) do
           def initialize(
+            adapter:,
             ssl:,
             hostname:,
             port:,
+            uds_path:,
             timeout_seconds:,
             deprecated_for_removal_transport_configuration_proc:,
             deprecated_for_removal_transport_configuration_options:
           )
-            super(ssl, hostname, port, timeout_seconds, deprecated_for_removal_transport_configuration_proc, \
-              deprecated_for_removal_transport_configuration_options)
+            super(
+              adapter,
+              ssl,
+              hostname,
+              port,
+              uds_path,
+              timeout_seconds,
+              deprecated_for_removal_transport_configuration_proc,
+              deprecated_for_removal_transport_configuration_options,
+            )
             freeze
           end
+
+          # Returns a frozen copy of this struct
+          # with the provided +member_values+ modified.
+          def merge(**member_values)
+            new_struct = dup
+
+            member_values.each do |member, value|
+              new_struct[member] = value
+            end
+
+            new_struct.freeze
+          end
         end
 
       def self.call(settings, logger: Datadog.logger)
@@ -57,9 +82,11 @@ module Datadog
 
       def call
         AgentSettings.new(
+          adapter: adapter,
           ssl: ssl?,
           hostname: hostname,
           port: port,
+          uds_path: uds_path,
           timeout_seconds: timeout_seconds,
           # NOTE: When provided, the deprecated_for_removal_transport_configuration_proc can override all
           # values above (ssl, hostname, port, timeout), or even make them irrelevant (by using an unix socket or
@@ -71,65 +98,99 @@ module Datadog
         )
       end
 
-      def hostname
-        pick_from(
-          configurations_in_priority_order: [
-            DetectedConfiguration.new(
-              friendly_name: "'c.tracer.hostname'",
-              value: settings.tracer.hostname
-            ),
-            DetectedConfiguration.new(
-              friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL} environment variable",
-              value: parsed_url && parsed_url.hostname
-            ),
-            DetectedConfiguration.new(
-              friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST} environment variable",
-              value: ENV[Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST]
-            )
-          ],
-          or_use_default: Datadog::Ext::Transport::HTTP::DEFAULT_HOST
+      def adapter
+        # If no agent settings have been provided, we try to connect using a local unix socket.
+        # We only do so if the socket is present when `ddtrace` runs.
+        if should_use_uds_fallback?
+          Ext::Transport::UnixSocket::ADAPTER
+        else
+          Ext::Transport::HTTP::ADAPTER
+        end
+      end
+
+      def configured_hostname
+        return @configured_hostname if defined?(@configured_hostname)
+
+        @configured_hostname = pick_from(
+          DetectedConfiguration.new(
+            friendly_name: "'c.tracer.hostname'",
+            value: settings.tracer.hostname
+          ),
+          DetectedConfiguration.new(
+            friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL} environment variable",
+            value: parsed_url && parsed_url.hostname
+          ),
+          DetectedConfiguration.new(
+            friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST} environment variable",
+            value: ENV[Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST]
+          )
         )
       end
 
-      def port
-        port_from_env = ENV[Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT]
+      def configured_port
+        return @configured_port if defined?(@configured_port)
+
         parsed_port_from_env =
-          if port_from_env
-            begin
-              Integer(port_from_env)
-            rescue ArgumentError
-              log_warning(
-                "Invalid value for #{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT} environment variable " \
-                "('#{port_from_env}'). Ignoring this configuration."
-              )
-            end
-          end
+          try_parsing_as_integer(
+            friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT} environment variable",
+            value: ENV[Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT],
+          )
 
-        pick_from(
-          configurations_in_priority_order: [
-            DetectedConfiguration.new(
-              friendly_name: '"c.tracer.port"',
-              value: settings.tracer.port
-            ),
-            DetectedConfiguration.new(
-              friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL} environment variable",
-              value: parsed_url && parsed_url.port
-            ),
-            DetectedConfiguration.new(
-              friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT} environment variable",
-              value: parsed_port_from_env
-            )
-          ],
-          or_use_default: Datadog::Ext::Transport::HTTP::DEFAULT_PORT
+        parsed_settings_tracer_port =
+          try_parsing_as_integer(
+            friendly_name: '"c.tracer.port"',
+            value: settings.tracer.port,
+          )
+
+        @configured_port = pick_from(
+          DetectedConfiguration.new(
+            friendly_name: '"c.tracer.port"',
+            value: parsed_settings_tracer_port,
+          ),
+          DetectedConfiguration.new(
+            friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL} environment variable",
+            value: parsed_url && parsed_url.port,
+          ),
+          DetectedConfiguration.new(
+            friendly_name: "#{Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT} environment variable",
+            value: parsed_port_from_env,
+          )
         )
       end
 
+      def try_parsing_as_integer(value:, friendly_name:)
+        return unless value
+
+        begin
+          Integer(value)
+        rescue ArgumentError, TypeError
+          log_warning("Invalid value for #{friendly_name} (#{value.inspect}). Ignoring this configuration.")
+
+          nil
+        end
+      end
+
       def ssl?
         !parsed_url.nil? && parsed_url.scheme == 'https'
       end
 
+      def hostname
+        configured_hostname || (should_use_uds_fallback? ? nil : Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
+      end
+
+      def port
+        configured_port || (should_use_uds_fallback? ? nil : Datadog::Ext::Transport::HTTP::DEFAULT_PORT)
+      end
+
+      # Unix socket path in the file system
+      def uds_path
+        uds_fallback
+      end
+
+      # Defaults to +nil+, letting the adapter choose what default
+      # works best in their case.
       def timeout_seconds
-        Datadog::Ext::Transport::HTTP::DEFAULT_TIMEOUT_SECONDS
+        nil
       end
 
       def deprecated_for_removal_transport_configuration_proc
@@ -149,6 +210,26 @@ module Datadog
         end
       end
 
+      # We only use the default unix socket if it is already present.
+      # This is by design, as we still want to use the default host:port if no unix socket is present.
+      def uds_fallback
+        return @uds_fallback if defined?(@uds_fallback)
+
+        @uds_fallback =
+          if configured_hostname.nil? &&
+             configured_port.nil? &&
+             deprecated_for_removal_transport_configuration_proc.nil? &&
+             deprecated_for_removal_transport_configuration_options.nil? &&
+             File.exist?(Ext::Transport::UnixSocket::DEFAULT_PATH)
+
+            Ext::Transport::UnixSocket::DEFAULT_PATH
+          end
+      end
+
+      def should_use_uds_fallback?
+        uds_fallback != nil
+      end
+
       def parsed_url
         return @parsed_url if defined?(@parsed_url)
 
@@ -176,7 +257,7 @@ module Datadog
         @unparsed_url_from_env ||= ENV[Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL]
       end
 
-      def pick_from(configurations_in_priority_order:, or_use_default:)
+      def pick_from(*configurations_in_priority_order)
         detected_configurations_in_priority_order = configurations_in_priority_order.select(&:value?)
 
         if detected_configurations_in_priority_order.any?
@@ -185,8 +266,6 @@ module Datadog
           # The configurations are listed in priority, so we only need to look at the first; if there's more than
           # one, we emit a warning above
           detected_configurations_in_priority_order.first.value
-        else
-          or_use_default
         end
       end
 
@@ -196,8 +275,8 @@ module Datadog
         log_warning(
           'Configuration mismatch: values differ between ' \
           "#{detected_configurations_in_priority_order
-            .map { |config| "#{config.friendly_name} ('#{config.value}')" }.join(' and ')}" \
-          ". Using '#{detected_configurations_in_priority_order.first.value}'."
+            .map { |config| "#{config.friendly_name} (#{config.value.inspect})" }.join(' and ')}" \
+          ". Using #{detected_configurations_in_priority_order.first.value.inspect}."
         )
       end
 

data/lib/ddtrace/configuration/base.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'datadog/core/environment/variable_helpers'
 require 'ddtrace/configuration/options'
 

data/lib/ddtrace/configuration/components.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/configuration/agent_settings_resolver'
 require 'ddtrace/diagnostics/health'
 require 'ddtrace/logger'
@@ -57,7 +58,14 @@ module Datadog
             default_service: settings.service,
             enabled: settings.tracer.enabled,
             partial_flush: settings.tracer.partial_flush.enabled,
-            tags: build_tracer_tags(settings)
+            tags: build_tracer_tags(settings),
+            sampler: PrioritySampler.new(
+              base_sampler: AllSampler.new,
+              post_sampler: Sampling::RuleSampler.new(
+                rate_limit: settings.sampling.rate_limit,
+                default_sample_rate: settings.sampling.default_rate
+              )
+            )
           )
 
           # TODO: We reconfigure the tracer here because it has way too many
@@ -70,7 +78,7 @@ module Datadog
           tracer
         end
 
-        def build_profiler(settings, agent_settings)
+        def build_profiler(settings, agent_settings, tracer)
           return unless Datadog::Profiling.supported? && settings.profiling.enabled
 
           unless defined?(Datadog::Profiling::Tasks::Setup)
@@ -107,8 +115,13 @@ module Datadog
 
           # NOTE: Please update the Initialization section of ProfilingDevelopment.md with any changes to this method
 
+          trace_identifiers_helper = Datadog::Profiling::TraceIdentifiers::Helper.new(
+            tracer: tracer,
+            endpoint_collection_enabled: settings.profiling.advanced.endpoint.collection.enabled
+          )
+
           recorder = build_profiler_recorder(settings)
-          collectors = build_profiler_collectors(settings, recorder)
+          collectors = build_profiler_collectors(settings, recorder, trace_identifiers_helper)
           exporters = build_profiler_exporters(settings, agent_settings)
           scheduler = build_profiler_scheduler(settings, recorder, exporters)
 
@@ -161,14 +174,15 @@ module Datadog
         def build_profiler_recorder(settings)
           event_classes = [Datadog::Profiling::Events::StackSample]
 
-          Datadog::Profiling::Recorder.new(event_classes, settings.profiling.max_events)
+          Datadog::Profiling::Recorder.new(event_classes, settings.profiling.advanced.max_events)
         end
 
-        def build_profiler_collectors(settings, recorder)
+        def build_profiler_collectors(settings, recorder, trace_identifiers_helper)
           [
             Datadog::Profiling::Collectors::Stack.new(
               recorder,
-              max_frames: settings.profiling.max_frames
+              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
             )
@@ -209,7 +223,7 @@ module Datadog
         @tracer = self.class.build_tracer(settings, agent_settings)
 
         # Profiler
-        @profiler = self.class.build_profiler(settings, agent_settings)
+        @profiler = self.class.build_profiler(settings, agent_settings, @tracer)
 
         # Runtime metrics
         @runtime_metrics = self.class.build_runtime_metrics_worker(settings)

data/lib/ddtrace/configuration/dependency_resolver.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'tsort'
 
 module Datadog

data/lib/ddtrace/configuration/option.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Configuration
     # Represents an instance of an integration configuration option

data/lib/ddtrace/configuration/option_definition.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/configuration/option'
 
 module Datadog

data/lib/ddtrace/configuration/option_definition_set.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/configuration/dependency_resolver'
 
 module Datadog

data/lib/ddtrace/configuration/option_set.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Configuration
     class OptionSet < Hash

data/lib/ddtrace/configuration/options.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/configuration/option_set'
 require 'ddtrace/configuration/option_definition'
 require 'ddtrace/configuration/option_definition_set'

data/lib/ddtrace/configuration/pin_setup.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Configuration
     # PinSetup translates a flat hash into a Pin configuration

data/lib/ddtrace/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'logger'
 require 'ddtrace/configuration/base'
 
@@ -159,13 +160,29 @@ module Datadog
           end
         end
 
-        option :max_events, default: 32768
+        settings :advanced do
+          # This should never be reduced, as it can cause the resulting profiles to become biased.
+          # The current default should be enough for most services, allowing 16 threads to be sampled around 30 times
+          # per second for a 60 second period.
+          option :max_events, default: 32768
 
-        # 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.
-        option :max_frames do |o|
-          o.default { env_to_int(Ext::Profiling::ENV_MAX_FRAMES, 400) }
-          o.lazy
+          # 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.
+          option :max_frames do |o|
+            o.default { env_to_int(Ext::Profiling::ENV_MAX_FRAMES, 400) }
+            o.lazy
+          end
+
+          settings :endpoint do
+            settings :collection do
+              # When using profiling together with tracing, this controls if endpoint names
+              # are gathered and reported together with profiles.
+              option :enabled do |o|
+                o.default { env_to_bool(Ext::Profiling::ENV_ENDPOINT_COLLECTION_ENABLED, true) }
+                o.lazy
+              end
+            end
+          end
         end
 
         settings :upload do

data/lib/ddtrace/configuration.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'forwardable'
 require 'ddtrace/configuration/pin_setup'
 require 'ddtrace/configuration/settings'
@@ -5,7 +6,8 @@ require 'ddtrace/configuration/components'
 
 module Datadog
   # Configuration provides a unique access point for configurations
-  module Configuration
+  module Configuration # rubocop:disable Metrics/ModuleLength
+    include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
     extend Forwardable
 
     # Used to ensure that @components initialization/reconfiguration is performed one-at-a-time, by a single thread.
@@ -137,7 +139,7 @@ module Datadog
           logger_without_components.error(
             'Detected deadlock during ddtrace initialization. ' \
             'Please report this at https://github.com/DataDog/dd-trace-rb/blob/master/CONTRIBUTING.md#found-a-bug' \
-            "\n\tSource:\n\t#{e.backtrace.join("\n\t")}"
+            "\n\tSource:\n\t#{Array(e.backtrace).join("\n\t")}"
           )
           nil
         end
@@ -172,5 +174,22 @@ module Datadog
         logger
       end
     end
+
+    # Called from our at_exit hook whenever there was a pending Interrupt exception (e.g. typically due to ctrl+c)
+    # to print a nice message whenever we're taking a bit longer than usual to finish the process.
+    def handle_interrupt_shutdown!
+      logger = Datadog.logger
+      shutdown_thread = Thread.new { shutdown! }
+      print_message_treshold_seconds = 0.2
+
+      slow_shutdown = shutdown_thread.join(print_message_treshold_seconds).nil?
+
+      if slow_shutdown
+        logger.info 'Reporting remaining data... Press ctrl+c to exit immediately.'
+        shutdown_thread.join
+      end
+
+      nil
+    end
   end
 end

data/lib/ddtrace/context.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/diagnostics/health'
 
 require 'ddtrace/context_flush'
@@ -77,13 +78,21 @@ module Datadog
     # earlier while child spans still need to finish their traced execution.
     def current_span
       @mutex.synchronize do
-        return @current_span
+        @current_span
       end
     end
 
     def current_root_span
       @mutex.synchronize do
-        return @current_root_span
+        @current_root_span
+      end
+    end
+
+    # Same as calling #current_span and #current_root_span, but works atomically thus preventing races when we need to
+    # retrieve both
+    def current_span_and_root_span
+      @mutex.synchronize do
+        [@current_span, @current_root_span]
       end
     end
 

data/lib/ddtrace/context_flush.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module ContextFlush
     # Consumes only completed traces (where all spans have finished)

data/lib/ddtrace/context_provider.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   # DefaultContextProvider is a default context provider that retrieves
   # all contexts from the current thread-local storage. It is suitable for

data/lib/ddtrace/contrib/action_cable/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/action_cable/ext'
 

data/lib/ddtrace/contrib/action_cable/event.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/active_support/notifications/event'
 require 'ddtrace/contrib/action_cable/ext'

data/lib/ddtrace/contrib/action_cable/events/broadcast.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_cable/event'
 

data/lib/ddtrace/contrib/action_cable/events/perform_action.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_cable/event'
 

data/lib/ddtrace/contrib/action_cable/events/transmit.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/action_cable/event'
 

data/lib/ddtrace/contrib/action_cable/events.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/action_cable/event'
 require 'ddtrace/contrib/action_cable/events/broadcast'
 require 'ddtrace/contrib/action_cable/events/perform_action'

data/lib/ddtrace/contrib/action_cable/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module ActionCable

data/lib/ddtrace/contrib/action_cable/instrumentation.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module ActionCable
@@ -25,6 +26,52 @@ module Datadog
             end
           end
         end
+
+        # Instrumentation for when a Channel is subscribed to/unsubscribed from.
+        module ActionCableChannel
+          def self.included(base)
+            base.class_eval do
+              set_callback(
+                :subscribe,
+                :around,
+                ->(channel, block) { Tracer.trace(channel, :subscribe, &block) },
+                prepend: true
+              )
+
+              set_callback(
+                :unsubscribe,
+                :around,
+                ->(channel, block) { Tracer.trace(channel, :unsubscribe, &block) },
+                prepend: true
+              )
+            end
+          end
+
+          # Instrumentation for Channel hooks.
+          class Tracer
+            def self.trace(channel, hook)
+              configuration = Datadog.configuration[:action_cable]
+
+              Datadog.tracer.trace("action_cable.#{hook}") do |span|
+                span.service = configuration[:service_name]
+                span.resource = "#{channel.class}##{hook}"
+                span.span_type = Datadog::Ext::AppTypes::WEB
+
+                # Set analytics sample rate
+                if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                  Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+                end
+
+                # Measure service stats
+                Contrib::Analytics.set_measured(span)
+
+                span.set_tag(Ext::TAG_CHANNEL_CLASS, channel.class.to_s)
+
+                yield
+              end
+            end
+          end
+        end
       end
     end
   end

data/lib/ddtrace/contrib/action_cable/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/action_cable/configuration/settings'
 require 'ddtrace/contrib/action_cable/patcher'

data/lib/ddtrace/contrib/action_cable/patcher.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/action_cable/ext'
@@ -20,6 +21,7 @@ module Datadog
         def patch
           Events.subscribe!
           ::ActionCable::Connection::Base.prepend(Instrumentation::ActionCableConnection)
+          ::ActionCable::Channel::Base.include(Instrumentation::ActionCableChannel)
         end
       end
     end