ddtrace 1.1.0 → 1.4.0

data/lib/datadog/tracing/pipeline.rb

@@ -1,9 +1,9 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../core'
 
-require 'datadog/tracing/pipeline/span_filter'
-require 'datadog/tracing/pipeline/span_processor'
+require_relative 'pipeline/span_filter'
+require_relative 'pipeline/span_processor'
 
 module Datadog
   module Tracing

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

@@ -1,9 +1,12 @@
-# typed: true
+# typed: false
 
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/span'
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/trace_operation'
+require_relative '../distributed/metadata/datadog'
+require_relative '../distributed/metadata/b3'
+require_relative '../distributed/metadata/b3_single'
+
+require_relative '../span'
+require_relative '../trace_digest'
+require_relative '../trace_operation'
 
 module Datadog
   module Tracing
@@ -13,74 +16,81 @@ module Datadog
       # to the Propagation::HTTP; the key difference is the way gRPC handles
       # header information (called "metadata") as it operates over HTTP2
       module GRPC
-        include Distributed::Headers::Ext
+        PROPAGATION_STYLES = {
+          Configuration::Ext::Distributed::PROPAGATION_STYLE_B3 => Distributed::Metadata::B3,
+          Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER => Distributed::Metadata::B3Single,
+          Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG => Distributed::Metadata::Datadog
+        }.freeze
 
         def self.inject!(digest, metadata)
           return if digest.nil?
 
           digest = digest.to_digest if digest.is_a?(TraceOperation)
 
-          metadata[GRPC_METADATA_TRACE_ID] = digest.trace_id.to_s
-          metadata[GRPC_METADATA_PARENT_ID] = digest.span_id.to_s
-          metadata[GRPC_METADATA_SAMPLING_PRIORITY] = digest.trace_sampling_priority.to_s if digest.trace_sampling_priority
-          metadata[GRPC_METADATA_ORIGIN] = digest.trace_origin.to_s if digest.trace_origin
+          Datadog.configuration.tracing.distributed_tracing.propagation_inject_style.each do |style|
+            propagator = PROPAGATION_STYLES[style]
+            begin
+              propagator.inject!(digest, metadata) unless propagator.nil?
+            rescue => e
+              Datadog.logger.error(
+                'Error injecting propagated trace headers into the environment. ' \
+                "Cause: #{e} Location: #{Array(e.backtrace).first}"
+              )
+            end
+          end
         end
 
         def self.extract(metadata)
-          metadata = Carrier.new(metadata)
-          return nil unless metadata.valid?
-
-          TraceDigest.new(
-            span_id: metadata.parent_id,
-            trace_id: metadata.trace_id,
-            trace_origin: metadata.origin,
-            trace_sampling_priority: metadata.sampling_priority
-          )
-        end
-
-        # opentracing.io compliant carrier object
-        class Carrier
-          include Distributed::Headers::Ext
-
-          def initialize(metadata = {})
-            @metadata = metadata || {}
-          end
-
-          def valid?
-            trace_id && parent_id
-          end
-
-          def trace_id
-            value = metadata_for_key(GRPC_METADATA_TRACE_ID).to_i
-            value if (1..Span::EXTERNAL_MAX_ID).cover? value
-          end
-
-          def parent_id
-            value = metadata_for_key(GRPC_METADATA_PARENT_ID).to_i
-            value if (1..Span::EXTERNAL_MAX_ID).cover? value
-          end
-
-          def sampling_priority
-            value = metadata_for_key(GRPC_METADATA_SAMPLING_PRIORITY)
-            value && value.to_i
-          end
+          trace_digest = nil
+          dd_trace_digest = nil
+
+          Datadog.configuration.tracing.distributed_tracing.propagation_extract_style.each do |style|
+            propagator = PROPAGATION_STYLES[style]
+
+            next if propagator.nil?
+
+            # Extract trace headers
+            begin
+              extracted_trace_digest = propagator.extract(metadata)
+            rescue => e
+              Datadog.logger.error(
+                'Error extracting propagated trace headers from the environment. ' \
+                "Cause: #{e} Location: #{Array(e.backtrace).first}"
+              )
+            end
 
-          def origin
-            value = metadata_for_key(GRPC_METADATA_ORIGIN)
-            value if value != ''
-          end
+            # Skip this style if no valid headers were found
+            next if extracted_trace_digest.nil?
 
-          private
+            # Keep track of the Datadog extract trace headers, we want to return
+            #   this one if we have one
+            if extracted_trace_digest && style == Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG
+              dd_trace_digest = extracted_trace_digest
+            end
 
-          def metadata_for_key(key)
-            # metadata values can be arrays (multiple headers with the same key)
-            value = @metadata[key]
-            if value.is_a?(Array)
-              value.first
+            # No previously extracted trace headers, use the one we just extracted
+            if trace_digest.nil?
+              trace_digest = extracted_trace_digest
             else
-              value
+              unless trace_digest.trace_id == extracted_trace_digest.trace_id \
+                      && trace_digest.span_id == extracted_trace_digest.span_id
+                # Return an empty/new trace headers if we have a mismatch in values extracted
+                msg = "#{trace_digest.trace_id} != #{extracted_trace_digest.trace_id} && " \
+                      "#{trace_digest.span_id} != #{extracted_trace_digest.span_id}"
+                Datadog.logger.debug(
+                  "Cannot extract trace headers from HTTP: extracted trace headers differ, #{msg}"
+                )
+                # DEV: This will return from `self.extract` not this `each` block
+                return TraceDigest.new
+              end
             end
           end
+
+          # Return the extracted trace headers if we found one or else a new empty trace headers
+          # Always return the Datadog trace headers if one exists since it has more
+          #   information than the B3 headers e.g. origin, expanded priority
+          #   sampling values, etc
+          dd_trace_digest || trace_digest || nil
         end
       end
     end

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

@@ -1,15 +1,15 @@
 # typed: false
 
-require 'datadog/core'
+require_relative '../../core'
 
-require 'datadog/tracing/configuration/ext'
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/distributed/headers/b3'
-require 'datadog/tracing/distributed/headers/b3_single'
-require 'datadog/tracing/distributed/headers/datadog'
+require_relative '../configuration/ext'
+require_relative '../sampling/ext'
+require_relative '../distributed/headers/b3'
+require_relative '../distributed/headers/b3_single'
+require_relative '../distributed/headers/datadog'
 
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/trace_operation'
+require_relative '../trace_digest'
+require_relative '../trace_operation'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/runtime/metrics.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../../core'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/all_sampler.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/tracing/sampling/sampler'
+require_relative 'sampler'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/priority_sampler.rb

@@ -1,14 +1,14 @@
 # typed: true
 
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/sampling/all_sampler'
-require 'datadog/tracing/sampling/rate_sampler'
-require 'datadog/tracing/sampling/rate_by_service_sampler'
+require_relative 'ext'
+require_relative 'all_sampler'
+require_relative 'rate_sampler'
+require_relative 'rate_by_service_sampler'
 
 module Datadog
   module Tracing
     module Sampling
-      # {Datadog:::Tracing::Sampling::PrioritySampler}
+      # {Datadog::Tracing::Sampling::PrioritySampler}
       # @public_api
       class PrioritySampler
         # NOTE: We do not advise using a pre-sampler. It can save resources,

data/lib/datadog/tracing/sampling/rate_by_key_sampler.rb

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'datadog/tracing/sampling/sampler'
-require 'datadog/tracing/sampling/rate_sampler'
+require_relative 'sampler'
+require_relative 'rate_sampler'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/rate_by_service_sampler.rb

@@ -1,12 +1,12 @@
 # typed: true
 
-require 'datadog/core'
-require 'datadog/tracing/sampling/rate_by_key_sampler'
+require_relative '../../core'
+require_relative 'rate_by_key_sampler'
 
 module Datadog
   module Tracing
     module Sampling
-      # {Datadog:::Tracing::Sampling::RateByServiceSampler} samples different services at different rates
+      # {Datadog::Tracing::Sampling::RateByServiceSampler} samples different services at different rates
       # @public_api
       class RateByServiceSampler < RateByKeySampler
         DEFAULT_KEY = 'service:,env:'.freeze

data/lib/datadog/tracing/sampling/rate_limiter.rb

@@ -1,6 +1,6 @@
 # typed: true
 
-require 'datadog/core/utils/time'
+require_relative '../../core/utils/time'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/rate_sampler.rb

@@ -1,19 +1,19 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../../core'
 
-require 'datadog/tracing/sampling/sampler'
-require 'datadog/tracing/span'
+require_relative 'sampler'
+require_relative '../span'
 
 module Datadog
   module Tracing
     module Sampling
-      # {Datadog:::Tracing::Sampling::RateSampler} is based on a sample rate.
+      # {Datadog::Tracing::Sampling::RateSampler} is based on a sample rate.
       # @public_api
       class RateSampler < Sampler
         KNUTH_FACTOR = 1111111111111111111
 
-        # Initialize a {Datadog:::Tracing::Sampling::RateSampler}.
+        # Initialize a {Datadog::Tracing::Sampling::RateSampler}.
         # This sampler keeps a random subset of the traces. Its main purpose is to
         # reduce the instrumentation footprint.
         #
@@ -37,11 +37,11 @@ module Datadog
 
         def sample_rate=(sample_rate)
           @sample_rate = sample_rate
-          @sampling_id_threshold = sample_rate * Span::EXTERNAL_MAX_ID
+          @sampling_id_threshold = sample_rate * Tracing::Span::EXTERNAL_MAX_ID
         end
 
         def sample?(trace)
-          ((trace.id * KNUTH_FACTOR) % Span::EXTERNAL_MAX_ID) <= @sampling_id_threshold
+          ((trace.id * KNUTH_FACTOR) % Tracing::Span::EXTERNAL_MAX_ID) <= @sampling_id_threshold
         end
 
         def sample!(trace)

data/lib/datadog/tracing/sampling/rule.rb

@@ -1,9 +1,9 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../../core'
 
-require 'datadog/tracing/sampling/matcher'
-require 'datadog/tracing/sampling/rate_sampler'
+require_relative 'matcher'
+require_relative 'rate_sampler'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/rule_sampler.rb

@@ -1,10 +1,10 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../../core'
 
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/sampling/rate_limiter'
-require 'datadog/tracing/sampling/rule'
+require_relative 'ext'
+require_relative 'rate_limiter'
+require_relative 'rule'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/sampling/span/matcher.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Sampling
+      module Span
+        # Checks if a span conforms to a matching criteria.
+        class Matcher
+          # Pattern that matches any string
+          MATCH_ALL_PATTERN = '*'
+
+          # Matches span name and service to their respective patterns provided.
+          #
+          # The patterns are {String}s with two special characters available:
+          # 1. `?`: matches exactly one of any character.
+          # 2. `*`: matches a substring of any size, including zero.
+          # These patterns can occur any point of the string, any number of times.
+          #
+          # Both {SpanOperation#name} and {SpanOperation#service} must match the provided patterns.
+          #
+          # The whole String has to match the provided patterns: providing a pattern that
+          # matches a portion of the provided String is not considered a match.
+          #
+          # @example web-*
+          #   `'web-*'` will match any string starting with `web-`.
+          # @example cache-?
+          #   `'cache-?'` will match any string starting with `database-` followed by exactly one character.
+          #
+          # @param name_pattern [String] a pattern to be matched against {SpanOperation#name}
+          # @param service_pattern [String] a pattern to be matched against {SpanOperation#service}
+          def initialize(name_pattern: MATCH_ALL_PATTERN, service_pattern: MATCH_ALL_PATTERN)
+            @name = pattern_to_regex(name_pattern)
+            @service = pattern_to_regex(service_pattern)
+          end
+
+          # {Regexp#match?} was added in Ruby 2.4, and it's measurably
+          # the least costly way to get a boolean result for a Regexp match.
+          # @see https://www.ruby-lang.org/en/news/2016/12/25/ruby-2-4-0-released/
+          if Regexp.method_defined?(:match?)
+            # Returns `true` if the span conforms to the configured patterns,
+            # `false` otherwise
+            #
+            # @param [SpanOperation] span
+            # @return [Boolean]
+            def match?(span)
+              # Matching is performed at the end of the lifecycle of a Span,
+              # thus both `name` and `service` are guaranteed to be not `nil`.
+              @name.match?(span.name) && @service.match?(span.service)
+            end
+          else
+            # DEV: Remove when support for Ruby 2.3 and older is removed.
+            def match?(span)
+              @name === span.name && @service === span.service
+            end
+          end
+
+          private
+
+          # @param pattern [String]
+          # @return [Regexp]
+          def pattern_to_regex(pattern)
+            # Ensure no undesired characters are treated as regex.
+            # Our valid special characters, `?` and `*`,
+            # will be escaped so...
+            pattern = Regexp.quote(pattern)
+
+            # ...we account for that here:
+            pattern.gsub!('\?', '.') # Any single character
+            pattern.gsub!('\*', '.*') # Any substring
+
+            # Patterns have to match the whole input string
+            pattern = "\\A#{pattern}\\z"
+
+            Regexp.new(pattern)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/span.rb

@@ -2,11 +2,11 @@
 
 # typed: true
 
-require 'datadog/core/utils'
-require 'datadog/core/utils/safe_dup'
+require_relative '../core/utils'
+require_relative '../core/utils/safe_dup'
 
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/metadata'
+require_relative 'metadata/ext'
+require_relative 'metadata'
 
 module Datadog
   module Tracing
@@ -28,6 +28,9 @@ module Datadog
       # The range of IDs also has to consider portability across different languages and platforms.
       RUBY_MAX_ID = (1 << 62) - 1
 
+      # Excludes zero from possible values
+      RUBY_ID_RANGE = (1..RUBY_MAX_ID).freeze
+
       # While we only generate 63-bit integers due to limitations in other languages, we support
       # parsing 64-bit integers for distributed tracing since an upstream system may generate one
       EXTERNAL_MAX_ID = 1 << 64
@@ -63,6 +66,7 @@ module Datadog
       # * +type+: the type of the span (such as +http+, +db+ and so on)
       # * +parent_id+: the identifier of the parent span
       # * +trace_id+: the identifier of the root span for this trace
+      # * +service_entry+: whether it is a service entry span.
       # TODO: Remove span_type
       def initialize(
         name,
@@ -78,7 +82,8 @@ module Datadog
         start_time: nil,
         status: 0,
         type: span_type,
-        trace_id: nil
+        trace_id: nil,
+        service_entry: nil
       )
         @name = Core::Utils::SafeDup.frozen_or_dup(name)
         @service = Core::Utils::SafeDup.frozen_or_dup(service)
@@ -103,6 +108,11 @@ module Datadog
         # duration_start and duration_end track monotonic clock, and may remain nil in cases where it
         # is known that we have to use wall clock to measure duration.
         @duration = duration
+
+        @service_entry = service_entry
+
+        # Mark with the service entry span metric, if applicable
+        set_metric(Metadata::Ext::TAG_TOP_LEVEL, 1.0) if service_entry
       end
 
       # Return whether the duration is started or not
@@ -207,6 +217,16 @@ module Datadog
       def duration_nano
         (duration * 1e9).to_i
       end
+
+      # https://docs.datadoghq.com/tracing/visualization/#service-entry-span
+      # A span is a service entry span when it is the entrypoint method for a request to a service.
+      # You can visualize this within Datadog APM when the color of the immediate parent on a flame graph is a different
+      # color. Services are also listed on the right when viewing a flame graph.
+      #
+      # @return [Boolean] `true` if the span is a serivce entry span
+      def service_entry?
+        @service_entry == true
+      end
     end
   end
 end

data/lib/datadog/tracing/span_operation.rb

@@ -2,15 +2,15 @@
 
 require 'time'
 
-require 'datadog/core'
-require 'datadog/core/environment/identity'
-require 'datadog/core/utils'
-require 'datadog/core/utils/time'
+require_relative '../core'
+require_relative '../core/environment/identity'
+require_relative '../core/utils'
+require_relative '../core/utils/time'
 
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/event'
-require 'datadog/tracing/span'
-require 'datadog/tracing/metadata'
+require_relative 'metadata/ext'
+require_relative 'event'
+require_relative 'span'
+require_relative 'metadata'
 
 module Datadog
   module Tracing
@@ -468,7 +468,8 @@ module Datadog
           start_time: @start_time,
           status: @status,
           type: @type,
-          trace_id: @trace_id
+          trace_id: @trace_id,
+          service_entry: parent.nil? || (service && parent.service != service)
         )
       end
 

data/lib/datadog/tracing/sync_writer.rb

@@ -1,12 +1,12 @@
 # typed: true
 
-require 'datadog/core'
+require_relative '../core'
 
-require 'datadog/tracing/pipeline'
-require 'datadog/tracing/runtime/metrics'
-require 'datadog/tracing/writer'
+require_relative 'pipeline'
+require_relative 'runtime/metrics'
+require_relative 'writer'
 
-require 'ddtrace/transport/http'
+require_relative '../../ddtrace/transport/http'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/trace_operation.rb

@@ -1,15 +1,15 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/core/environment/identity'
-require 'datadog/core/utils'
+require_relative '../core'
+require_relative '../core/environment/identity'
+require_relative '../core/utils'
 
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/event'
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/trace_segment'
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/metadata/tagging'
+require_relative 'sampling/ext'
+require_relative 'event'
+require_relative 'span_operation'
+require_relative 'trace_segment'
+require_relative 'trace_digest'
+require_relative 'metadata/tagging'
 
 module Datadog
   module Tracing
@@ -135,6 +135,13 @@ module Datadog
         @resource || (root_span && root_span.resource)
       end
 
+      # Returns true if the resource has been explicitly set
+      #
+      # @return [Boolean]
+      def resource_override?
+        !@resource.nil?
+      end
+
       def service
         @service || (root_span && root_span.service)
       end

data/lib/datadog/tracing/trace_segment.rb

@@ -1,11 +1,11 @@
 # typed: true
 
-require 'datadog/core/runtime/ext'
-require 'datadog/core/utils/safe_dup'
+require_relative '../core/runtime/ext'
+require_relative '../core/utils/safe_dup'
 
-require 'datadog/tracing/sampling/ext'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/metadata/tagging'
+require_relative 'sampling/ext'
+require_relative 'metadata/ext'
+require_relative 'metadata/tagging'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/tracer.rb

@@ -1,20 +1,20 @@
 # typed: true
 
-require 'datadog/core'
-require 'datadog/core/environment/ext'
-require 'datadog/core/environment/socket'
-
-require 'datadog/tracing/correlation'
-require 'datadog/tracing/event'
-require 'datadog/tracing/flush'
-require 'datadog/tracing/context_provider'
-require 'datadog/tracing/sampling/all_sampler'
-require 'datadog/tracing/sampling/rule_sampler'
-require 'datadog/tracing/sampling/priority_sampler'
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/trace_digest'
-require 'datadog/tracing/trace_operation'
-require 'datadog/tracing/writer'
+require_relative '../core'
+require_relative '../core/environment/ext'
+require_relative '../core/environment/socket'
+
+require_relative 'correlation'
+require_relative 'event'
+require_relative 'flush'
+require_relative 'context_provider'
+require_relative 'sampling/all_sampler'
+require_relative 'sampling/rule_sampler'
+require_relative 'sampling/priority_sampler'
+require_relative 'span_operation'
+require_relative 'trace_digest'
+require_relative 'trace_operation'
+require_relative 'writer'
 
 module Datadog
   module Tracing