ddtrace 1.9.0 → 1.10.0

data/lib/datadog/tracing/contrib.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../tracing'
 require_relative 'contrib/registry'
 require_relative 'contrib/extensions'

data/lib/datadog/tracing/correlation.rb

@@ -1,6 +1,6 @@
-# typed: true
-
 require_relative '../core'
+require_relative 'utils'
+require_relative 'metadata/ext'
 
 module Datadog
   module Tracing
@@ -66,11 +66,23 @@ module Datadog
             attributes << "#{LOG_ATTR_ENV}=#{env}" unless env.nil?
             attributes << "#{LOG_ATTR_SERVICE}=#{service}"
             attributes << "#{LOG_ATTR_VERSION}=#{version}" unless version.nil?
-            attributes << "#{LOG_ATTR_TRACE_ID}=#{trace_id}"
+            attributes << "#{LOG_ATTR_TRACE_ID}=#{logging_trace_id}"
             attributes << "#{LOG_ATTR_SPAN_ID}=#{span_id}"
             attributes.join(' ')
           end
         end
+
+        private
+
+        def logging_trace_id
+          @logging_trace_id ||=
+            if Datadog.configuration.tracing.trace_id_128_bit_logging_enabled &&
+                !Tracing::Utils::TraceId.to_high_order(@trace_id).zero?
+              Kernel.format('%032x', trace_id)
+            else
+              Tracing::Utils::TraceId.to_low_order(@trace_id)
+            end
+        end
       end
 
       module_function

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Diagnostics

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

@@ -1,5 +1,3 @@
-# typed: ignore
-
 require_relative 'ext'
 
 module Datadog

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative 'helpers'
 require_relative '../trace_digest'
+require_relative '../utils'
 
 module Datadog
   module Tracing
@@ -46,13 +46,19 @@ module Datadog
         def extract(data)
           # DEV: B3 doesn't have "origin"
           fetcher = @fetcher.new(data)
-          trace_id = fetcher.id(@trace_id_key, base: 16)
-          span_id = fetcher.id(@span_id_key, base: 16)
-          # We don't need to try and convert sampled since B3 supports 0/1 (AUTO_REJECT/AUTO_KEEP)
-          sampling_priority = fetcher.number(@sampled_key)
+
+          trace_id = Helpers.parse_hex_id(fetcher[@trace_id_key])
 
           # Return early if this propagation is not valid
-          return unless trace_id && span_id
+          return if trace_id.nil? || trace_id <= 0 || trace_id > Tracing::Utils::TraceId::MAX
+
+          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
+
+          # 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])
 
           TraceDigest.new(
             trace_id: trace_id,

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative 'helpers'
 require_relative '../trace_digest'
@@ -47,12 +46,15 @@ module Datadog
           return unless value
 
           parts = value.split('-')
-          trace_id = Helpers.value_to_id(parts[0], 16) unless parts.empty?
-          span_id = Helpers.value_to_id(parts[1], 16) if parts.length > 1
-          sampling_priority = Helpers.value_to_number(parts[2]) if parts.length > 2
+          trace_id = Helpers.parse_hex_id(parts[0]) unless parts.empty?
+          # Return early if this propagation is not valid
+          return if trace_id.nil? || trace_id <= 0 || trace_id > Tracing::Utils::TraceId::MAX
 
-          # Return if this propagation is not valid
-          return unless trace_id && span_id
+          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
+
+          sampling_priority = Helpers.parse_decimal_id(parts[2]) if parts.length > 2
 
           TraceDigest.new(
             span_id: span_id,

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

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative '../metadata/ext'
 require_relative '../trace_digest'
 require_relative 'datadog_tags_codec'
+require_relative '../utils'
+require_relative 'helpers'
 
 module Datadog
   module Tracing
@@ -39,21 +40,26 @@ module Datadog
         def inject!(digest, data)
           return if digest.nil?
 
-          data[@trace_id_key] = digest.trace_id.to_s
+          data[@trace_id_key] = Tracing::Utils::TraceId.to_low_order(digest.trace_id).to_s
+
           data[@parent_id_key] = digest.span_id.to_s
           data[@sampling_priority_key] = digest.trace_sampling_priority.to_s if digest.trace_sampling_priority
           data[@origin_key] = digest.trace_origin.to_s if digest.trace_origin
 
-          inject_tags(digest, data)
+          build_tags(digest).tap do |tags|
+            inject_tags!(tags, data) unless tags.empty?
+          end
 
           data
         end
 
         def extract(data)
           fetcher = @fetcher.new(data)
-          trace_id = fetcher.id(@trace_id_key)
-          parent_id = fetcher.id(@parent_id_key)
-          sampling_priority = fetcher.number(@sampling_priority_key)
+
+          trace_id  = parse_trace_id(fetcher)
+          parent_id = parse_parent_id(fetcher)
+
+          sampling_priority = Helpers.parse_decimal_id(fetcher[@sampling_priority_key])
           origin = fetcher[@origin_key]
 
           # Return early if this propagation is not valid
@@ -64,6 +70,10 @@ module Datadog
 
           trace_distributed_tags = extract_tags(fetcher)
 
+          # If trace id is 128 bits long,
+          # Concatentated high order 64 bit hex-encoded `tid` tag
+          trace_id = extract_trace_id!(trace_id, trace_distributed_tags)
+
           TraceDigest.new(
             span_id: parent_id,
             trace_id: trace_id,
@@ -75,20 +85,57 @@ module Datadog
 
         private
 
+        def parse_trace_id(fetcher_object)
+          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
+
+          trace_id
+        end
+
+        def parse_parent_id(fetcher_object)
+          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
+
+          parent_id
+        end
+
+        def build_tags(digest)
+          high_order = Tracing::Utils::TraceId.to_high_order(digest.trace_id)
+          tags = digest.trace_distributed_tags || {}
+
+          return tags if high_order == 0
+
+          tags.merge(Tracing::Metadata::Ext::Distributed::TAG_TID => high_order.to_s(16))
+        end
+
+        # Side effect: Remove high order 64 bit hex-encoded `tid` tag from distributed tags
+        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))
+
+          Tracing::Utils::TraceId.concatenate(high_order.to_i(16), trace_id)
+        end
+
         # Export trace distributed tags through the `x-datadog-tags` key.
         #
         # DEV: This method accesses global state (the active trace) to record its error state as a trace tag.
         # DEV: This means errors cannot be reported if there's not active span.
         # DEV: Ideally, we'd have a dedicated error reporting stream for all of ddtrace.
-        def inject_tags(digest, data)
-          return if digest.trace_distributed_tags.nil? || digest.trace_distributed_tags.empty?
+        def inject_tags!(tags, data)
           return set_tags_propagation_error(reason: 'disabled') if tags_disabled?
 
-          tags = DatadogTagsCodec.encode(digest.trace_distributed_tags)
+          encoded_tags = DatadogTagsCodec.encode(tags)
 
-          return set_tags_propagation_error(reason: 'inject_max_size') if tags_too_large?(tags.size, scenario: 'inject')
+          return set_tags_propagation_error(reason: 'inject_max_size') if tags_too_large?(
+            encoded_tags.size,
+            scenario: 'inject'
+          )
 
-          data[@tags_key] = tags
+          data[@tags_key] = encoded_tags
         rescue => e
           set_tags_propagation_error(reason: 'encoding_error')
           ::Datadog.logger.warn(

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 module Datadog
   module Tracing

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative 'helpers'
 
@@ -16,14 +15,6 @@ module Datadog
         def [](key)
           @data[key]
         end
-
-        def id(key, base: 10)
-          Helpers.value_to_id(self[key], base)
-        end
-
-        def number(key, base: 10)
-          Helpers.value_to_number(self[key], base)
-        end
       end
     end
   end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module Datadog
   module Tracing

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require_relative '../sampling/ext'
 require_relative '../utils'
@@ -21,56 +20,42 @@ module Datadog
           sampling_priority
         end
 
-        def self.truncate_base16_number(value)
+        def self.parse_decimal_id(value)
+          return unless value
+
+          value = value.to_s
+
+          num   = value.to_i
+
+          # Ensure the parsed number is the same as the original string value
+          # e.g. We want to make sure to throw away `'nan'.to_i == 0`
+          return unless num.to_s(10) == value
+
+          num
+        end
+
+        def self.parse_hex_id(value)
+          return unless value
+
           # Lowercase if we want to parse base16 e.g. 3E8 => 3e8
           # DEV: Ruby will parse `3E8` just fine, but to test
           #      `num.to_s(base) == value` we need to lowercase
-          value = value.downcase
-
-          # Truncate to trailing 16 characters if length is greater than 16
-          # https://github.com/apache/incubator-zipkin/blob/21fe362899fef5c593370466bc5707d3837070c2/zipkin/src/main/java/zipkin2/storage/StorageComponent.java#L49-L53
-          # DEV: This ensures we truncate B3 128-bit trace and span ids to 64-bit
-          value = value[value.length - 16, 16] if value.length > 16
+          value = value.to_s.downcase
 
           # Remove any leading zeros
           # DEV: When we call `num.to_s(16)` later Ruby will not add leading zeros
           #      for us so we want to make sure the comparision will work as expected
           # DEV: regex, remove all leading zeros up until we find the last 0 in the string
           #      or we find the first non-zero, this allows `'0000' -> '0'` and `'00001' -> '1'`
-          value.sub(/^0*(?=(0$)|[^0])/, '')
-        end
-
-        # DEV: move `base` to a keyword argument
-        def self.value_to_id(value, base = 10)
-          id = value_to_number(value, base)
-
-          # Return early if we could not parse a number
-          return if id.nil?
-
-          # Zero or greater than max allowed value of 2**64
-          return if id.zero? || id > Tracing::Utils::EXTERNAL_MAX_ID
-
-          id < 0 ? id + (2**64) : id
-        end
-
-        # DEV: move `base` to a keyword argument
-        def self.value_to_number(value, base = 10)
-          # It's important to make a difference between no data and zero.
-          return if value.nil?
-
-          # Be sure we have a string
-          value = value.to_s
-
-          # If we are parsing base16 number then truncate to 64-bit
-          value = Helpers.truncate_base16_number(value) if base == 16
+          value = value.sub(/^0*(?=(0$)|[^0])/, '')
 
           # Convert value to an integer
           # DEV: Ruby `.to_i` will return `0` if a number could not be parsed
-          num = value.to_i(base)
+          num = value.to_i(16)
 
           # Ensure the parsed number is the same as the original string value
           # e.g. We want to make sure to throw away `'nan'.to_i == 0`
-          return unless num.to_s(base) == value
+          return unless num.to_s(16) == value
 
           num
         end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 module Datadog
   module Tracing

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 require_relative '../configuration/ext'
 require_relative '../trace_digest'

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 module Datadog
   module Tracing
@@ -39,7 +38,7 @@ module Datadog
         def extract(data)
           fetcher = @fetcher.new(data)
 
-          trace_id, dd_trace_id, parent_id, sampled, trace_flags = extract_traceparent(fetcher[@traceparent_key])
+          trace_id, parent_id, sampled, trace_flags = extract_traceparent(fetcher[@traceparent_key])
 
           return unless trace_id # Could not parse traceparent
 
@@ -49,11 +48,10 @@ module Datadog
 
           TraceDigest.new(
             span_id: parent_id,
-            trace_id: dd_trace_id,
+            trace_id: trace_id,
             trace_origin: origin,
             trace_sampling_priority: sampling_priority,
             trace_distributed_tags: tags,
-            trace_distributed_id: trace_id,
             trace_flags: trace_flags,
             trace_state: tracestate,
             trace_state_unknown_fields: unknown_fields,
@@ -93,7 +91,7 @@ module Datadog
         # @see https://www.w3.org/TR/trace-context/#traceparent-header
         def build_traceparent(digest)
           build_traceparent_string(
-            digest.trace_distributed_id || digest.trace_id,
+            digest.trace_id,
             digest.span_id,
             build_trace_flags(digest)
           )
@@ -230,10 +228,9 @@ module Datadog
           # Return unless all traceparent fields are valid.
           return unless trace_id && !trace_id.zero? && parent_id && !parent_id.zero? && trace_flags
 
-          dd_trace_id = parse_datadog_trace_id(trace_id)
           sampled = parse_sampled_flag(trace_flags)
 
-          [trace_id, dd_trace_id, parent_id, sampled, trace_flags]
+          [trace_id, parent_id, sampled, trace_flags]
         end
 
         def parse_traceparent_string(traceparent)
@@ -254,12 +251,6 @@ module Datadog
           nil
         end
 
-        # Datadog only allows 64 bits for the trace id.
-        # We extract the lower 64 bits from the original 128-bit id.
-        def parse_datadog_trace_id(trace_id)
-          trace_id & 0xFFFFFFFFFFFFFFFF
-        end
-
         def parse_sampled_flag(trace_flags)
           trace_flags & TRACE_FLAGS_SAMPLED
         end
@@ -300,6 +291,10 @@ module Datadog
             when /^t\./
               key.slice!(0..1) # Delete `t.` prefix
 
+              # Ignore the high order 64 bit trace id propagation tag to avoid confusion,
+              # the single source of truth is from traceparent
+              next if key == Tracing::Metadata::Ext::Distributed::TID
+
               value = deserialize_tag_value(value)
 
               tags ||= {}

data/lib/datadog/tracing/event.rb

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../core'
 
 module Datadog

data/lib/datadog/tracing/flush.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Flush

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../analytics'
 require_relative 'ext'
 

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../../core/error'
 
 require_relative 'ext'

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: true
-
 module Datadog
   module Tracing
     module Metadata
@@ -55,6 +53,11 @@ module Datadog
           # Trace tags with this prefix will propagate from a trace through distributed tracing.
           # Distributed headers tags with this prefix will be injected into the active trace.
           TAGS_PREFIX = '_dd.p.'
+
+          # The distributed tag to carry hex encoded high order 64 bits of 127 bits trace id during
+          # the context restricted with 64 bits. Such as, Datadog propagation and messagepack encoding
+          TID = 'tid'
+          TAG_TID = TAGS_PREFIX + TID
         end
 
         # @public_api
@@ -166,6 +169,7 @@ module Datadog
 
         # @public_api
         module SpanKind
+          TAG_PROXY = 'proxy'
           TAG_SERVER = 'server'
           TAG_CLIENT = 'client'
           TAG_PRODUCER = 'producer'

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../../core/environment/ext'
 
 require_relative 'ext'

data/lib/datadog/tracing/metadata.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'metadata/analytics'
 require_relative 'metadata/tagging'
 require_relative 'metadata/errors'

data/lib/datadog/tracing/pipeline/span_filter.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'set'
 require_relative 'span_processor'
 

data/lib/datadog/tracing/pipeline/span_processor.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Pipeline

data/lib/datadog/tracing/pipeline.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../core'
 
 require_relative 'pipeline/span_filter'

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../contrib/http/distributed/propagation'
 
 module Datadog

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core'
 
 module Datadog

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'sampler'
 
 module Datadog

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: strict
-
 module Datadog
   module Tracing
     module Sampling

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Sampling

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'ext'
 require_relative 'all_sampler'
 require_relative 'rate_sampler'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative 'sampler'
 require_relative 'rate_sampler'
 

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core'
 require_relative 'rate_by_key_sampler'
 

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core/utils/time'
 
 module Datadog

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core'
 
 require_relative 'sampler'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core'
 
 require_relative 'matcher'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../../core'
 
 require_relative 'ext'

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

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     module Sampling

data/lib/datadog/tracing/span.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# typed: true
-
 require_relative '../core/utils/safe_dup'
 require_relative 'utils'
 

data/lib/datadog/tracing/span_operation.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require 'time'
 
 require_relative '../core'
@@ -64,7 +62,7 @@ module Datadog
 
         @id = Tracing::Utils.next_id
         @parent_id = parent_id || 0
-        @trace_id = trace_id || Tracing::Utils.next_id
+        @trace_id = trace_id || Tracing::Utils::TraceId.next_id
 
         @status = 0
 

data/lib/datadog/tracing/sync_writer.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 require_relative '../core'
 
 require_relative 'pipeline'

data/lib/datadog/tracing/trace_digest.rb

@@ -1,5 +1,3 @@
-# typed: true
-
 module Datadog
   module Tracing
     # Trace digest that represents the important parts of an active trace.