ddtrace 0.51.1 → 0.54.1

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

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

@@ -0,0 +1,32 @@
+# typed: false
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/action_mailer/ext'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      module Configuration
+        # Custom settings for the ActionMailer integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+          option :email_data, default: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# typed: false
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/action_mailer/ext'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Defines basic behaviors for an ActionMailer event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for ActionMailer events.
+        module ClassMethods
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:action_mailer]
+          end
+
+          def process(span, event, _id, payload)
+            span.service = configuration[:service_name]
+            span.resource = payload[:mailer]
+
+            # 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)
+
+            report_if_exception(span, payload)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/events/deliver.rb

@@ -0,0 +1,54 @@
+# typed: false
+require 'ddtrace/contrib/action_mailer/ext'
+require 'ddtrace/contrib/action_mailer/event'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      module Events
+        # Defines instrumentation for process.action_mailer event
+        module Deliver
+          include ActionMailer::Event
+
+          EVENT_NAME = 'deliver.action_mailer'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_DELIVER
+          end
+
+          def span_type
+            # deliver.action_mailer sends emails
+            Datadog::Ext::AppTypes::WORKER
+          end
+
+          def process(span, event, _id, payload)
+            super
+
+            span.span_type = span_type
+            span.set_tag(Ext::TAG_MAILER, payload[:mailer])
+            span.set_tag(Ext::TAG_MSG_ID, payload[:message_id])
+
+            # Since email date can contain PII we disable by default
+            # Some of these fields can be either strings or arrays, so we try to normalize
+            # https://github.com/rails/rails/blob/18707ab17fa492eb25ad2e8f9818a320dc20b823/actionmailer/lib/action_mailer/base.rb#L742-L754
+            if configuration[:email_data] == true
+              span.set_tag(Ext::TAG_SUBJECT, payload[:subject].to_s) if payload[:subject]
+              span.set_tag(Ext::TAG_TO, payload[:to].join(',')) if payload[:to]
+              span.set_tag(Ext::TAG_FROM, payload[:from].join(',')) if payload[:from]
+              span.set_tag(Ext::TAG_BCC, payload[:bcc].join(',')) if payload[:bcc]
+              span.set_tag(Ext::TAG_CC, payload[:cc].join(',')) if payload[:cc]
+              span.set_tag(Ext::TAG_DATE, payload[:date].to_s) if payload[:date]
+              span.set_tag(Ext::TAG_PERFORM_DELIVERIES, payload[:perform_deliveries]) if payload[:perform_deliveries]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/action_mailer/events/process.rb

@@ -0,0 +1,41 @@
+# typed: false
+require 'ddtrace/contrib/action_mailer/ext'
+require 'ddtrace/contrib/action_mailer/event'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      module Events
+        # Defines instrumentation for process.action_mailer event
+        module Process
+          include ActionMailer::Event
+
+          EVENT_NAME = 'process.action_mailer'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_PROCESS
+          end
+
+          def span_type
+            # process.action_mailer processes email and renders partial templates
+            Datadog::Ext::HTTP::TEMPLATE
+          end
+
+          def process(span, event, _id, payload)
+            super
+
+            span.span_type = span_type
+            span.set_tag(Ext::TAG_ACTION, payload[:action])
+            span.set_tag(Ext::TAG_MAILER, payload[:mailer])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# typed: false
+require 'ddtrace/contrib/action_mailer/events/process'
+require 'ddtrace/contrib/action_mailer/events/deliver'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Defines collection of instrumented ActionMailer events
+      module Events
+        ALL = [
+          Events::Process,
+          Events::Deliver
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: true
+module Datadog
+  module Contrib
+    module ActionMailer
+      # ActionMailer integration constants
+      module Ext
+        APP = 'action_mailer'.freeze
+        ENV_ENABLED = 'DD_TRACE_ACTION_MAILER_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTION_MAILER_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'.freeze
+
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTION_MAILER_ANALYTICS_ENABLED'.freeze
+
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTION_MAILER_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'action_mailer'.freeze
+        SPAN_PROCESS = 'action_mailer.process'.freeze
+        SPAN_DELIVER = 'action_mailer.deliver'.freeze
+        TAG_ACTION = 'action_mailer.action'.freeze
+        TAG_MAILER = 'action_mailer.mailer'.freeze
+        TAG_MSG_ID = 'action_mailer.message_id'.freeze
+
+        TAG_SUBJECT = 'action_mailer.subject'.freeze
+        TAG_TO = 'action_mailer.to'.freeze
+        TAG_FROM = 'action_mailer.from'.freeze
+        TAG_BCC = 'action_mailer.bcc'.freeze
+        TAG_CC = 'action_mailer.cc'.freeze
+        TAG_DATE = 'action_mailer.date'.freeze
+        TAG_PERFORM_DELIVERIES = 'action_mailer.perform_deliveries'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/action_mailer/configuration/settings'
+require 'ddtrace/contrib/action_mailer/patcher'
+
+module Datadog
+  module Contrib
+    module ActionMailer
+      # Description of ActionMailer integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+        register_as :action_mailer, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['actionmailer'] && Gem.loaded_specs['actionmailer'].version
+        end
+
+        def self.loaded?
+          !defined?(::ActionMailer).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION && !defined?(::ActiveSupport::Notifications).nil?
+        end
+
+        # enabled by rails integration so should only auto instrument
+        # if detected that it is being used without rails
+        def auto_instrument?
+          !Datadog::Contrib::Rails::Utils.railtie_supported?
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          ActionMailer::Patcher
+        end
+      end
+    end
+  end
+end