ddtrace 1.13.1 → 1.15.0

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

@@ -48,6 +48,11 @@ module Datadog
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
+              # Tag original global service name if not used
+              if span.service != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+              end
+
               span.set_tag(Ext::TAG_TOPIC, payload[:topic])
               span.set_tag(Ext::TAG_CONSUMER, payload[:consumer_class])
               span.set_tag(Ext::TAG_PARTITION, payload[:partition])

data/lib/datadog/tracing/contrib/rack/header_tagging.rb

@@ -37,10 +37,20 @@ module Datadog
                      whitelist = configuration[:headers][:response] || []
                      whitelist.each_with_object({}) do |header, result|
                        header_value = headers[header]
-                       unless header_value.nil?
-                         header_tag = Tracing::Metadata::Ext::HTTP::ResponseHeaders.to_tag(header)
-                         result[header_tag] = header_value
-                       end
+
+                       next if header_value.nil?
+
+                       header_tag = Tracing::Metadata::Ext::HTTP::ResponseHeaders.to_tag(header)
+
+                       # Maintain the value format between Rack 2 and 3
+                       #
+                       # Rack 2.x => { 'foo' => 'bar,baz' }
+                       # Rack 3.x => { 'foo' => ['bar', 'baz'] }
+                       result[header_tag] = if header_value.is_a? Array
+                                              header_value.join(',')
+                                            else
+                                              header_value
+                                            end
                      end
                    end
 

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

@@ -32,7 +32,7 @@ module Datadog
             option :analytics_enabled do |o|
               o.type :bool, nilable: true
               o.env Ext::ENV_ANALYTICS_ENABLED
-              o.on_set do |value|
+              o.after_set do |value|
                 # Update ActionPack analytics too
                 Datadog.configuration.tracing[:action_pack][:analytics_enabled] = value
               end
@@ -42,7 +42,7 @@ module Datadog
               o.type :float
               o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
               o.default 1.0
-              o.on_set do |value|
+              o.after_set do |value|
                 # Update ActionPack analytics too
                 Datadog.configuration.tracing[:action_pack][:analytics_sample_rate] = value
               end
@@ -55,7 +55,7 @@ module Datadog
             end
             # DEV-2.0: Breaking changes for removal.
             option :exception_controller do |o|
-              o.on_set do |value|
+              o.after_set do |value|
                 if value
                   Datadog::Core.log_deprecation do
                     'The error controller is now automatically detected. '\
@@ -70,7 +70,7 @@ module Datadog
             option :template_base_path do |o|
               o.type :string
               o.default 'views/'
-              o.on_set do |value|
+              o.after_set do |value|
                 # Update ActionView template base path too
                 Datadog.configuration.tracing[:action_view][:template_base_path] = value
               end

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

@@ -41,7 +41,7 @@ module Datadog
             option :tasks do |o|
               o.type :array
               o.default []
-              o.on_set do |value|
+              o.after_set do |value|
                 # DEV: It should be possible to modify the value after it's set. E.g. for normalization.
                 options[:tasks].instance_variable_set(:@value, value.map(&:to_s).to_set)
               end

data/lib/datadog/tracing/contrib/redis/tags.rb

@@ -20,6 +20,11 @@ module Datadog
                 )
               end
 
+              # Tag original global service name if not used
+              if span.service != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
 

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

@@ -33,7 +33,7 @@ module Datadog
             option :service_name
             option :error_handler do |o|
               o.type :proc
-              o.experimental_default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
             end
           end
         end

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

@@ -41,6 +41,11 @@ module Datadog
                 )
               end
 
+              # Tag original global service name if not used
+              if span.service != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)

data/lib/datadog/tracing/contrib/semantic_logger/instrumentation.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../../../core/logging/ext'
-
 module Datadog
   module Tracing
     module Contrib
@@ -23,25 +21,10 @@ module Datadog
 
               # Retrieves trace information for current thread
               correlation = Tracing.correlation
-              # merge original lambda with datadog context
-
-              datadog_trace_log_hash = {
-                # Adds IDs as tags to log output
-                dd: {
-                  # To preserve precision during JSON serialization, use strings for large numbers
-                  trace_id: correlation.trace_id.to_s,
-                  span_id: correlation.span_id.to_s,
-                  env: correlation.env.to_s,
-                  service: correlation.service.to_s,
-                  version: correlation.version.to_s
-                },
-                ddsource: Core::Logging::Ext::DD_SOURCE
-              }
 
-              # # if the user already has conflicting log_tags
-              # # we want them to clobber ours, because we should allow them to override
-              # # if needed.
-              log.named_tags = datadog_trace_log_hash.merge(original_named_tags)
+              # if the user already has conflicting log_tags
+              # we want them to clobber ours, because we should allow them to override if needed.
+              log.named_tags = correlation.to_h.merge(original_named_tags)
               super(log, message, progname, &block)
             end
           end

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

@@ -49,6 +49,11 @@ module Datadog
             end
 
             def set_common_tags(span, db)
+              # Tag original global service name if not used
+              if span.service != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+              end
+
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
 

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

@@ -33,7 +33,7 @@ module Datadog
             option :service_name
             option :error_handler do |o|
               o.type :proc
-              o.experimental_default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
             end
             option :tag_body, default: false, type: :bool
           end

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

@@ -40,7 +40,7 @@ module Datadog
             option :client_service_name
             option :error_handler do |o|
               o.type :proc
-              o.experimental_default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
             end
             option :quantize, default: {}, type: :hash
             option :distributed_tracing, default: false, type: :bool

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

@@ -31,7 +31,7 @@ module Datadog
             option :service_name
             option :error_handler do |o|
               o.type :proc
-              o.experimental_default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
             end
             option :tag_body, default: false, type: :bool
           end

data/lib/datadog/tracing/contrib/utils/quantization/http.rb

@@ -134,18 +134,18 @@ module Datadog
                  (?:"|%22)?
               )
               (?: # common keys
-                 (?:old_?|new_?)?p(?:ass)?w(?:or)?d(?:1|2)? # pw, password variants
-                |pass(?:_?phrase)?  # pass, passphrase variants
+                 (?:old[-_]?|new_?)?p(?:ass)?w(?:or)?d(?:1|2)? # pw, password variants
+                |pass(?:[-_]?phrase)?  # pass, passphrase variants
                 |secret
                 |(?: # key, key_id variants
-                     api_?
-                    |private_?
-                    |public_?
-                    |access_?
-                    |secret_?
-                 )key(?:_?id)?
+                     api[-_]?
+                    |private[-_]?
+                    |public[-_]?
+                    |access[-_]?
+                    |secret[-_]?
+                 )key(?:[-_]?id)?
                 |token
-                |consumer_?(?:id|key|secret)
+                |consumer[-_]?(?:id|key|secret)
                 |sign(?:ed|ature)?
                 |auth(?:entication|orization)?
               )
@@ -160,11 +160,11 @@ module Datadog
                  (?:"|%22)                                     # closing '"' at end of value
               )
              |(?: # other common secret values
-                 bearer(?:\s|%20)+[a-z0-9._\-]+
+                 bearer(?:\s|%20)+[a-z0-9._-]+
                 |token(?::|%3A)[a-z0-9]{13}
                 |gh[opsu]_[0-9a-zA-Z]{36}
                 |ey[I-L](?:[\w=-]|%3D)+\.ey[I-L](?:[\w=-]|%3D)+(?:\.(?:[\w.+/=-]|%3D|%2F|%2B)+)?
-                |-{5}BEGIN(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY-{5}[^\-]+-{5}END(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY(?:-{5})?(?:\n|%0A)?
+                |-{5}BEGIN(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY-{5}[^-]+-{5}END(?:[a-z\s]|%20)+PRIVATE(?:\s|%20)KEY(?:-{5})?(?:\n|%0A)?
                 |(?:ssh-(?:rsa|dss)|ecdsa-[a-z0-9]+-[a-z0-9]+)(?:\s|%20)*(?:[a-z0-9/.+]|%2F|%5C|%2B){100,}(?:=|%3D)*(?:(?:\s+)[a-z0-9._-]+)?
               )
             }ix.freeze

data/lib/datadog/tracing/correlation.rb

@@ -1,5 +1,6 @@
 require_relative 'utils'
 require_relative 'metadata/ext'
+require_relative '../core/logging/ext'
 
 module Datadog
   module Tracing
@@ -14,6 +15,7 @@ module Datadog
         LOG_ATTR_SPAN_ID = 'dd.span_id'.freeze
         LOG_ATTR_TRACE_ID = 'dd.trace_id'.freeze
         LOG_ATTR_VERSION = 'dd.version'.freeze
+        LOG_ATTR_SOURCE = 'ddsource'.freeze
 
         attr_reader \
           :env,
@@ -58,6 +60,23 @@ module Datadog
           @version = Core::Utils::SafeDup.frozen_dup(version || Datadog.configuration.version)
         end
 
+        def to_h
+          @to_h ||= {
+            # Adds IDs as tags to log output
+            dd: {
+              # To preserve precision during JSON serialization, use strings for large numbers
+              env: env.to_s,
+              service: service.to_s,
+              version: version.to_s,
+              trace_id: trace_id.to_s,
+              span_id: span_id.to_s
+            },
+            ddsource: Core::Logging::Ext::DD_SOURCE
+          }
+        end
+
+        # This method (#to_log_format) implements an algorithm by prefixing keys for nested values
+        # but the algorithm makes the constants implicit. Hence, we use it for validation during test.
         def to_log_format
           @log_format ||= begin
             attributes = []
@@ -66,6 +85,7 @@ module Datadog
             attributes << "#{LOG_ATTR_VERSION}=#{version}" unless version.nil?
             attributes << "#{LOG_ATTR_TRACE_ID}=#{trace_id}"
             attributes << "#{LOG_ATTR_SPAN_ID}=#{span_id}"
+            attributes << "#{LOG_ATTR_SOURCE}=#{Core::Logging::Ext::DD_SOURCE}"
             attributes.join(' ')
           end
         end

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

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'json'
+require 'rbconfig'
+require_relative '../../core/diagnostics/environment_logger'
+
+module Datadog
+  module Tracing
+    module Diagnostics
+      # Collects and logs Tracing diagnostic and error information
+      module EnvironmentLogger
+        extend Core::Diagnostics::EnvironmentLogging
+
+        def self.collect_and_log!(responses: nil)
+          log_once! do
+            env_data = EnvironmentCollector.collect_config!
+            log_configuration!('TRACING', env_data.to_json)
+
+            if responses
+              err_data = EnvironmentCollector.collect_errors!(responses)
+              err_data.reject! { |_, v| v.nil? } # Remove empty values from hash output
+              log_error!('TRACING', 'Agent Error', err_data.to_json) unless err_data.empty?
+            end
+          end
+        rescue => e
+          logger.warn("Failed to collect tracing environment information: #{e} Location: #{Array(e.backtrace).first}")
+        end
+      end
+
+      # Collects environment information for Tracing diagnostic logging
+      module EnvironmentCollector
+        class << self
+          def collect_config!
+            {
+              enabled: enabled,
+              agent_url: agent_url,
+              analytics_enabled: analytics_enabled,
+              sample_rate: sample_rate,
+              sampling_rules: sampling_rules,
+              integrations_loaded: integrations_loaded,
+              partial_flushing_enabled: partial_flushing_enabled,
+              priority_sampling_enabled: priority_sampling_enabled,
+              **instrumented_integrations_settings
+            }
+          end
+
+          def collect_errors!(responses)
+            {
+              agent_error: agent_error(responses)
+            }
+          end
+
+          # @return [Boolean, nil]
+          def enabled
+            !!Datadog.configuration.tracing.enabled
+          end
+
+          # @return [String, nil] target agent URL for trace flushing
+          def agent_url
+            # Retrieve the effect agent URL, regardless of how it was configured
+            transport = Tracing.send(:tracer).writer.transport
+
+            # return `nil` with IO transport
+            return unless transport.respond_to?(:client)
+
+            adapter = transport.client.api.adapter
+            adapter.url
+          end
+
+          # Error returned by Datadog agent during a tracer flush attempt
+          # @return [String] concatenated list of transport errors
+          def agent_error(responses)
+            error_responses = responses.reject(&:ok?)
+
+            return nil if error_responses.empty?
+
+            error_responses.map(&:inspect).join(',')
+          end
+
+          # @return [Boolean, nil] analytics enabled in configuration
+          def analytics_enabled
+            !!Datadog.configuration.tracing.analytics.enabled
+          end
+
+          # @return [Numeric, nil] tracer sample rate configured
+          def sample_rate
+            sampler = Datadog.configuration.tracing.sampler
+            return nil unless sampler
+
+            sampler.sample_rate(nil) rescue nil
+          end
+
+          # DEV: We currently only support SimpleRule instances.
+          # DEV: These are the most commonly used rules.
+          # DEV: We should expand support for other rules in the future,
+          # DEV: although it is tricky to serialize arbitrary rules.
+          #
+          # @return [Hash, nil] sample rules configured
+          def sampling_rules
+            sampler = Datadog.configuration.tracing.sampler
+            return nil unless sampler.is_a?(Tracing::Sampling::PrioritySampler) &&
+              sampler.priority_sampler.is_a?(Tracing::Sampling::RuleSampler)
+
+            sampler.priority_sampler.rules.map do |rule|
+              next unless rule.is_a?(Tracing::Sampling::SimpleRule)
+
+              {
+                name: rule.matcher.name,
+                service: rule.matcher.service,
+                sample_rate: rule.sampler.sample_rate(nil)
+              }
+            end.compact
+          end
+
+          # Concatenated list of integrations activated, with their gem version.
+          # Example: "rails@6.0.3,rack@2.2.3"
+          #
+          # @return [String, nil]
+          def integrations_loaded
+            integrations = instrumented_integrations
+            return if integrations.empty?
+
+            integrations.map { |name, integration| "#{name}@#{integration.class.version}" }.join(',')
+          end
+
+          # @return [Boolean, nil] partial flushing enabled in configuration
+          def partial_flushing_enabled
+            !!Datadog.configuration.tracing.partial_flush.enabled
+          end
+
+          # @return [Boolean, nil] priority sampling enabled in configuration
+          def priority_sampling_enabled
+            !!Datadog.configuration.tracing.priority_sampling
+          end
+
+          private
+
+          def instrumented_integrations
+            Datadog.configuration.tracing.instrumented_integrations
+          end
+
+          # Capture all active integration settings into "integrationName_settingName: value" entries.
+          def instrumented_integrations_settings
+            instrumented_integrations.flat_map do |name, integration|
+              integration.configuration.to_h.flat_map do |setting, value|
+                next [] if setting == :tracer # Skip internal Ruby objects
+
+                # Convert value to a string to avoid custom #to_json
+                # handlers possibly causing errors.
+                [[:"integration_#{name}_#{setting}", value.to_s]]
+              end
+            end.to_h
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -18,6 +18,12 @@ module Datadog
         # @param propagation_styles [Hash<String,Object>]
         def initialize(propagation_styles:)
           @propagation_styles = propagation_styles
+          # We need to make sure propagation_style option is evaluated.
+          # Our options are lazy evaluated and it happens that propagation_style has the after_set callback
+          # that affect Datadog.configuration.tracing.distributed_tracing.propagation_inject_style and
+          # Datadog.configuration.tracing.distributed_tracing.propagation_extract_style
+          # By calling it here, we make sure if the customers has set any value either via code or ENV variable is applied.
+          ::Datadog.configuration.tracing.distributed_tracing.propagation_style
         end
 
         # inject! populates the env with span ID, trace ID and sampling priority
@@ -72,8 +78,10 @@ module Datadog
         #
         # @param data [Hash]
         def extract(data)
-          trace_digest = nil
-          dd_trace_digest = nil
+          return unless data
+          return if data.empty?
+
+          extracted_trace_digest = nil
 
           ::Datadog.configuration.tracing.distributed_tracing.propagation_extract_style.each do |style|
             propagator = @propagation_styles[style]
@@ -83,42 +91,14 @@ module Datadog
               extracted_trace_digest = propagator.extract(data)
             rescue => e
               ::Datadog.logger.error(
-                'Error extracting distributed trace data. ' \
-              "Cause: #{e} Location: #{Array(e.backtrace).first}"
+                "Error extracting distributed trace data. Cause: #{e} Location: #{Array(e.backtrace).first}"
               )
             end
 
-            # Skip if no valid data was found
-            next if extracted_trace_digest.nil?
-
-            # Keep track of the Datadog extracted digest, we want to return it if we have it.
-            if extracted_trace_digest && style == Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG
-              dd_trace_digest = extracted_trace_digest
-            end
-
-            # No previously extracted trace data, use the one we just extracted
-            if trace_digest.nil?
-              trace_digest = extracted_trace_digest
-            else
-              unless trace_digest.trace_id == extracted_trace_digest.trace_id \
-                    && trace_digest.span_id == extracted_trace_digest.span_id
-                # We have two mismatched propagation contexts
-                ::Datadog.logger.debug do
-                  'Cannot extract distributed trace data: extracted styles differ, ' \
-                  "#{trace_digest.trace_id} != #{extracted_trace_digest.trace_id} && " \
-                  "#{trace_digest.span_id} != #{extracted_trace_digest.span_id}"
-                end
-
-                # It's safer to create a new context than to attach ourselves to the wrong context
-                return TraceDigest.new # Early return from the whole method
-              end
-            end
+            break if extracted_trace_digest
           end
 
-          # Return the extracted trace digest if we found one or else a new empty digest.
-          # Always return the Datadog trace digest if one exists since it has more
-          # information than the B3 digest, e.g. origin, priority sampling values.
-          dd_trace_digest || trace_digest || nil
+          extracted_trace_digest
         end
       end
     end

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

@@ -59,8 +59,8 @@ module Datadog
         # A valid example is:
         #
         #   span.set_tags({ "http.method" => "GET", "user.id" => "234" })
-        def set_tags(tags)
-          tags.each { |k, v| set_tag(k, v) }
+        def set_tags(hash)
+          hash.each { |k, v| set_tag(k, v) }
         end
 
         # Returns true if the provided `tag` was set to a non-nil value.
@@ -111,7 +111,7 @@ module Datadog
         # Returns a copy of all metadata.
         # Keys for `@meta` and `@metrics` don't collide, by construction.
         def tags
-          @meta.merge(@metrics)
+          meta.merge(metrics)
         end
 
         protected

data/lib/datadog/tracing/sync_writer.rb

@@ -4,7 +4,7 @@ require_relative 'pipeline'
 require_relative 'runtime/metrics'
 require_relative 'writer'
 
-require_relative '../../ddtrace/transport/http'
+require_relative 'transport/http'
 
 module Datadog
   module Tracing
@@ -20,10 +20,10 @@ module Datadog
         :events,
         :transport
 
-      # @param [Datadog::Transport::Traces::Transport] transport a custom transport instance.
+      # @param [Datadog::Tracing::Transport::Traces::Transport] transport a custom transport instance.
       #   If provided, overrides `transport_options` and `agent_settings`.
       # @param [Hash<Symbol,Object>] transport_options options for the default transport instance.
-      # @param [Datadog::Core::Configuration::AgentSettingsResolver::AgentSettings] agent_settings agent options for
+      # @param [Datadog::Tracing::Configuration::AgentSettingsResolver::AgentSettings] agent_settings agent options for
       #   the default transport instance.
       def initialize(transport: nil, transport_options: {}, agent_settings: nil)
         @transport = transport || begin

data/lib/datadog/tracing/tracer.rb

@@ -353,6 +353,8 @@ module Datadog
         end
       end
 
+      # Creates a new TraceOperation, with events bounds to this Tracer instance.
+      # @return [TraceOperation]
       def start_trace(continue_from: nil)
         # Build a new trace using digest if provided.
         trace = build_trace(continue_from)

data/lib/datadog/{core → tracing}/transport/http/api/instance.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Core
+  module Tracing
     module Transport
       module HTTP
         module API

data/lib/datadog/{core → tracing}/transport/http/api/spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Core
+  module Tracing
     module Transport
       module HTTP
         module API

data/lib/datadog/tracing/transport/http/api.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../../../core/encoding'
+
+require_relative '../../../core/transport/http/api/map'
+require_relative 'api/spec'
+
+require_relative 'traces'
+
+module Datadog
+  module Tracing
+    module Transport
+      module HTTP
+        # Namespace for API components
+        module API
+          # Default API versions
+          V4 = 'v0.4'
+          V3 = 'v0.3'
+
+          module_function
+
+          def defaults
+            Datadog::Core::Transport::HTTP::API::Map[
+              V4 => Spec.new do |s|
+                s.traces = Traces::API::Endpoint.new(
+                  '/v0.4/traces',
+                  Core::Encoding::MsgpackEncoder,
+                  service_rates: true
+                )
+              end,
+              V3 => Spec.new do |s|
+                s.traces = Traces::API::Endpoint.new(
+                  '/v0.3/traces',
+                  Core::Encoding::MsgpackEncoder
+                )
+              end,
+            ].with_fallbacks(V4 => V3)
+          end
+        end
+      end
+    end
+  end
+end