datadog 2.1.0 → 2.3.0

data/lib/datadog/profiling/scheduler.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative '../core/utils/time'
+require_relative "../core/utils/time"
 
-require_relative '../core/worker'
-require_relative '../core/workers/polling'
+require_relative "../core/worker"
+require_relative "../core/workers/polling"
 
 module Datadog
   module Profiling
@@ -22,7 +22,8 @@ module Datadog
 
       attr_reader \
         :exporter,
-        :transport
+        :transport,
+        :profiler_failed
 
       public
 
@@ -34,6 +35,7 @@ module Datadog
       )
         @exporter = exporter
         @transport = transport
+        @profiler_failed = false
 
         # Workers::Async::Thread settings
         self.fork_policy = fork_policy
@@ -50,25 +52,23 @@ module Datadog
       end
 
       def perform(on_failure_proc)
-        begin
-          # A profiling flush may be called while the VM is shutting down, to report the last profile. When we do so,
-          # we impose a strict timeout. This means this last profile may or may not be sent, depending on if the flush can
-          # successfully finish in the strict timeout.
-          # This can be somewhat confusing (why did it not get reported?), so let's at least log what happened.
-          interrupted = true
-
-          flush_and_wait
-          interrupted = false
-        rescue Exception => e # rubocop:disable Lint/RescueException
-          Datadog.logger.warn(
-            'Profiling::Scheduler thread error. ' \
-            "Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
-          )
-          on_failure_proc&.call
-          raise
-        ensure
-          Datadog.logger.debug('#flush was interrupted or failed before it could complete') if interrupted
-        end
+        # A profiling flush may be called while the VM is shutting down, to report the last profile. When we do so,
+        # we impose a strict timeout. This means this last profile may or may not be sent, depending on if the flush can
+        # successfully finish in the strict timeout.
+        # This can be somewhat confusing (why did it not get reported?), so let's at least log what happened.
+        interrupted = true
+
+        flush_and_wait
+        interrupted = false
+      rescue Exception => e # rubocop:disable Lint/RescueException
+        Datadog.logger.warn(
+          "Profiling::Scheduler thread error. " \
+          "Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
+        )
+        on_failure_proc&.call
+        raise
+      ensure
+        Datadog.logger.debug("#flush was interrupted or failed before it could complete") if interrupted
       end
 
       # Configure Workers::IntervalLoop to not report immediately when scheduler starts
@@ -80,8 +80,14 @@ module Datadog
         true
       end
 
+      # This is called by the Profiler class whenever an issue happened in the profiler. This makes sure that even
+      # if there is data to be flushed, we don't try to flush it.
+      def mark_profiler_failed
+        @profiler_failed = true
+      end
+
       def work_pending?
-        exporter.can_flush?
+        !profiler_failed && exporter.can_flush?
       end
 
       def reset_after_fork
@@ -124,7 +130,7 @@ module Datadog
 
         begin
           transport.export(flush)
-        rescue StandardError => e
+        rescue => e
           Datadog.logger.error(
             "Unable to report profile. Cause: #{e.class.name} #{e.message} Location: #{Array(e.backtrace).first}"
           )

data/lib/datadog/profiling/tag_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative '../core/utils'
-require_relative '../core/environment/git'
+require_relative "../core/utils"
+require_relative "../core/environment/git"
 
 module Datadog
   module Profiling

data/lib/datadog/profiling/tasks/exec.rb

@@ -18,16 +18,16 @@ module Datadog
 
         def rubyopts
           [
-            '-rdatadog/profiling/preload'
+            "-rdatadog/profiling/preload"
           ]
         end
 
         private
 
         def set_rubyopt!
-          existing_rubyopt = ENV['RUBYOPT']
+          existing_rubyopt = ENV["RUBYOPT"]
 
-          ENV['RUBYOPT'] = existing_rubyopt ? "#{existing_rubyopt} #{rubyopts.join(' ')}" : rubyopts.join(' ')
+          ENV["RUBYOPT"] = existing_rubyopt ? "#{existing_rubyopt} #{rubyopts.join(" ")}" : rubyopts.join(" ")
         end
 
         # If there's an error here, rather than throwing a cryptic stack trace, let's instead have clearer messages, and
@@ -38,10 +38,10 @@ module Datadog
         def exec_with_error_handling(args)
           Kernel.exec(*args)
         rescue Errno::ENOENT => e
-          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(" ")}')"
           Kernel.exit 127
         rescue Errno::EACCES, Errno::ENOEXEC => e
-          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(' ')}')"
+          Kernel.warn "ddprofrb exec failed: #{e.class.name} #{e.message} (command was '#{args.join(" ")}')"
           Kernel.exit 126
         end
       end

data/lib/datadog/profiling/tasks/setup.rb

@@ -1,56 +1,37 @@
 # frozen_string_literal: true
 
-require_relative '../../core/utils/only_once'
-require_relative '../ext/forking'
+require_relative "../../core/utils/only_once"
+require_relative "../../core/utils/at_fork_monkey_patch"
 
 module Datadog
   module Profiling
     module Tasks
-      # Takes care of loading our extensions/monkey patches to handle fork() and validating if CPU-time profiling is usable
+      # Takes care of restarting the profiler when the process forks
       class Setup
         ACTIVATE_EXTENSIONS_ONLY_ONCE = Core::Utils::OnlyOnce.new
 
         def run
           ACTIVATE_EXTENSIONS_ONLY_ONCE.run do
-            begin
-              activate_forking_extensions
-              setup_at_fork_hooks
-            rescue StandardError, ScriptError => e
-              Datadog.logger.warn do
-                "Profiler extensions unavailable. Cause: #{e.class.name} #{e.message} " \
-                "Location: #{Array(e.backtrace).first}"
-              end
+            Datadog::Core::Utils::AtForkMonkeyPatch.apply!
+            setup_at_fork_hooks
+          rescue StandardError, ScriptError => e
+            Datadog.logger.warn do
+              "Profiler extensions unavailable. Cause: #{e.class.name} #{e.message} " \
+              "Location: #{Array(e.backtrace).first}"
             end
           end
         end
 
         private
 
-        def activate_forking_extensions
-          if Ext::Forking.supported?
-            Ext::Forking.apply!
-          elsif Datadog.configuration.profiling.enabled
-            Datadog.logger.debug('Profiler forking extensions skipped; forking not supported.')
-          end
-        rescue StandardError, ScriptError => e
-          Datadog.logger.warn do
-            "Profiler forking extensions unavailable. Cause: #{e.class.name} #{e.message} " \
-            "Location: #{Array(e.backtrace).first}"
-          end
-        end
-
         def setup_at_fork_hooks
-          if Process.respond_to?(:at_fork)
-            Process.at_fork(:child) do
-              begin
-                # Restart profiler, if enabled
-                Profiling.start_if_enabled
-              rescue StandardError => e
-                Datadog.logger.warn do
-                  "Error during post-fork hooks. Cause: #{e.class.name} #{e.message} " \
-                  "Location: #{Array(e.backtrace).first}"
-                end
-              end
+          Datadog::Core::Utils::AtForkMonkeyPatch.at_fork(:child) do
+            # Restart profiler, if enabled
+            Profiling.start_if_enabled
+          rescue => e
+            Datadog.logger.warn do
+              "Error during post-fork hooks. Cause: #{e.class.name} #{e.message} " \
+              "Location: #{Array(e.backtrace).first}"
             end
           end
         end

data/lib/datadog/profiling.rb

@@ -30,7 +30,7 @@ module Datadog
       profiler = Datadog.send(:components).profiler
       # ...but we still try to start it BECAUSE if the process forks, the profiler will exist but may
       # not yet have been started in the fork
-      profiler.start if profiler
+      profiler&.start
       !!profiler
     end
 
@@ -47,6 +47,7 @@ module Datadog
     # (This is similar to some OS-based time representations.)
     #
     # Note 2: All fibers in the same thread will share the same counter values.
+    # Note 3: This counter is not accurate when using the M:N scheduler.
     #
     # Only available when the profiler is running, and allocation-related features are not disabled via configuration.
     #
@@ -62,7 +63,7 @@ module Datadog
     def self.enabled?
       profiler = Datadog.send(:components).profiler
       # Use .send(...) to avoid exposing the attr_reader as an API to the outside
-      !!(profiler.send(:scheduler).running? if profiler)
+      !!profiler&.send(:scheduler)&.running?
     end
 
     def self.wait_until_running(timeout_seconds: 5)
@@ -97,7 +98,7 @@ module Datadog
 
         contents = file_api.read(skipped_reason_file).strip
         contents unless contents.empty?
-      rescue StandardError
+      rescue
         # Do nothing
       end
     end
@@ -135,7 +136,7 @@ module Datadog
     private_class_method def self.load_profiling
       return false unless supported?
 
-      require_relative 'profiling/ext/forking'
+      require_relative 'profiling/ext/dir_monkey_patches'
       require_relative 'profiling/collectors/info'
       require_relative 'profiling/collectors/code_provenance'
       require_relative 'profiling/collectors/cpu_and_wall_time_worker'
@@ -143,7 +144,6 @@ module Datadog
       require_relative 'profiling/collectors/idle_sampling_helper'
       require_relative 'profiling/collectors/stack'
       require_relative 'profiling/collectors/thread_context'
-      require_relative 'profiling/crashtracker'
       require_relative 'profiling/stack_recorder'
       require_relative 'profiling/exporter'
       require_relative 'profiling/flush'

data/lib/datadog/tracing/contrib/action_cable/event.rb

@@ -46,7 +46,7 @@ module Datadog
           module ClassMethods
             include Contrib::ActionCable::Event::ClassMethods
 
-            def subscription(*args)
+            def subscription(*args, **kwargs)
               super.tap do |subscription|
                 subscription.before_trace { ensure_clean_context! }
               end

data/lib/datadog/tracing/contrib/action_cable/events/broadcast.rb

@@ -34,7 +34,7 @@ module Datadog
               Tracing::Metadata::Ext::AppTypes::TYPE_WEB
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               channel = payload[:broadcasting] # Channel has high cardinality
               span.service = configuration[:service_name] if configuration[:service_name]
               span.type = span_type

data/lib/datadog/tracing/contrib/action_cable/events/perform_action.rb

@@ -33,7 +33,7 @@ module Datadog
               Tracing::Metadata::Ext::AppTypes::TYPE_WEB
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               channel_class = payload[:channel_class]
               action = payload[:action]
 

data/lib/datadog/tracing/contrib/action_cable/events/transmit.rb

@@ -33,7 +33,7 @@ module Datadog
               Tracing::Metadata::Ext::AppTypes::TYPE_WEB
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               channel_class = payload[:channel_class]
 
               span.service = configuration[:service_name] if configuration[:service_name]

data/lib/datadog/tracing/contrib/action_mailer/event.rb

@@ -27,9 +27,11 @@ module Datadog
               Datadog.configuration.tracing[:action_mailer]
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
+              super
+
+              span.type = span_type
               span.service = configuration[:service_name] if configuration[:service_name]
-              span.resource = payload[:mailer]
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
 
               # Set analytics sample rate
@@ -39,10 +41,6 @@ module Datadog
 
               # Measure service stats
               Contrib::Analytics.set_measured(span)
-
-              report_if_exception(span, payload)
-            rescue StandardError => e
-              Datadog.logger.debug(e.message)
             end
           end
         end

data/lib/datadog/tracing/contrib/action_mailer/events/deliver.rb

@@ -30,15 +30,20 @@ module Datadog
               Tracing::Metadata::Ext::AppTypes::TYPE_WORKER
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               super
 
-              span.type = span_type
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_DELIVER)
+            end
+
+            def on_finish(span, event, _id, payload)
+              super
+
+              span.resource = payload[:mailer] # Mailer is not available at `on_start`
+
               span.set_tag(Ext::TAG_MAILER, payload[:mailer])
               span.set_tag(Ext::TAG_MSG_ID, payload[:message_id])
 
-              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_DELIVER)
-
               # Since email data 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

data/lib/datadog/tracing/contrib/action_mailer/events/process.rb

@@ -30,10 +30,11 @@ module Datadog
               Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               super
 
-              span.type = span_type
+              span.resource = payload[:mailer] # Mailer is not available at `on_start`
+
               span.set_tag(Ext::TAG_ACTION, payload[:action])
               span.set_tag(Ext::TAG_MAILER, payload[:mailer])
 

data/lib/datadog/tracing/contrib/action_view/events/render_partial.rb

@@ -27,7 +27,7 @@ module Datadog
               Ext::SPAN_RENDER_PARTIAL
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               span.service = configuration[:service_name] if configuration[:service_name]
               span.type = Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
 
@@ -41,10 +41,6 @@ module Datadog
 
               # Measure service stats
               Contrib::Analytics.set_measured(span)
-
-              record_exception(span, payload)
-            rescue StandardError => e
-              Datadog.logger.debug(e.message)
             end
           end
         end

data/lib/datadog/tracing/contrib/action_view/events/render_template.rb

@@ -27,7 +27,7 @@ module Datadog
               Ext::SPAN_RENDER_TEMPLATE
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               span.service = configuration[:service_name] if configuration[:service_name]
               span.type = Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
 

data/lib/datadog/tracing/contrib/active_job/events/discard.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_DISCARD
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_job/events/enqueue.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_ENQUEUE
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_job/events/enqueue_at.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_ENQUEUE
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_job/events/enqueue_retry.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_ENQUEUE_RETRY
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_job/events/perform.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_PERFORM
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_job/events/retry_stopped.rb

@@ -26,7 +26,7 @@ module Datadog
               Ext::SPAN_RETRY_STOPPED
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.name = span_name
               span.service = configuration[:service_name] if configuration[:service_name]
               span.resource = payload[:job].class.name

data/lib/datadog/tracing/contrib/active_model_serializers/events/render.rb

@@ -30,7 +30,7 @@ module Datadog
               Ext::SPAN_RENDER
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER)
 
               set_common_tags(span, payload)

data/lib/datadog/tracing/contrib/active_model_serializers/events/serialize.rb

@@ -32,7 +32,7 @@ module Datadog
               Ext::SPAN_SERIALIZE
             end
 
-            def process(span, _event, _id, payload)
+            def on_start(span, _event, _id, payload)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERIALIZE)
 
               set_common_tags(span, payload)

data/lib/datadog/tracing/contrib/active_record/events/instantiation.rb

@@ -31,7 +31,7 @@ module Datadog
               Ext::SPAN_INSTANTIATION
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               span.resource = payload.fetch(:class_name)
               span.type = Ext::SPAN_TYPE_INSTANTIATION
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)

data/lib/datadog/tracing/contrib/active_record/events/sql.rb

@@ -29,7 +29,7 @@ module Datadog
               Ext::SPAN_SQL
             end
 
-            def process(span, event, _id, payload)
+            def on_start(span, event, _id, payload)
               config = Utils.connection_config(payload[:connection], payload[:connection_id])
               settings = Datadog.configuration.tracing[:active_record, config]
               adapter_name = Contrib::Utils::Database.normalize_vendor(config[:adapter])
@@ -62,6 +62,7 @@ module Datadog
               cached = payload[:cached] || (payload[:name] == PAYLOAD_CACHE)
 
               span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              span.set_tag(Contrib::Ext::DB::TAG_INSTANCE, config[:database])
               span.set_tag(Ext::TAG_DB_NAME, config[:database])
               span.set_tag(Ext::TAG_DB_CACHED, cached) if cached
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, config[:host]) if config[:host]

data/lib/datadog/tracing/contrib/active_support/cache/event.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../notifications/event'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ActiveSupport
+        module Cache
+          # Defines basic behaviors for an ActiveSupport event.
+          module Event
+            def self.included(base)
+              base.include(ActiveSupport::Notifications::Event)
+              base.extend(ClassMethods)
+            end
+
+            # Class methods for ActiveRecord events.
+            module ClassMethods
+              def span_options
+                {}
+              end
+
+              def configuration
+                Datadog.configuration.tracing[:active_support]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end