datadog 2.18.0 → 2.20.0

data/lib/datadog/profiling/exporter.rb

@@ -26,7 +26,8 @@ module Datadog
         :last_flush_finish_at,
         :created_at,
         :internal_metadata,
-        :info_json
+        :info_json,
+        :sequence_tracker
 
       public
 
@@ -37,7 +38,8 @@ module Datadog
         code_provenance_collector:,
         internal_metadata:,
         minimum_duration_seconds: PROFILE_DURATION_THRESHOLD_SECONDS,
-        time_provider: Time
+        time_provider: Time,
+        sequence_tracker: Datadog::Profiling::SequenceTracker
       )
         @pprof_recorder = pprof_recorder
         @worker = worker
@@ -50,6 +52,7 @@ module Datadog
         # NOTE: At the time of this comment collected info does not change over time so we'll hardcode
         #       it on startup to prevent serializing the same info on every flush.
         @info_json = JSON.generate(info_collector.info).freeze
+        @sequence_tracker = sequence_tracker
       end
 
       def flush
@@ -73,7 +76,10 @@ module Datadog
           encoded_profile: encoded_profile,
           code_provenance_file_name: Datadog::Profiling::Ext::Transport::HTTP::CODE_PROVENANCE_FILENAME,
           code_provenance_data: uncompressed_code_provenance,
-          tags_as_array: Datadog::Profiling::TagBuilder.call(settings: Datadog.configuration).to_a,
+          tags_as_array: Datadog::Profiling::TagBuilder.call(
+            settings: Datadog.configuration,
+            profile_seq: sequence_tracker.get_next,
+          ).to_a,
           internal_metadata: internal_metadata.merge(
             {
               worker_stats: worker_stats,

data/lib/datadog/profiling/sequence_tracker.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../core/utils/forking'
+
+module Datadog
+  module Profiling
+    # Used to generate the `profile_seq` tag, which effectively counts how many profiles we've attempted to report
+    # from a given runtime-id.
+    #
+    # Note that the above implies a few things:
+    # 1. The sequence number only gets incremented when we decide to report a profile and create a `Flush` for it
+    # 2. The `SequenceTracker` must live across profiler reconfigurations and resets, since no matter how many
+    #    profiler instances get created due to reconfiguration, the runtime-id is still the same, so the sequence number
+    #    should be kept and not restarted from 0
+    # 3. The `SequenceTracker` must be reset after a fork, since the runtime-id will change, and we want to start
+    #    counting from 0 again
+    #
+    # This is why this module is implemented as a singleton that we reuse, not as an instance that we recreate.
+    #
+    # Note that this module is not thread-safe, so it's up to the callers to make sure
+    # it's only used by a single thread at a time (which is what the `Profiling::Exporter`)
+    # is doing.
+    module SequenceTracker
+      class << self
+        include Core::Utils::Forking
+
+        def get_next
+          reset! unless defined?(@sequence_number)
+          after_fork! { reset! }
+
+          next_seq = @sequence_number
+          @sequence_number += 1
+          next_seq
+        end
+
+        private
+
+        def reset!
+          @sequence_number = 0
+        end
+      end
+    end
+  end
+end

data/lib/datadog/profiling/tag_builder.rb

@@ -12,10 +12,12 @@ module Datadog
       def self.call(
         settings:,
         # Other metadata
+        profile_seq:,
         profiler_version: Core::Environment::Identity.gem_datadog_version
       )
         hash = Core::TagBuilder.tags(settings).merge(
           FORM_FIELD_TAG_PROFILER_VERSION => profiler_version,
+          'profile_seq' => profile_seq.to_s,
         )
         Core::Utils.encode_tags(hash)
       end

data/lib/datadog/profiling.rb

@@ -121,15 +121,13 @@ module Datadog
     end
 
     private_class_method def self.try_loading_native_library
-      begin
-        require_relative 'profiling/load_native_extension'
+      require_relative 'profiling/load_native_extension'
 
-        success =
-          defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
-        [success, nil]
-      rescue StandardError, LoadError => e
-        [false, e]
-      end
+      success =
+        defined?(Profiling::NativeExtension) && Profiling::NativeExtension.send(:native_working?)
+      [success, nil]
+    rescue StandardError, LoadError => e
+      [false, e]
     end
 
     # All requires for the profiler should be directly added here; and everything should be loaded eagerly.
@@ -157,6 +155,7 @@ module Datadog
       require_relative 'profiling/native_extension'
       require_relative 'profiling/tag_builder'
       require_relative 'profiling/http_transport'
+      require_relative 'profiling/sequence_tracker'
 
       replace_noop_allocation_count
 

data/lib/datadog/single_step_instrument.rb

@@ -5,8 +5,17 @@
 #
 # This file's path is private. Do not reference this file.
 #
+
+module Datadog
+  # This module handles conditional loading of single step auto-instrumentation,
+  # which enables Datadog tracing and profiling features when available.
+  module SingleStepInstrument
+  end
+end
+
 begin
   require_relative 'auto_instrument'
+  Datadog::SingleStepInstrument::LOADED = true
 rescue StandardError, LoadError => e
   warn "Single step instrumentation failed: #{e.class}:#{e.message}\n\tSource:\n\t#{Array(e.backtrace).join("\n\t")}"
 end

data/lib/datadog/tracing/analytics.rb

@@ -16,7 +16,7 @@ module Datadog
         def set_measured(span_op, value = true)
           return if span_op.nil?
 
-          value = value == true || value == 1 ? 1 : 0
+          value = (value == true || value == 1) ? 1 : 0
           span_op.set_metric(Metadata::Ext::Analytics::TAG_MEASURED, value)
         end
       end

data/lib/datadog/tracing/buffer.rb

@@ -54,7 +54,7 @@ module Datadog
         @buffer_accepted_lengths += trace.length
 
         @buffer_spans += trace.length
-      rescue StandardError => e
+      rescue => e
         Datadog.logger.debug(
           "Failed to measure queue accept. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
         )
@@ -64,7 +64,7 @@ module Datadog
         @buffer_dropped += 1
 
         @buffer_spans -= trace.length
-      rescue StandardError => e
+      rescue => e
         Datadog.logger.debug(
           "Failed to measure queue drop. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
         )
@@ -89,7 +89,7 @@ module Datadog
         @buffer_accepted_lengths = 0
         @buffer_dropped = 0
         @buffer_spans = 0
-      rescue StandardError => e
+      rescue => e
         Datadog.logger.debug(
           "Failed to measure queue. Cause: #{e.class.name} #{e.message} Source: #{Array(e.backtrace).first}"
         )
@@ -121,9 +121,9 @@ module Datadog
     # TODO We should restructure this module, so that classes are not declared at top-level ::Datadog.
     # TODO Making such a change is potentially breaking for users manually configuring the tracer.
     TraceBuffer = if Core::Environment::Ext::RUBY_ENGINE == 'ruby'
-                    CRubyTraceBuffer
-                  else
-                    ThreadSafeTraceBuffer
-                  end
+      CRubyTraceBuffer
+    else
+      ThreadSafeTraceBuffer
+    end
   end
 end

data/lib/datadog/tracing/configuration/dynamic.rb

@@ -24,13 +24,11 @@ module Datadog
           def call(tracing_header_tags)
             # Modify the remote configuration value that it matches the
             # environment variable it configures.
-            if tracing_header_tags
-              tracing_header_tags.map! do |hash|
-                "#{hash['header']}:#{hash['tag_name']}"
-              end
+            tracing_header_tags&.map! do |hash|
+              "#{hash["header"]}:#{hash["tag_name"]}"
             end
 
-            super(tracing_header_tags)
+            super
           end
         end
 
@@ -80,7 +78,7 @@ module Datadog
               tracing_sampling_rules = tracing_sampling_rules.to_json
             end
 
-            super(tracing_sampling_rules)
+            super
             Datadog.send(:components).reconfigure_live_sampler
           end
 

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

@@ -11,6 +11,7 @@ module Datadog
         ENV_ENABLED = 'DD_TRACE_ENABLED'
         ENV_OTEL_TRACES_EXPORTER = 'OTEL_TRACES_EXPORTER'
         ENV_HEADER_TAGS = 'DD_TRACE_HEADER_TAGS'
+        ENV_BAGGAGE_TAG_KEYS = 'DD_TRACE_BAGGAGE_TAG_KEYS'
         ENV_TRACE_ID_128_BIT_GENERATION_ENABLED = 'DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED'
         ENV_NATIVE_SPAN_EVENTS = 'DD_TRACE_NATIVE_SPAN_EVENTS'
 
@@ -47,8 +48,8 @@ module Datadog
           PROPAGATION_STYLE_BAGGAGE = 'baggage'
 
           PROPAGATION_STYLE_SUPPORTED = [PROPAGATION_STYLE_DATADOG, PROPAGATION_STYLE_B3_MULTI_HEADER,
-                                         PROPAGATION_STYLE_B3_SINGLE_HEADER, PROPAGATION_STYLE_TRACE_CONTEXT,
-                                         PROPAGATION_STYLE_BAGGAGE].freeze
+            PROPAGATION_STYLE_B3_SINGLE_HEADER, PROPAGATION_STYLE_TRACE_CONTEXT,
+            PROPAGATION_STYLE_BAGGAGE].freeze
 
           # Sets both extract and inject propagation style tho the provided value.
           # Has lower precedence than `DD_TRACE_PROPAGATION_STYLE_INJECT` or

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

@@ -170,6 +170,23 @@ module Datadog
                 o.setter { |header_tags, _| Configuration::HTTP::HeaderTags.new(header_tags) }
               end
 
+              # Comma-separated list of baggage keys that should be converted to span tags.
+              #
+              # Baggage keys matching the exact, case-sensitive names in this list will be converted
+              # to span tags with the prefix "baggage.".
+              #
+              # Special values:
+              # * Empty string ("") disables baggage tag conversion
+              # * Wildcard ("*") converts all baggage keys to span tags
+              #
+              # @default `DD_TRACE_BAGGAGE_TAG_KEYS` environment variable, otherwise `"user.id,session.id,account.id"`
+              # @return [Array<String>, Symbol, nil] processed baggage tag keys configuration
+              option :baggage_tag_keys do |o|
+                o.env Configuration::Ext::ENV_BAGGAGE_TAG_KEYS
+                o.type :array
+                o.default ['user.id', 'session.id', 'account.id']
+              end
+
               # Enable 128 bit trace id generation.
               #
               # @default `DD_TRACE_128_BIT_TRACEID_GENERATION_ENABLED` environment variable, otherwise `true`

data/lib/datadog/tracing/context.rb

@@ -53,7 +53,7 @@ module Datadog
 
       # Creates a copy of the context, when forked.
       def fork_clone
-        forked_trace = @active_trace && @active_trace.fork_clone
+        forked_trace = @active_trace&.fork_clone
         self.class.new(trace: forked_trace)
       end
 
@@ -61,7 +61,7 @@ module Datadog
 
       def set_active_trace!(trace)
         # Don't retain finished traces
-        @active_trace = trace && !trace.finished? ? trace : nil
+        @active_trace = (trace && !trace.finished?) ? trace : nil
       end
     end
   end

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

@@ -20,7 +20,7 @@ module Datadog
           module ClassMethods
             def span_options
               if configuration[:service_name]
-                { service: configuration[:service_name] }
+                {service: configuration[:service_name]}
               else
                 {}
               end

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

@@ -22,7 +22,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['actioncable'] && Gem.loaded_specs['actioncable'].version
+            Gem.loaded_specs['actioncable']&.version
           end
 
           def self.loaded?

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

@@ -23,7 +23,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['actionmailer'] && Gem.loaded_specs['actionmailer'].version
+            Gem.loaded_specs['actionmailer']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/action_pack/action_controller/instrumentation.rb

@@ -42,7 +42,7 @@ module Datadog
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_CONTROLLER)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.error(e.message)
               Datadog::Core::Telemetry::Logger.report(e)
             end
@@ -87,7 +87,7 @@ module Datadog
               ensure
                 span.finish
               end
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.error(e.message)
               Datadog::Core::Telemetry::Logger.report(e)
             end
@@ -115,7 +115,7 @@ module Datadog
                 begin
                   # process and catch request exceptions
                   Instrumentation.start_processing(payload)
-                  result = super(*args)
+                  result = super
                   status = datadog_response_status
                   payload[:status] = status unless status.nil?
                   result
@@ -146,7 +146,7 @@ module Datadog
                 when Array
                   # Likely a Rack response array: first element is the status.
                   status = response.first
-                  status.class <= Integer ? status : nil
+                  (status.class <= Integer) ? status : nil
                 end
               end
             end

data/lib/datadog/tracing/contrib/action_pack/integration.rb

@@ -23,7 +23,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['actionpack'] && Gem.loaded_specs['actionpack'].version
+            Gem.loaded_specs['actionpack']&.version
           end
 
           def self.loaded?

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

@@ -46,7 +46,7 @@ module Datadog
               Contrib::Analytics.set_measured(span)
 
               record_exception(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -29,10 +29,10 @@ module Datadog
 
             def set_common_tags(span, payload)
               adapter_name = if payload[:adapter].is_a?(Class)
-                               payload[:adapter].name
-                             else
-                               payload[:adapter].class.name
-                             end
+                payload[:adapter].name
+              else
+                payload[:adapter].class.name
+              end
               span.set_tag(Ext::TAG_ADAPTER, adapter_name)
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
@@ -44,10 +44,10 @@ module Datadog
               span.set_tag(Ext::TAG_JOB_EXECUTIONS, job.executions) if job.respond_to?(:executions)
 
               job_scheduled_at = if job.respond_to?(:scheduled_at)
-                                   job.scheduled_at
-                                 elsif job.respond_to?(:enqueued_at)
-                                   job.enqueued_at
-                                 end
+                job.scheduled_at
+              elsif job.respond_to?(:enqueued_at)
+                job.enqueued_at
+              end
               span.set_tag(Ext::TAG_JOB_SCHEDULED_AT, Time.at(job_scheduled_at)) if job_scheduled_at
             end
           end

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

@@ -39,7 +39,7 @@ module Datadog
 
               set_common_tags(span, payload)
               span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -38,7 +38,7 @@ module Datadog
               end
 
               set_common_tags(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -38,7 +38,7 @@ module Datadog
               end
 
               set_common_tags(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -40,7 +40,7 @@ module Datadog
               set_common_tags(span, payload)
               span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
               span.set_tag(Ext::TAG_JOB_RETRY_WAIT, payload[:wait])
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -38,7 +38,7 @@ module Datadog
               end
 
               set_common_tags(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -39,7 +39,7 @@ module Datadog
 
               set_common_tags(span, payload)
               span.set_tag(Ext::TAG_JOB_ERROR, payload[:error])
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

data/lib/datadog/tracing/contrib/active_job/integration.rb

@@ -22,7 +22,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version
+            Gem.loaded_specs['activejob']&.version
           end
 
           def self.loaded?

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

@@ -34,7 +34,7 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER)
 
               set_common_tags(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

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

@@ -18,9 +18,9 @@ module Datadog
 
             def supported?
               Gem.loaded_specs['active_model_serializers'] \
-                && ( \
+                && (
                   Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.9') \
-                  && Gem.loaded_specs['active_model_serializers'].version < Gem::Version.new('0.10') \
+                  && Gem.loaded_specs['active_model_serializers'].version < Gem::Version.new('0.10')
                 )
             end
 
@@ -36,7 +36,7 @@ module Datadog
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERIALIZE)
 
               set_common_tags(span, payload)
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.debug(e.message)
             end
           end

data/lib/datadog/tracing/contrib/active_model_serializers/integration.rb

@@ -18,8 +18,7 @@ module Datadog
           register_as :active_model_serializers
 
           def self.version
-            Gem.loaded_specs['active_model_serializers'] \
-              && Gem.loaded_specs['active_model_serializers'].version
+            Gem.loaded_specs['active_model_serializers']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/active_record/configuration/resolver.rb

@@ -75,7 +75,7 @@ module Datadog
               # hence provide a succinct summary for the error logging.
               #
               Datadog.logger.error(
-                'Failed to resolve ActiveRecord database configuration. '\
+                'Failed to resolve ActiveRecord database configuration. ' \
                 "Cause: #{e.class.name} Source: #{Array(e.backtrace).first}"
               )
               Core::Telemetry::Logger.report(e, description: 'Failed to resolve ActiveRecord database configuration')

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

@@ -48,7 +48,7 @@ module Datadog
 
               span.set_tag(Ext::TAG_INSTANTIATION_CLASS_NAME, payload.fetch(:class_name))
               span.set_tag(Ext::TAG_INSTANTIATION_RECORD_COUNT, payload.fetch(:record_count))
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.error(e.message)
               Datadog::Core::Telemetry::Logger.report(e)
             end

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

@@ -35,10 +35,10 @@ module Datadog
               settings = Datadog.configuration.tracing[:active_record, config]
               adapter_name = Contrib::Utils::Database.normalize_vendor(config[:adapter])
               service_name = if settings.service_name != Contrib::Utils::Database::VENDOR_DEFAULT
-                               settings.service_name
-                             else
-                               adapter_name
-                             end
+                settings.service_name
+              else
+                adapter_name
+              end
 
               span.name = "#{adapter_name}.query"
               span.service = service_name
@@ -68,7 +68,7 @@ module Datadog
               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]
               span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, config[:port]) if config[:port]
-            rescue StandardError => e
+            rescue => e
               Datadog.logger.error(e.message)
               Datadog::Core::Telemetry::Logger.report(e)
             end

data/lib/datadog/tracing/contrib/active_record/integration.rb

@@ -27,7 +27,7 @@ module Datadog
           end
 
           def self.version
-            Gem.loaded_specs['activerecord'] && Gem.loaded_specs['activerecord'].version
+            Gem.loaded_specs['activerecord']&.version
           end
 
           def self.loaded?

data/lib/datadog/tracing/contrib/active_record/utils.rb

@@ -39,17 +39,17 @@ module Datadog
             return default_connection_config if connection.nil? && connection_id.nil?
 
             conn = if !connection.nil?
-                     # Since Rails 6.0, the connection object
-                     # is directly available.
-                     connection
-                   else
-                     # For Rails < 6.0, only the `connection_id`
-                     # is available. We have to find the connection
-                     # object from it.
-                     connection_from_id(connection_id)
-                   end
+              # Since Rails 6.0, the connection object
+              # is directly available.
+              connection
+            else
+              # For Rails < 6.0, only the `connection_id`
+              # is available. We have to find the connection
+              # object from it.
+              connection_from_id(connection_id)
+            end
 
-            if conn && conn.instance_variable_defined?(:@config)
+            if conn&.instance_variable_defined?(:@config)
               conn.instance_variable_get(:@config)
             else
               EMPTY_CONFIG
@@ -102,14 +102,14 @@ module Datadog
             return @default_connection_config if instance_variable_defined?(:@default_connection_config)
 
             current_connection_name = if ::ActiveRecord::Base.respond_to?(:connection_specification_name)
-                                        ::ActiveRecord::Base.connection_specification_name
-                                      else
-                                        ::ActiveRecord::Base
-                                      end
+              ::ActiveRecord::Base.connection_specification_name
+            else
+              ::ActiveRecord::Base
+            end
 
             connection_pool = ::ActiveRecord::Base.connection_handler.retrieve_connection_pool(current_connection_name)
             connection_pool.nil? ? EMPTY_CONFIG : (@default_connection_config = db_config(connection_pool))
-          rescue StandardError
+          rescue
             EMPTY_CONFIG
           end