datadog 2.12.1 → 2.19.0

data/lib/datadog/tracing/contrib/rails/runner.rb

@@ -10,34 +10,48 @@ module Datadog
         # * `-`: for code provided through the STDIN.
         # * File path: for code provided through a local file.
         # * `inline code`: for code provided directly as a command line argument.
+        #
+        # The difficulty in instrumenting the Rails Runner is that
+        # the Rails application (and as a consequence the Datadog tracing library)
+        # is loaded very late in the runner execution.
+        # The Rails application is loaded inside the same method the method
+        # that directly executes the code the user wants the runner to execute:
+        #
+        # ```ruby
+        # def perform(code_or_file = nil, *command_argv)
+        #   boot_application! # Loads the Rails and Datadog
+        #
+        #   if code_or_file == "-"
+        #     eval($stdin.read, TOPLEVEL_BINDING, "stdin") # Calls the user code for this Runner
+        #   # ...
+        # ```
+        #
+        # This means that there's no time to instrument the calling method, `perform`, which
+        # would be ideal. Instead, we resort to instrumenting `eval` and `load`, but
+        # only for calls from the `Rails::Command::RunnerCommand` class.
+        #
         # @see https://guides.rubyonrails.org/v6.1/command_line.html#bin-rails-runner
         module Runner
           # Limit the maximum size of the source code captured in the source tag.
           MAX_TAG_VALUE_SIZE = 4096
           private_constant :MAX_TAG_VALUE_SIZE
 
-          def runner(code_or_file = nil, *_command_argv)
-            if code_or_file == '-'
+          # Instruments the `Kernel.eval` method, but only for the
+          # `Rails::Command::RunnerCommand` class.
+          def eval(*args)
+            source = args[0]
+
+            if args[2] == 'stdin'
               name = Ext::SPAN_RUNNER_STDIN
-              resource = nil
               operation = Ext::TAG_OPERATION_STDIN
-              # The source is not yet available for STDIN, but it will be captured in `eval`.
-            elsif File.exist?(code_or_file)
-              name = Ext::SPAN_RUNNER_FILE
-              resource = code_or_file
-              operation = Ext::TAG_OPERATION_FILE
-              source = File.read(code_or_file)
             else
               name = Ext::SPAN_RUNNER_INLINE
-              resource = nil
               operation = Ext::TAG_OPERATION_INLINE
-              source = code_or_file
             end
 
             Tracing.trace(
               name,
               service: Datadog.configuration.tracing[:rails][:service_name],
-              resource: resource,
               tags: {
                 Tracing::Metadata::Ext::TAG_COMPONENT => Ext::TAG_COMPONENT,
                 Tracing::Metadata::Ext::TAG_OPERATION => operation,
@@ -55,39 +69,46 @@ module Datadog
             end
           end
 
-          # Capture the executed source code when provided from STDIN.
-          def eval(*args)
-            span = Datadog::Tracing.active_span
-            if span&.name == Ext::SPAN_RUNNER_STDIN
-              source = args[0]
-              span.set_tag(
-                Ext::TAG_RUNNER_SOURCE,
-                Core::Utils.truncate(source, MAX_TAG_VALUE_SIZE)
-              )
-            end
-
-            super
+          def self.prepend(base)
+            base.const_set(:Kernel, Kernel)
           end
 
-          ruby2_keywords :eval if respond_to?(:ruby2_keywords, true)
-        end
+          # Instruments the `Kernel.load` method, but only for the
+          # `Rails::Command::RunnerCommand` class.
+          module Kernel
+            def self.load(file, wrap = true)
+              name = Ext::SPAN_RUNNER_FILE
+              resource = file
+              operation = Ext::TAG_OPERATION_FILE
+
+              begin
+                # Reads one more byte than the limit to allow us to check if the source exceeds the limit.
+                source = File.read(file, MAX_TAG_VALUE_SIZE + 1)
+              rescue => e
+                Datadog.logger.debug("Failed to read file '#{file}' for Rails runner: #{e.message}")
+              end
 
-        # The instrumentation target, {Rails::Command::RunnerCommand} is only loaded
-        # right before `bin/rails runner` is executed. This means there's not much
-        # opportunity to patch it ahead of time.
-        # To ensure we can patch it successfully, we patch it's caller, {Rails::Command}
-        # and promptly patch {Rails::Command::RunnerCommand} when it is loaded.
-        module Command
-          def find_by_namespace(*args)
-            ret = super
-            # Patch RunnerCommand if it is loaded and not already patched.
-            if defined?(::Rails::Command::RunnerCommand) && !(::Rails::Command::RunnerCommand < Runner)
-              ::Rails::Command::RunnerCommand.prepend(Runner)
+              Tracing.trace(
+                name,
+                service: Datadog.configuration.tracing[:rails][:service_name],
+                resource: resource,
+                tags: {
+                  Tracing::Metadata::Ext::TAG_COMPONENT => Ext::TAG_COMPONENT,
+                  Tracing::Metadata::Ext::TAG_OPERATION => operation,
+                }
+              ) do |span|
+                if source
+                  span.set_tag(
+                    Ext::TAG_RUNNER_SOURCE,
+                    Core::Utils.truncate(source, MAX_TAG_VALUE_SIZE)
+                  )
+                end
+                Contrib::Analytics.set_rate!(span, Datadog.configuration.tracing[:rails])
+
+                super
+              end
             end
-            ret
           end
-
-          ruby2_keywords :find_by_namespace if respond_to?(:ruby2_keywords, true)
         end
       end
     end

data/lib/datadog/tracing/contrib/rest_client/request_patch.rb

@@ -25,10 +25,12 @@ module Datadog
               return super(&block) unless Tracing.enabled?
 
               datadog_trace_request(uri) do |_span, trace|
-                if Datadog::AppSec::Utils::TraceOperation.appsec_standalone_reject?(trace)
-                  trace.sampling_priority = Tracing::Sampling::Ext::Priority::AUTO_REJECT
+                if Tracing::Distributed::PropagationPolicy.enabled?(
+                  global_config: datadog_configuration,
+                  trace: trace
+                )
+                  Contrib::HTTP.inject(trace, processed_headers)
                 end
-                Contrib::HTTP.inject(trace, processed_headers) if datadog_configuration[:distributed_tracing]
 
                 super(&block)
               end

data/lib/datadog/tracing/contrib/sidekiq/client_tracer.rb

@@ -24,7 +24,12 @@ module Datadog
             resource = job_resource(job)
 
             Datadog::Tracing.trace(Ext::SPAN_PUSH, service: @sidekiq_service) do |span, trace_op|
-              Sidekiq.inject(trace_op, job) if configuration[:distributed_tracing]
+              if Tracing::Distributed::PropagationPolicy.enabled?(
+                global_config: configuration,
+                trace: trace_op
+              )
+                Sidekiq.inject(trace_op, job)
+              end
 
               span.resource = resource
 

data/lib/datadog/tracing/contrib/sidekiq/distributed/propagation.rb

@@ -2,6 +2,7 @@
 
 require_relative '../../../distributed/fetcher'
 require_relative '../../../distributed/propagation'
+require_relative '../../../distributed/propagation_policy'
 require_relative '../../../distributed/b3_multi'
 require_relative '../../../distributed/b3_single'
 require_relative '../../../distributed/datadog'
@@ -31,6 +32,8 @@ module Datadog
                     Tracing::Distributed::Datadog.new(fetcher: Tracing::Distributed::Fetcher),
                   Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_TRACE_CONTEXT =>
                     Tracing::Distributed::TraceContext.new(fetcher: Tracing::Distributed::Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_BAGGAGE =>
+                    Tracing::Distributed::Baggage.new(fetcher: Tracing::Distributed::Fetcher),
                   Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_NONE => Tracing::Distributed::None.new
                 },
                 propagation_style_inject: propagation_style_inject,

data/lib/datadog/tracing/contrib/sidekiq/ext.rb

@@ -13,6 +13,7 @@ module Datadog
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_SIDEKIQ_ANALYTICS_ENABLED'
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SIDEKIQ_ANALYTICS_SAMPLE_RATE'
           SERVICE_NAME = 'sidekiq'
+          SIDEKIQ_8_SECONDS_PER_INTEGER = 0.001 # Sidekiq 8 uses integer epoch milliseconds, rather than epoch floats
           SPAN_PUSH = 'sidekiq.push'
           SPAN_JOB = 'sidekiq.job'
           SPAN_JOB_FETCH = 'sidekiq.job_fetch'

data/lib/datadog/tracing/contrib/sidekiq/server_tracer.rb

@@ -22,7 +22,7 @@ module Datadog
             @quantize = options[:quantize] || configuration[:quantize]
           end
 
-          def call(worker, job, queue)
+          def call(worker, job, queue) # rubocop:disable Metrics/MethodLength
             resource = job_resource(job)
 
             if @distributed_tracing
@@ -61,7 +61,10 @@ module Datadog
               span.set_tag(Ext::TAG_JOB_RETRY_COUNT, job['retry_count'])
               span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
               span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
-              span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Time.now.utc.to_f - job['enqueued_at'].to_f))
+
+              enqueued_at = job['enqueued_at']
+              enqueued_at *= Ext::SIDEKIQ_8_SECONDS_PER_INTEGER if enqueued_at.is_a?(Integer)
+              span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Core::Utils::Time.now.utc.to_f - enqueued_at.to_f))
 
               args = job['args']
               if args && !args.empty?

data/lib/datadog/tracing/contrib/support.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Miscellaneous support methods to aid in the creation of integrations.
+      module Support
+        module_function
+
+        # Checks if a constant is loaded in a module, handling autoloaded constants correctly.
+        #
+        # This method is particularly useful when you need to check if a constant is fully loaded,
+        # not just defined. It handles the special case of autoloaded constants, which return
+        # non-nil for `defined?` even when they haven't been loaded yet.
+        #
+        # @param base_module [Module] the module to check for the constant
+        # @param constant [Symbol] the name of the constant to check
+        # @return [Boolean] true if the constant has been loaded, false otherwise
+        def fully_loaded?(base_module, constant)
+          # Autoload constants return `constant` for `defined?`, but that doesn't mean they are loaded...
+          base_module.const_defined?(constant) &&
+            # ... to check that we need to call `autoload?`. If it returns `nil`, it's loaded.
+            base_module.autoload?(constant).nil?
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib.rb

@@ -55,6 +55,7 @@ require_relative 'contrib/httpclient/integration'
 require_relative 'contrib/httprb/integration'
 require_relative 'contrib/integration'
 require_relative 'contrib/kafka/integration'
+require_relative 'contrib/karafka'
 require_relative 'contrib/lograge/integration'
 require_relative 'contrib/mongodb/integration'
 require_relative 'contrib/mysql2/integration'

data/lib/datadog/tracing/correlation.rb

@@ -94,8 +94,15 @@ module Datadog
       end
 
       def format_trace_id(trace_id)
-        if Datadog.configuration.tracing.trace_id_128_bit_logging_enabled &&
-            !Tracing::Utils::TraceId.to_high_order(trace_id).zero?
+        if Datadog.configuration.tracing.trace_id_128_bit_logging_enabled
+          format_trace_id_128(trace_id)
+        else
+          Tracing::Utils::TraceId.to_low_order(trace_id).to_s
+        end
+      end
+
+      def format_trace_id_128(trace_id)
+        if !Tracing::Utils::TraceId.to_high_order(trace_id).zero?
           Kernel.format('%032x', trace_id)
         else
           Tracing::Utils::TraceId.to_low_order(trace_id).to_s

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

@@ -84,7 +84,7 @@ module Datadog
           # @return [Numeric, nil] tracer sample rate configured
           def sample_rate
             sampler = Datadog.configuration.tracing.sampler
-            return nil unless sampler
+            return Datadog.configuration.tracing.sampling.default_rate unless sampler
 
             sampler.sample_rate(nil) rescue nil
           end
@@ -97,6 +97,8 @@ module Datadog
           # @return [Hash, nil] sample rules configured
           def sampling_rules
             sampler = Datadog.configuration.tracing.sampler
+            return Datadog.configuration.tracing.sampling.rules unless sampler
+
             return nil unless sampler.is_a?(Tracing::Sampling::PrioritySampler) &&
               sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
 

data/lib/datadog/tracing/distributed/b3_multi.rb

@@ -55,7 +55,7 @@ module Datadog
           span_id = Helpers.parse_hex_id(fetcher[@span_id_key])
 
           # Return early if this propagation is not valid
-          return if span_id.nil? || span_id <= 0 || span_id >= Tracing::Utils::EXTERNAL_MAX_ID
+          return if span_id.nil? || span_id <= 0 || span_id > Tracing::Utils::EXTERNAL_MAX_ID
 
           # We don't need to try and convert sampled since B3 supports 0/1 (AUTO_REJECT/AUTO_KEEP)
           sampling_priority = Helpers.parse_decimal_id(fetcher[@sampled_key])

data/lib/datadog/tracing/distributed/b3_single.rb

@@ -54,7 +54,7 @@ module Datadog
 
           span_id = Helpers.parse_hex_id(parts[1]) if parts.length > 1
           # Return early if this propagation is not valid
-          return if span_id.nil? || span_id <= 0 || span_id >= Tracing::Utils::EXTERNAL_MAX_ID
+          return if span_id.nil? || span_id <= 0 || span_id > Tracing::Utils::EXTERNAL_MAX_ID
 
           sampling_priority = Helpers.parse_decimal_id(parts[2]) if parts.length > 2
 

data/lib/datadog/tracing/distributed/baggage.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require_relative '../metadata/ext'
+require_relative '../trace_digest'
+require_relative 'datadog_tags_codec'
+require_relative '../utils'
+require_relative 'helpers'
+require 'uri'
+
+module Datadog
+  module Tracing
+    module Distributed
+      # W3C Baggage propagator implementation.
+      # The baggage header is propagated through `baggage`.
+      # @see https://www.w3.org/TR/baggage/
+      class Baggage
+        BAGGAGE_KEY = 'baggage'
+        DD_TRACE_BAGGAGE_MAX_ITEMS = 64
+        DD_TRACE_BAGGAGE_MAX_BYTES = 8192
+        SAFE_CHARACTERS_KEY = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$!#&'*+-.^_`|~"
+        SAFE_CHARACTERS_VALUE = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789$!#&'()*+-./:<>?@[]^_`{|}~"
+
+        def initialize(
+          fetcher:,
+          baggage_key: BAGGAGE_KEY
+        )
+          @baggage_key = baggage_key
+          @fetcher = fetcher
+        end
+
+        def inject!(digest, data)
+          return if digest.nil? || digest.baggage.nil?
+
+          baggage_items = digest.baggage.reject { |k, v| k.nil? || v.nil? }
+          return if baggage_items.empty?
+
+          begin
+            if baggage_items.size > DD_TRACE_BAGGAGE_MAX_ITEMS
+              ::Datadog.logger.warn('Baggage item limit exceeded, dropping excess items')
+              baggage_items = baggage_items.first(DD_TRACE_BAGGAGE_MAX_ITEMS)
+            end
+
+            encoded_items = []
+            total_size = 0
+
+            baggage_items.each do |key, value|
+              item = "#{encode_item(key, SAFE_CHARACTERS_KEY)}=#{encode_item(value, SAFE_CHARACTERS_VALUE)}"
+              item_size = item.bytesize + (encoded_items.empty? ? 0 : 1) # +1 for comma if not first item
+              if total_size + item_size > DD_TRACE_BAGGAGE_MAX_BYTES
+                ::Datadog.logger.warn('Baggage header size exceeded, dropping excess items')
+                break # stop adding items when size limit is reached
+              end
+              encoded_items << item
+              total_size += item_size
+            end
+
+            # edge case where a single item is too large
+            return if encoded_items.empty?
+
+            header_value = encoded_items.join(',')
+            data[@baggage_key] = header_value
+          rescue => e
+            ::Datadog.logger.warn("Failed to encode and inject baggage header: #{e.message}")
+          end
+        end
+
+        def extract(data)
+          fetcher = @fetcher.new(data)
+          data = fetcher[@baggage_key]
+          return unless data
+
+          baggage = parse_baggage_header(fetcher[@baggage_key])
+          return unless baggage
+
+          TraceDigest.new(
+            baggage: baggage,
+          )
+        end
+
+        private
+
+        def encode_item(item, safe_characters)
+          # Strip whitespace and URL-encode the item
+          result = URI.encode_www_form_component(item.strip)
+          # Replace '+' with '%20' for space encoding consistency with W3C spec
+          result = result.gsub('+', '%20')
+          # Selectively decode percent-encoded characters that are considered "safe" in W3C Baggage spec
+          result.gsub(/%[0-9A-F]{2}/) do |encoded|
+            if encoded.size >= 3 && encoded[1..2] =~ /\A[0-9A-F]{2}\z/
+              hex_str = encoded[1..2]
+              next encoded unless hex_str && !hex_str.empty?
+
+              # Convert hex representation back to character
+              char = [hex_str.hex].pack('C')
+              # Keep the character as-is if it's in the safe character set, otherwise keep it encoded
+              safe_characters.include?(char) ? char : encoded
+            else
+              encoded
+            end
+          end
+        end
+
+        # Parses a W3C Baggage header string into a hash of key-value pairs
+        # The header format follows the W3C Baggage specification:
+        # - Multiple baggage items are separated by commas
+        # - Each baggage item is a key-value pair separated by '='
+        # - Keys and values are URL-encoded
+        # - Returns an empty hash if the baggage header is malformed
+        #
+        # @param baggage_header [String] The W3C Baggage header string to parse
+        # @return [Hash<String, String>] A hash of decoded baggage items
+        def parse_baggage_header(baggage_header)
+          baggage = {}
+          baggages = baggage_header.split(',')
+          baggages.each do |key_value|
+            key, value = key_value.split('=', 2)
+            # If baggage is malformed, return an empty hash
+            return {} unless key && value
+
+            key = URI.decode_www_form_component(key.strip)
+            value = URI.decode_www_form_component(value.strip)
+            return {} if key.empty? || value.empty?
+
+            baggage[key] = value
+          end
+          baggage
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/distributed/datadog.rb

@@ -89,7 +89,7 @@ module Datadog
           trace_id = Helpers.parse_decimal_id(fetcher_object[@trace_id_key])
 
           return unless trace_id
-          return if trace_id <= 0 || trace_id >= Tracing::Utils::EXTERNAL_MAX_ID
+          return if trace_id <= 0 || trace_id > Tracing::Utils::EXTERNAL_MAX_ID
 
           trace_id
         end
@@ -98,7 +98,7 @@ module Datadog
           parent_id = Helpers.parse_decimal_id(fetcher_object[@parent_id_key])
 
           return unless parent_id
-          return if parent_id <= 0 || parent_id >= Tracing::Utils::EXTERNAL_MAX_ID
+          return if parent_id <= 0 || parent_id > Tracing::Utils::EXTERNAL_MAX_ID
 
           parent_id
         end
@@ -116,6 +116,8 @@ module Datadog
         def extract_trace_id!(trace_id, tags)
           return trace_id unless tags
           return trace_id unless (high_order = tags.delete(Tracing::Metadata::Ext::Distributed::TAG_TID))
+          return trace_id unless high_order.size == 16
+          return trace_id unless /\A[0-9a-f]+\z/i.match?(high_order)
 
           Tracing::Utils::TraceId.concatenate(high_order.to_i(16), trace_id)
         end

data/lib/datadog/tracing/distributed/propagation.rb

@@ -4,6 +4,7 @@ require_relative '../configuration/ext'
 require_relative '../trace_digest'
 require_relative '../trace_operation'
 require_relative '../../core/telemetry/logger'
+require_relative 'baggage'
 
 module Datadog
   module Tracing
@@ -26,9 +27,13 @@ module Datadog
         )
           @propagation_styles = propagation_styles
           @propagation_extract_first = propagation_extract_first
-
           @propagation_style_inject = propagation_style_inject.map { |style| propagation_styles[style] }
           @propagation_style_extract = propagation_style_extract.map { |style| propagation_styles[style] }
+
+          # The baggage propagator is unique in that baggage should always be extracted, if present.
+          # Therefore we remove it from the `propagation_style_extract` list.
+          @baggage_propagator = @propagation_style_extract.find { |propagator| propagator.is_a?(Baggage) }
+          @propagation_style_extract.delete(@baggage_propagator) if @baggage_propagator
         end
 
         # inject! populates the env with span ID, trace ID and sampling priority
@@ -57,9 +62,8 @@ module Datadog
           end
 
           digest = digest.to_digest if digest.respond_to?(:to_digest)
-
-          if digest.trace_id.nil?
-            ::Datadog.logger.debug('Cannot inject distributed trace data: digest.trace_id is nil.')
+          if digest.trace_id.nil? && digest.baggage.nil?
+            ::Datadog.logger.debug('Cannot inject distributed trace data: digest.trace_id and digest.baggage are both nil.')
             return nil
           end
 
@@ -138,12 +142,29 @@ module Datadog
               "Error extracting distributed trace data. Cause: #{e} Location: #{Array(e.backtrace).first}"
             )
           end
+          # Handle baggage after all other styles if present
+          extracted_trace_digest = propagate_baggage(data, extracted_trace_digest) if @baggage_propagator
 
           extracted_trace_digest
         end
 
         private
 
+        def propagate_baggage(data, extracted_trace_digest)
+          if extracted_trace_digest
+            # Merge with baggage if present
+            digest = @baggage_propagator.extract(data)
+            if digest
+              extracted_trace_digest.merge(baggage: digest.baggage)
+            else
+              extracted_trace_digest
+            end
+          else
+            # Baggage is the only style
+            @baggage_propagator.extract(data)
+          end
+        end
+
         def last_datadog_parent_id(headers, tracecontext_tags)
           dd_propagator = @propagation_style_extract.find { |propagator| propagator.is_a?(Datadog) }
           if tracecontext_tags&.fetch(

data/lib/datadog/tracing/distributed/propagation_policy.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Distributed
+      # Helper method to decide when to skip distributed tracing
+      module PropagationPolicy
+        module_function
+
+        # Skips distributed tracing if disabled for this instrumentation
+        # or if APM is disabled unless there is an AppSec event (from upstream distributed trace or local)
+        #
+        # Both pin_config and global_config are configuration for integrations.
+        # pin_config is a Datadog::Core::Pin object, which gives the configuration of a single instance of an integration.
+        # global_config is the config for all instances of an integration.
+        def enabled?(pin_config: nil, global_config: nil, trace: nil)
+          return false unless Tracing.enabled?
+
+          unless ::Datadog.configuration.apm.tracing.enabled
+            return false if trace.nil?
+
+            trace_source = trace.get_tag(::Datadog::Tracing::Metadata::Ext::Distributed::TAG_TRACE_SOURCE)&.to_i(16)
+            return false if trace_source.nil?
+
+            # If AppSec is enabled and AppSec bit is set in the trace, we should not skip distributed tracing
+            # Other products that will use dd.p.ts should implement similar behavior here
+            if ::Datadog.configuration.appsec.enabled && (trace_source & ::Datadog::AppSec::Ext::PRODUCT_BIT) != 0
+              return true
+            end
+
+            return false
+          end
+
+          return pin_config[:distributed_tracing] if pin_config && pin_config.key?(:distributed_tracing)
+          return global_config[:distributed_tracing] if global_config
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/metadata/errors.rb

@@ -10,17 +10,17 @@ module Datadog
       # Adds error tagging behavior
       # @public_api
       module Errors
-        def set_error(e)
+        def set_error(error)
           Datadog::Core.log_deprecation do
             'Errors.set_error(..) is deprecated. ' \
             'Use Errors.set_error_tags(..) instead.'
           end
-          set_error_tags(e)
+          set_error_tags(error)
         end
 
         # Mark the span with the given error.
-        def set_error_tags(e)
-          e = Core::Error.build_from(e)
+        def set_error_tags(error)
+          e = Core::Error.build_from(error)
 
           set_tag(Ext::Errors::TAG_TYPE, e.type) unless e.type.empty?
           set_tag(Ext::Errors::TAG_MSG, e.message) unless e.message.empty?

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

@@ -31,6 +31,8 @@ module Datadog
         # See Datadog-internal "RFC: Identifying which spans have profiling enabled " for details
         TAG_PROFILING_ENABLED = '_dd.profiling.enabled'
 
+        TAG_APM_ENABLED = '_dd.apm.enabled'
+
         # Defines constants for trace analytics
         # @public_api
         module Analytics
@@ -55,6 +57,9 @@ module Datadog
           # @see Datadog::Tracing::Sampling::Ext::Mechanism
           TAG_DECISION_MAKER = '_dd.p.dm'
 
+          # Bitmask for which product generated an event. E.g.: 2 for an AppSec event.
+          TAG_TRACE_SOURCE = '_dd.p.ts'
+
           TAG_ORIGIN = '_dd.origin'
           TAG_SAMPLING_PRIORITY = '_sampling_priority_v1'
 

data/lib/datadog/tracing/metadata/metastruct.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Datadog
+  module Tracing
+    module Metadata
+      # This class is a data structure that is used to store
+      # complex metadata, such as an array of objects.
+      #
+      # It is serialized to MessagePack format when sent to the agent.
+      class Metastruct
+        extend Forwardable
+
+        def_delegators :@metastruct, :[], :[]=, :to_h
+
+        def initialize
+          @metastruct = {}
+        end
+
+        def to_msgpack(packer = nil)
+          # JRuby doesn't pass the packer
+          packer ||= MessagePack::Packer.new
+
+          packer.write(@metastruct.transform_values(&:to_msgpack))
+        end
+
+        def pretty_print(q)
+          q.seplist @metastruct.each do |key, value|
+            q.text "#{key} => #{value}"
+          end
+        end
+      end
+    end
+  end
+end