ddtrace 1.14.0 → 1.16.0

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/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

@@ -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/diagnostics/environment_logger.rb

@@ -137,6 +137,12 @@ module Datadog
           private
 
           def instrumented_integrations
+            # `instrumented_integrations` method is added only if tracing contrib extensions are required.
+            # If tracing is used in manual mode without integrations enabled this method does not exist.
+            # CI visibility gem datadog-ci uses Datadog::Tracer without requiring datadog/tracing/contrib folder
+            # nor enabling any integrations by default which causes EnvironmentCollector to fail.
+            return {} unless Datadog.configuration.tracing.respond_to?(:instrumented_integrations)
+
             Datadog.configuration.tracing.instrumented_integrations
           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

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

@@ -1,50 +1,18 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/agent_settings_resolver'
-require_relative '../../../../ddtrace/transport/http/adapters/registry'
-require_relative '../../../../ddtrace/transport/http/api/map'
-
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/trace includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../../ddtrace/transport/http/api/instance'
+require_relative '../../../core/configuration/agent_settings_resolver'
+require_relative '../../../core/transport/http/adapters/registry'
+require_relative '../../../core/transport/http/api/map'
 require_relative 'api/instance'
-
-# TODO: Decouple transport/http/client
-#
-# The standard one does `include Transport::HTTP::Statistics` and performs
-# stats updates, which may or may not be desirable in general.
-#
-# Below should be:
-# require_relative '../../../../ddtrace/transport/http/client'
 require_relative 'client'
 
-# TODO: Decouple transport/http/builder
-#
-# This class is duplicated even though it is tantalisingly close to the
-# one in ddtrace/transport mostly because it refers to a different
-# `API::Instance` in `#api_instance_class` but also because it operates on a
-# different `HTTP::Client`, as well as de-hardcoding the transport class
-# `Transport::Traces::Transport` in `#to_transport`
-#
-# Additionally, its design makes it so there can be only one (API, Client,
-# Transport) triplet, requiring a new transport instance for any varying
-# element of the triplet.
-
 module Datadog
-  module Core
+  module Tracing
     module Transport
       module HTTP
         # Builds new instances of Transport::HTTP::Client
         class Builder
-          REGISTRY = Datadog::Transport::HTTP::Adapters::Registry.new
+          REGISTRY = Datadog::Core::Transport::HTTP::Adapters::Registry.new
 
           attr_reader \
             :apis,
@@ -59,7 +27,7 @@ module Datadog
             @default_headers = {}
 
             # Client settings
-            @apis = Datadog::Transport::HTTP::API::Map.new
+            @apis = Datadog::Core::Transport::HTTP::API::Map.new
             @default_api = nil
 
             # API settings
@@ -114,16 +82,17 @@ module Datadog
             @default_api = key
           end
 
-          def to_transport(klass)
+          def to_transport
             raise NoDefaultApiError if @default_api.nil?
 
-            klass.new(to_api_instances, @default_api)
+            # DEV: Should not be specific to traces
+            Transport::Traces::Transport.new(to_api_instances, @default_api)
           end
 
           def to_api_instances
             raise NoApisError if @apis.empty?
 
-            @apis.inject(Datadog::Transport::HTTP::API::Map.new) do |instances, (key, spec)|
+            @apis.inject(Datadog::Core::Transport::HTTP::API::Map.new) do |instances, (key, spec)|
               instances.tap do
                 api_options = @api_options[key].dup
 
@@ -154,46 +123,22 @@ module Datadog
 
           # Raised when the API key does not match known APIs.
           class UnknownApiError < StandardError
-            attr_reader :key
-
             def initialize(key)
-              super()
-
-              @key = key
-            end
-
-            def message
-              "Unknown transport API '#{key}'!"
+              super("Unknown transport API '#{key}'!")
             end
           end
 
           # Raised when the identifier cannot be matched to an adapter.
           class UnknownAdapterError < StandardError
-            attr_reader :type
-
             def initialize(type)
-              super()
-
-              @type = type
-            end
-
-            def message
-              "Unknown transport adapter '#{type}'!"
+              super("Unknown transport adapter '#{type}'!")
             end
           end
 
           # Raised when an adapter cannot be resolved for an API instance.
           class NoAdapterForApiError < StandardError
-            attr_reader :key
-
             def initialize(key)
-              super()
-
-              @key = key
-            end
-
-            def message
-              "No adapter resolved for transport API '#{key}'!"
+              super("No adapter resolved for transport API '#{key}'!")
             end
           end
 

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'statistics'
+require_relative '../../../core/transport/http/env'
+require_relative '../../../core/transport/http/response'
+
+module Datadog
+  module Tracing
+    module Transport
+      module HTTP
+        # Routes, encodes, and sends tracer data to the trace agent via HTTP.
+        class Client
+          include Datadog::Tracing::Transport::HTTP::Statistics
+
+          attr_reader :api
+
+          def initialize(api)
+            @api = api
+          end
+
+          def send_request(request, &block)
+            # Build request into env
+            env = build_env(request)
+
+            # Get responses from API
+            response = yield(api, env)
+
+            # Update statistics
+            update_stats_from_response!(response)
+
+            response
+          rescue StandardError => e
+            message =
+              "Internal error during #{self.class.name} request. Cause: #{e.class.name} #{e.message} " \
+                "Location: #{Array(e.backtrace).first}"
+
+            # Log error
+            if stats.consecutive_errors > 0
+              Datadog.logger.debug(message)
+            else
+              Datadog.logger.error(message)
+            end
+
+            # Update statistics
+            update_stats_from_exception!(e)
+
+            Datadog::Core::Transport::InternalErrorResponse.new(e)
+          end
+
+          def build_env(request)
+            Datadog::Core::Transport::HTTP::Env.new(request)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../statistics'
+
+module Datadog
+  module Tracing
+    module Transport
+      module HTTP
+        # Tracks statistics for HTTP transports
+        module Statistics
+          def self.included(base)
+            base.include(Datadog::Tracing::Transport::Statistics)
+            base.include(InstanceMethods)
+          end
+
+          # Instance methods for HTTP statistics
+          module InstanceMethods
+            # Decorate metrics for HTTP responses
+            def metrics_for_response(response)
+              super.tap do |metrics|
+                # Add status code tag to api.responses metric
+                if metrics.key?(:api_responses)
+                  (metrics[:api_responses].options[:tags] ||= []).tap do |tags|
+                    tags << metrics_tag_value(response.code)
+                  end
+                end
+              end
+            end
+
+            private
+
+            # The most common status code on a healthy tracer
+            STATUS_CODE_200 = 'status_code:200'
+
+            def metrics_tag_value(status_code)
+              if status_code == 200
+                STATUS_CODE_200 # DEV Saves string concatenation/creation for common case
+              else
+                "status_code:#{status_code}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require_relative '../traces'
+require_relative 'client'
+require_relative '../../../core/transport/http/response'
+require_relative '../../../core/transport/http/api/endpoint'
+require_relative 'api/instance'
+
+module Datadog
+  module Tracing
+    module Transport
+      module HTTP
+        # HTTP transport behavior for traces
+        module Traces
+          # Response from HTTP transport for traces
+          class Response
+            include Datadog::Core::Transport::HTTP::Response
+            include Datadog::Tracing::Transport::Traces::Response
+
+            def initialize(http_response, options = {})
+              super(http_response)
+              @service_rates = options.fetch(:service_rates, nil)
+              @trace_count = options.fetch(:trace_count, 0)
+            end
+          end
+
+          # Extensions for HTTP client
+          module Client
+            def send_traces_payload(request)
+              send_request(request) do |api, env|
+                api.send_traces(env)
+              end
+            end
+          end
+
+          module API
+            # Extensions for HTTP API Spec
+            module Spec
+              attr_reader :traces
+
+              def traces=(endpoint)
+                @traces = endpoint
+              end
+
+              def send_traces(env, &block)
+                raise NoTraceEndpointDefinedError, self if traces.nil?
+
+                traces.call(env, &block)
+              end
+
+              def encoder
+                traces.encoder
+              end
+
+              # Raised when traces sent but no traces endpoint is defined
+              class NoTraceEndpointDefinedError < StandardError
+                attr_reader :spec
+
+                def initialize(spec)
+                  super
+
+                  @spec = spec
+                end
+
+                def message
+                  'No trace endpoint is defined for API specification!'
+                end
+              end
+            end
+
+            # Extensions for HTTP API Instance
+            module Instance
+              def send_traces(env)
+                raise TracesNotSupportedError, spec unless spec.is_a?(Traces::API::Spec)
+
+                spec.send_traces(env) do |request_env|
+                  call(request_env)
+                end
+              end
+
+              # Raised when traces sent to API that does not support traces
+              class TracesNotSupportedError < StandardError
+                attr_reader :spec
+
+                def initialize(spec)
+                  super
+
+                  @spec = spec
+                end
+
+                def message
+                  'Traces not supported for this API!'
+                end
+              end
+            end
+
+            # Endpoint for submitting trace data
+            class Endpoint < Datadog::Core::Transport::HTTP::API::Endpoint
+              HEADER_CONTENT_TYPE = 'Content-Type'
+              HEADER_TRACE_COUNT = 'X-Datadog-Trace-Count'
+              SERVICE_RATE_KEY = 'rate_by_service'
+
+              attr_reader \
+                :encoder
+
+              def initialize(path, encoder, options = {})
+                super(:post, path)
+                @encoder = encoder
+                @service_rates = options.fetch(:service_rates, false)
+              end
+
+              def service_rates?
+                @service_rates == true
+              end
+
+              def call(env, &block)
+                # Add trace count header
+                env.headers[HEADER_TRACE_COUNT] = env.request.parcel.trace_count.to_s
+
+                # Encode body & type
+                env.headers[HEADER_CONTENT_TYPE] = encoder.content_type
+                env.body = env.request.parcel.data
+
+                # Query for response
+                http_response = super(env, &block)
+
+                # Process the response
+                response_options = { trace_count: env.request.parcel.trace_count }.tap do |options|
+                  # Parse service rates, if configured to do so.
+                  if service_rates? && !http_response.payload.to_s.empty?
+                    body = JSON.parse(http_response.payload)
+                    options[:service_rates] = body[SERVICE_RATE_KEY] if body.is_a?(Hash) && body.key?(SERVICE_RATE_KEY)
+                  end
+                end
+
+                # Build and return a trace response
+                Traces::Response.new(http_response, response_options)
+              end
+            end
+          end
+
+          # Add traces behavior to transport components
+          HTTP::Client.include(Traces::Client)
+          HTTP::API::Spec.include(Traces::API::Spec)
+          HTTP::API::Instance.include(Traces::API::Instance)
+        end
+      end
+    end
+  end
+end