ddtrace 1.1.0 → 1.4.0

data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb

@@ -1,8 +1,7 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/sucker_punch/ext'
+require_relative '../patcher'
+require_relative 'ext'
 
 module Datadog
   module Tracing
@@ -20,8 +19,8 @@ module Datadog
           end
 
           def patch
-            require 'datadog/tracing/contrib/sucker_punch/exception_handler'
-            require 'datadog/tracing/contrib/sucker_punch/instrumentation'
+            require_relative 'exception_handler'
+            require_relative 'instrumentation'
 
             ExceptionHandler.patch!
             Instrumentation.patch!

data/lib/datadog/tracing/contrib.rb

@@ -1,8 +1,8 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/registry'
-require 'datadog/tracing/contrib/extensions'
+require_relative '../tracing'
+require_relative 'contrib/registry'
+require_relative 'contrib/extensions'
 
 module Datadog
   module Tracing
@@ -30,47 +30,48 @@ module Datadog
   end
 end
 
-require 'datadog/tracing/contrib/action_cable/integration'
-require 'datadog/tracing/contrib/action_mailer/integration'
-require 'datadog/tracing/contrib/action_pack/integration'
-require 'datadog/tracing/contrib/action_view/integration'
-require 'datadog/tracing/contrib/active_model_serializers/integration'
-require 'datadog/tracing/contrib/active_job/integration'
-require 'datadog/tracing/contrib/active_record/integration'
-require 'datadog/tracing/contrib/active_support/integration'
-require 'datadog/tracing/contrib/aws/integration'
-require 'datadog/tracing/contrib/concurrent_ruby/integration'
-require 'datadog/tracing/contrib/dalli/integration'
-require 'datadog/tracing/contrib/delayed_job/integration'
-require 'datadog/tracing/contrib/elasticsearch/integration'
-require 'datadog/tracing/contrib/ethon/integration'
-require 'datadog/tracing/contrib/excon/integration'
-require 'datadog/tracing/contrib/faraday/integration'
-require 'datadog/tracing/contrib/grape/integration'
-require 'datadog/tracing/contrib/graphql/integration'
-require 'datadog/tracing/contrib/grpc/integration'
-require 'datadog/tracing/contrib/http/integration'
-require 'datadog/tracing/contrib/httpclient/integration'
-require 'datadog/tracing/contrib/httprb/integration'
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/kafka/integration'
-require 'datadog/tracing/contrib/lograge/integration'
-require 'datadog/tracing/contrib/mongodb/integration'
-require 'datadog/tracing/contrib/mysql2/integration'
-require 'datadog/tracing/contrib/presto/integration'
-require 'datadog/tracing/contrib/qless/integration'
-require 'datadog/tracing/contrib/que/integration'
-require 'datadog/tracing/contrib/racecar/integration'
-require 'datadog/tracing/contrib/rack/integration'
-require 'datadog/tracing/contrib/rails/integration'
-require 'datadog/tracing/contrib/rake/integration'
-require 'datadog/tracing/contrib/redis/integration'
-require 'datadog/tracing/contrib/resque/integration'
-require 'datadog/tracing/contrib/rest_client/integration'
-require 'datadog/tracing/contrib/semantic_logger/integration'
-require 'datadog/tracing/contrib/sequel/integration'
-require 'datadog/tracing/contrib/shoryuken/integration'
-require 'datadog/tracing/contrib/sidekiq/integration'
-require 'datadog/tracing/contrib/sinatra/integration'
-require 'datadog/tracing/contrib/sneakers/integration'
-require 'datadog/tracing/contrib/sucker_punch/integration'
+require_relative 'contrib/action_cable/integration'
+require_relative 'contrib/action_mailer/integration'
+require_relative 'contrib/action_pack/integration'
+require_relative 'contrib/action_view/integration'
+require_relative 'contrib/active_model_serializers/integration'
+require_relative 'contrib/active_job/integration'
+require_relative 'contrib/active_record/integration'
+require_relative 'contrib/active_support/integration'
+require_relative 'contrib/aws/integration'
+require_relative 'contrib/concurrent_ruby/integration'
+require_relative 'contrib/dalli/integration'
+require_relative 'contrib/delayed_job/integration'
+require_relative 'contrib/elasticsearch/integration'
+require_relative 'contrib/ethon/integration'
+require_relative 'contrib/excon/integration'
+require_relative 'contrib/faraday/integration'
+require_relative 'contrib/grape/integration'
+require_relative 'contrib/graphql/integration'
+require_relative 'contrib/grpc/integration'
+require_relative 'contrib/http/integration'
+require_relative 'contrib/httpclient/integration'
+require_relative 'contrib/httprb/integration'
+require_relative 'contrib/integration'
+require_relative 'contrib/kafka/integration'
+require_relative 'contrib/lograge/integration'
+require_relative 'contrib/mongodb/integration'
+require_relative 'contrib/mysql2/integration'
+require_relative 'contrib/pg/integration'
+require_relative 'contrib/presto/integration'
+require_relative 'contrib/qless/integration'
+require_relative 'contrib/que/integration'
+require_relative 'contrib/racecar/integration'
+require_relative 'contrib/rack/integration'
+require_relative 'contrib/rails/integration'
+require_relative 'contrib/rake/integration'
+require_relative 'contrib/redis/integration'
+require_relative 'contrib/resque/integration'
+require_relative 'contrib/rest_client/integration'
+require_relative 'contrib/semantic_logger/integration'
+require_relative 'contrib/sequel/integration'
+require_relative 'contrib/shoryuken/integration'
+require_relative 'contrib/sidekiq/integration'
+require_relative 'contrib/sinatra/integration'
+require_relative 'contrib/sneakers/integration'
+require_relative 'contrib/sucker_punch/integration'

data/lib/datadog/tracing/correlation.rb

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

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

@@ -1,9 +1,9 @@
 # typed: true
 
-require 'datadog/tracing/distributed/parser'
-require 'datadog/tracing/distributed/helpers'
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/trace_digest'
+require_relative 'parser'
+require_relative '../helpers'
+require_relative 'ext'
+require_relative '../../trace_digest'
 
 module Datadog
   module Tracing

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

@@ -1,9 +1,9 @@
 # typed: true
 
-require 'datadog/tracing/distributed/parser'
-require 'datadog/tracing/distributed/helpers'
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/trace_digest'
+require_relative 'parser'
+require_relative '../helpers'
+require_relative 'ext'
+require_relative '../../trace_digest'
 
 module Datadog
   module Tracing
@@ -47,9 +47,9 @@ module Datadog
             return if value.nil?
 
             parts = value.split('-')
-            trace_id = headers.value_to_id(parts[0], 16) unless parts.empty?
-            span_id = headers.value_to_id(parts[1], 16) if parts.length > 1
-            sampling_priority = headers.value_to_number(parts[2]) if parts.length > 2
+            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
 
             # Return early if this propagation is not valid
             return unless trace_id && span_id

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

@@ -1,8 +1,8 @@
 # typed: true
 
-require 'datadog/tracing/distributed/parser'
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/trace_digest'
+require_relative 'parser'
+require_relative 'ext'
+require_relative '../../trace_digest'
 
 module Datadog
   module Tracing

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

@@ -0,0 +1,37 @@
+# typed: false
+
+require_relative '../helpers'
+
+module Datadog
+  module Tracing
+    module Distributed
+      module Headers
+        # Parser provides easy access and validation methods for Rack headers
+        class Parser
+          def initialize(env)
+            @env = env
+          end
+
+          # TODO: Don't assume Rack format.
+          #       Make distributed tracing headers apathetic.
+          def header(name)
+            rack_header = "http-#{name}".upcase!.tr('-', '_')
+
+            hdr = @env[rack_header]
+
+            # Only return the value if it is not an empty string
+            hdr if hdr != ''
+          end
+
+          def id(hdr, base = 10)
+            Helpers.value_to_id(header(hdr), base)
+          end
+
+          def number(hdr, base = 10)
+            Helpers.value_to_number(header(hdr), base)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'datadog/core/configuration'
-require 'datadog/tracing/sampling/ext'
+require_relative '../../core/configuration'
+require_relative '../sampling/ext'
 
 module Datadog
   module Tracing
@@ -38,6 +38,40 @@ module Datadog
           #      or we find the first non-zero, this allows `'0000' -> '0'` and `'00001' -> '1'`
           value.sub(/^0*(?=(0$)|[^0])/, '')
         end
+
+        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 > Span::EXTERNAL_MAX_ID
+
+          id < 0 ? id + (2**64) : id
+        end
+
+        def self.value_to_number(value, base = 10)
+          # It's important to make a difference between no header,
+          # and a header defined to 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
+
+          # Convert header to an integer
+          # DEV: Ruby `.to_i` will return `0` if a number could not be parsed
+          num = value.to_i(base)
+
+          # 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
+
+          num
+        end
       end
     end
   end

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

@@ -0,0 +1,55 @@
+# typed: true
+
+require_relative '../helpers'
+require_relative 'parser'
+require_relative '../headers/ext'
+require_relative '../../trace_digest'
+
+module Datadog
+  module Tracing
+    module Distributed
+      module Metadata
+        # B3 provides helpers to inject or extract metadata for B3 style headers
+        module B3
+          include Distributed::Headers::Ext
+
+          def self.inject!(digest, metadata)
+            return if digest.nil?
+
+            # DEV: We need these to be hex encoded
+            metadata[B3_HEADER_TRACE_ID] = digest.trace_id.to_s(16)
+            metadata[B3_HEADER_SPAN_ID] = digest.span_id.to_s(16)
+
+            if digest.trace_sampling_priority
+              sampling_priority = Helpers.clamp_sampling_priority(
+                digest.trace_sampling_priority
+              )
+              metadata[B3_HEADER_SAMPLED] = sampling_priority.to_s
+            end
+
+            metadata
+          end
+
+          def self.extract(metadata)
+            # Extract values from gRPC metadata
+            # DEV: B3 doesn't have "origin"
+            metadata = Parser.new(metadata)
+            trace_id = metadata.id(B3_HEADER_TRACE_ID, 16)
+            span_id = metadata.id(B3_HEADER_SPAN_ID, 16)
+            # We don't need to try and convert sampled since B3 supports 0/1 (AUTO_REJECT/AUTO_KEEP)
+            sampling_priority = metadata.number(B3_HEADER_SAMPLED)
+
+            # Return early if this propagation is not valid
+            return unless trace_id && span_id
+
+            TraceDigest.new(
+              trace_id: trace_id,
+              span_id: span_id,
+              trace_sampling_priority: sampling_priority
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# typed: true
+
+require_relative 'parser'
+require_relative '../helpers'
+require_relative '../headers/ext'
+require_relative '../../trace_digest'
+
+module Datadog
+  module Tracing
+    module Distributed
+      module Metadata
+        # B3Single provides helpers to inject or extract metadata for B3 single header style headers
+        module B3Single
+          include Distributed::Headers::Ext
+
+          def self.inject!(digest, metadata)
+            return if digest.nil?
+
+            # Header format:
+            #   b3: {TraceId}-{SpanId}-{SamplingState}-{ParentSpanId}
+            # https://github.com/apache/incubator-zipkin-b3-propagation/tree/7c6e9f14d6627832bd80baa87ac7dabee7be23cf#single-header
+            # DEV: `{SamplingState}` and `{ParentSpanId`}` are optional
+
+            # DEV: We need these to be hex encoded
+            b3_header = "#{digest.trace_id.to_s(16)}-#{digest.span_id.to_s(16)}"
+
+            if digest.trace_sampling_priority
+              sampling_priority = Helpers.clamp_sampling_priority(
+                digest.trace_sampling_priority
+              )
+              b3_header += "-#{sampling_priority}"
+            end
+
+            metadata[B3_HEADER_SINGLE] = b3_header
+
+            metadata
+          end
+
+          def self.extract(metadata)
+            # Metadata format:
+            #   b3: {TraceId}-{SpanId}-{SamplingState}-{ParentSpanId}
+            # https://github.com/apache/incubator-zipkin-b3-propagation/tree/7c6e9f14d6627832bd80baa87ac7dabee7be23cf#single-header
+            # DEV: `{SamplingState}` and `{ParentSpanId`}` are optional
+
+            b3_single = Parser.new(metadata).metadata_for_key(B3_HEADER_SINGLE)
+            return if b3_single.nil?
+
+            parts = b3_single.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
+
+            # Return early if this propagation is not valid
+            return unless trace_id && span_id
+
+            TraceDigest.new(
+              span_id: span_id,
+              trace_id: trace_id,
+              trace_sampling_priority: sampling_priority
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+require_relative '../headers/ext'
+require_relative 'parser'
+
+module Datadog
+  module Tracing
+    module Distributed
+      module Metadata
+        # Datadog provides helpers to inject or extract metadata for Datadog style headers
+        class Datadog
+          include Distributed::Headers::Ext
+
+          def self.inject!(digest, metadata)
+            return if digest.nil?
+
+            metadata[GRPC_METADATA_TRACE_ID] = digest.trace_id.to_s
+            metadata[GRPC_METADATA_PARENT_ID] = digest.span_id.to_s
+            if digest.trace_sampling_priority
+              metadata[GRPC_METADATA_SAMPLING_PRIORITY] =
+                digest.trace_sampling_priority.to_s
+            end
+            metadata[GRPC_METADATA_ORIGIN] = digest.trace_origin.to_s if digest.trace_origin
+
+            metadata
+          end
+
+          def self.extract(metadata)
+            carrier = Carrier.new(metadata)
+
+            return nil unless carrier.valid?
+
+            TraceDigest.new(
+              span_id: carrier.parent_id,
+              trace_id: carrier.trace_id,
+              trace_origin: carrier.origin,
+              trace_sampling_priority: carrier.sampling_priority
+            )
+          end
+
+          # opentracing.io compliant carrier object
+          class Carrier
+            include Distributed::Headers::Ext
+
+            def initialize(metadata = {})
+              @metadata = Parser.new(metadata || {})
+            end
+
+            def valid?
+              (trace_id && parent_id) || (origin && trace_id)
+            end
+
+            def trace_id
+              @metadata.id(GRPC_METADATA_TRACE_ID)
+            end
+
+            def parent_id
+              @metadata.id(GRPC_METADATA_PARENT_ID)
+            end
+
+            def sampling_priority
+              value = @metadata.metadata_for_key(GRPC_METADATA_SAMPLING_PRIORITY)
+              value && value.to_i
+            end
+
+            def origin
+              value = @metadata.metadata_for_key(GRPC_METADATA_ORIGIN)
+              value if value != ''
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require_relative '../helpers'
+
+module Datadog
+  module Tracing
+    module Distributed
+      module Metadata
+        # Parser provides easy access and validation methods for metadata headers
+        class Parser
+          def initialize(metadata)
+            @metadata = metadata
+          end
+
+          def id(key, base = 10)
+            Helpers.value_to_id(metadata_for_key(key), base)
+          end
+
+          def number(key, base = 10)
+            Helpers.value_to_number(metadata_for_key(key), base)
+          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
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/event.rb

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

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

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'datadog/tracing/analytics'
-require 'datadog/tracing/metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
 
 module Datadog
   module Tracing

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

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/core/error'
+require_relative '../../core/error'
 
-require 'datadog/tracing/metadata/ext'
+require_relative 'ext'
 
 module Datadog
   module Tracing

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

@@ -20,6 +20,11 @@ module Datadog
         # Name of external service that performed the work
         TAG_PEER_SERVICE = 'peer.service'
 
+        TAG_KIND = 'span.kind'
+
+        # Set this tag to `1.0` if the span is a Service Entry span.
+        TAG_TOP_LEVEL = '_dd.top_level'
+
         # Defines constants for trace analytics
         # @public_api
         module Analytics
@@ -123,6 +128,8 @@ module Datadog
           TAG_HOSTNAME = '_dd.hostname'
           TAG_TARGET_HOST = 'out.host'
           TAG_TARGET_PORT = 'out.port'
+          TAG_DESTINATION_NAME = 'network.destination.name'
+          TAG_DESTINATION_PORT = 'network.destination.port'
         end
 
         # @public_api
@@ -145,6 +152,24 @@ module Datadog
           TYPE = 'sql'
           TAG_QUERY = 'sql.query'
         end
+
+        # @public_api
+        module DB
+          TAG_INSTANCE = 'db.instance'
+          TAG_USER = 'db.user'
+          TAG_SYSTEM = 'db.system'
+          TAG_STATEMENT = 'db.statement'
+          TAG_ROW_COUNT = 'db.row_count'
+        end
+
+        # @public_api
+        module SpanKind
+          TAG_SERVER = 'server'
+          TAG_CLIENT = 'client'
+          TAG_PRODUCER = 'producer'
+          TAG_CONSUMER = 'consumer'
+          TAG_INTERNAL = 'internal'
+        end
       end
     end
   end

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

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/core/environment/ext'
+require_relative '../../core/environment/ext'
 
-require 'datadog/tracing/metadata/ext'
+require_relative 'ext'
 
 module Datadog
   module Tracing
@@ -70,6 +70,12 @@ module Datadog
           meta.delete(key)
         end
 
+        # Convenient interface for setting a single tag.
+        alias []= set_tag
+
+        # Convenient interface for getting a single tag.
+        alias [] get_tag
+
         # Return the metric with the given key, nil if it doesn't exist.
         def get_metric(key)
           metrics[key] || meta[key]

data/lib/datadog/tracing/metadata.rb

@@ -1,8 +1,8 @@
 # typed: true
 
-require 'datadog/tracing/metadata/analytics'
-require 'datadog/tracing/metadata/tagging'
-require 'datadog/tracing/metadata/errors'
+require_relative 'metadata/analytics'
+require_relative 'metadata/tagging'
+require_relative 'metadata/errors'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,7 @@
 # typed: true
 
 require 'set'
-require 'datadog/tracing/pipeline/span_processor'
+require_relative 'span_processor'
 
 module Datadog
   module Tracing
@@ -15,17 +15,21 @@ module Datadog
       #
       # @public_api
       class SpanFilter < SpanProcessor
-        # NOTE: this SpanFilter implementation only handles traces in which child spans appear
-        # after parent spans in the trace array. If in the future child spans can be before
+        # NOTE: This SpanFilter implementation only handles traces in which child spans appear
+        # before parent spans in the trace array. If in the future child spans can be after
         # parent spans, then the code below will need to be updated.
         # @!visibility private
         def call(trace)
           deleted = Set.new
 
-          trace.spans.delete_if do |span|
+          span_count = trace.spans.length
+          trace.spans.reverse_each.with_index do |span, i|
             should_delete = deleted.include?(span.parent_id) || drop_it?(span)
-            deleted << span.id if should_delete
-            should_delete
+
+            if should_delete
+              deleted << span.id
+              trace.spans.delete_at(span_count - 1 - i)
+            end
           end
 
           trace