ddtrace 1.0.0 → 1.9.0

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

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/excon/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -28,8 +28,12 @@ module Datadog
 
             option :distributed_tracing, default: true
             option :error_handler
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
             option :split_by_domain, default: false
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/excon/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_EXCON_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_EXCON_SERVICE_NAME'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_EXCON_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_EXCON_ANALYTICS_SAMPLE_RATE'.freeze
           DEFAULT_PEER_SERVICE_NAME = 'excon'.freeze

data/lib/datadog/tracing/contrib/excon/integration.rb

@@ -1,9 +1,9 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/excon/configuration/settings'
-require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'
-require 'datadog/tracing/contrib/excon/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/excon/middleware.rb

@@ -2,13 +2,12 @@
 
 require 'excon'
 
-require 'datadog/core'
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/propagation/http'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/excon/ext'
-require 'datadog/tracing/contrib/http_annotation_helper'
+require_relative '../../../core'
+require_relative '../../metadata/ext'
+require_relative '../../propagation/http'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../http_annotation_helper'
 
 module Datadog
   module Tracing
@@ -117,6 +116,8 @@ module Datadog
             span.service = service_name(datum[:host], @options)
             span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
 
+            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)
             span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 

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

@@ -1,6 +1,6 @@
 # typed: false
 
-require 'datadog/tracing/contrib/patcher'
+require_relative '../patcher'
 
 module Datadog
   module Tracing
@@ -17,7 +17,7 @@ module Datadog
           end
 
           def patch
-            require 'datadog/tracing/contrib/excon/middleware'
+            require_relative 'middleware'
             add_middleware
           end
 

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Contrib specific constants
+      module Ext
+        # @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
+
+        module RPC
+          TAG_SYSTEM = 'rpc.system'
+          TAG_SERVICE = 'rpc.service'
+          TAG_METHOD = 'rpc.method'
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/extensions.rb

@@ -1,10 +1,8 @@
 # typed: false
 
-require 'forwardable'
 require 'set'
 
-require 'datadog/core/configuration/settings'
-require 'datadog/tracing/contrib'
+require_relative '../../core/configuration/settings'
 
 # Datadog
 module Datadog
@@ -88,8 +86,8 @@ module Datadog
                 # if patching failed, only log output if verbosity is unset
                 # or if patching failure is due to compatibility or integration specific reasons
                 next unless !ignore_integration_load_errors ||
-                            ((patch_results[:available] && patch_results[:loaded]) &&
-                            (!patch_results[:compatible] || !patch_results[:patchable]))
+                  ((patch_results[:available] && patch_results[:loaded]) &&
+                  (!patch_results[:compatible] || !patch_results[:patchable]))
 
                 desc = "Available?: #{patch_results[:available]}"
                 desc += ", Loaded? #{patch_results[:loaded]}"
@@ -99,6 +97,8 @@ module Datadog
                 Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
               end
 
+              components.telemetry.integrations_change! if configuration.integrations_pending_activation
+
               configuration.integrations_pending_activation.clear
             end
 

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

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/faraday/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -32,8 +32,12 @@ module Datadog
 
             option :distributed_tracing, default: true
             option :error_handler, default: DEFAULT_ERROR_HANDLER
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
             option :split_by_domain, default: false
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
           end
         end
       end

data/lib/datadog/tracing/contrib/faraday/ext.rb

@@ -8,6 +8,7 @@ module Datadog
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
           ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_FARADAY_SERVICE_NAME'.freeze
           ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'.freeze
           ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
           DEFAULT_PEER_SERVICE_NAME = 'faraday'.freeze

data/lib/datadog/tracing/contrib/faraday/integration.rb

@@ -1,9 +1,9 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'
-require 'datadog/tracing/contrib/faraday/configuration/settings'
-require 'datadog/tracing/contrib/faraday/patcher'
+require_relative '../integration'
+require_relative '../configuration/resolvers/pattern_resolver'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -2,12 +2,11 @@
 
 require 'faraday'
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/propagation/http'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/faraday/ext'
-require 'datadog/tracing/contrib/http_annotation_helper'
+require_relative '../../metadata/ext'
+require_relative '../../propagation/http'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative '../http_annotation_helper'
 
 module Datadog
   module Tracing
@@ -40,10 +39,11 @@ module Datadog
 
           def annotate!(span, env, options)
             span.resource = resource_name(env)
-            service_name(env[:url].host, options)
-            span.service = options[:split_by_domain] ? env[:url].host : options[:service_name]
+            span.service = service_name(env[:url].host, options)
             span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
 
+            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)
             span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 

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

@@ -1,10 +1,9 @@
 # typed: false
 
-require 'datadog/tracing/contrib/faraday/connection'
-require 'datadog/tracing/contrib/faraday/ext'
-require 'datadog/tracing/contrib/faraday/integration'
-require 'datadog/tracing/contrib/faraday/rack_builder'
-require 'datadog/tracing/contrib/patcher'
+require_relative 'connection'
+require_relative 'ext'
+require_relative 'rack_builder'
+require_relative '../patcher'
 
 module Datadog
   module Tracing
@@ -21,7 +20,7 @@ module Datadog
           end
 
           def patch
-            require 'datadog/tracing/contrib/faraday/middleware'
+            require_relative 'middleware'
 
             register_middleware!
             add_default_middleware!

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

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/grape/ext'
-require 'datadog/tracing/contrib/status_code_matcher'
+require_relative '../../configuration/settings'
+require_relative '../ext'
+require_relative '../../status_code_matcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/grape/endpoint.rb

@@ -1,16 +1,14 @@
 # typed: false
 
-require 'datadog/core'
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/rack/ext'
+require_relative '../../../core'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../rack/ext'
 
 module Datadog
   module Tracing
     module Contrib
       module Grape
-        # rubocop:disable Metrics/ModuleLength
         # Endpoint module includes a list of subscribers to create
         # traces when a Grape endpoint is hit
         module Endpoint
@@ -246,7 +244,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

data/lib/datadog/tracing/contrib/grape/integration.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/grape/configuration/settings'
-require 'datadog/tracing/contrib/grape/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,10 +1,9 @@
 # typed: true
 
-require 'datadog/tracing/contrib/grape/endpoint'
-require 'datadog/tracing/contrib/grape/ext'
-require 'datadog/tracing/contrib/grape/instrumentation'
-require 'datadog/tracing/contrib/grape/integration'
-require 'datadog/tracing/contrib/patcher'
+require_relative 'endpoint'
+require_relative 'ext'
+require_relative 'instrumentation'
+require_relative '../patcher'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/graphql/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -27,7 +27,7 @@ module Datadog
             end
 
             option :schemas
-            option :service_nam
+            option :service_name
           end
         end
       end

data/lib/datadog/tracing/contrib/graphql/integration.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/graphql/configuration/settings'
-require 'datadog/tracing/contrib/graphql/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

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

@@ -1,9 +1,7 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/graphql/integration'
-require 'datadog/tracing/contrib/patcher'
+require_relative '../analytics'
+require_relative '../patcher'
 
 module Datadog
   module Tracing

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

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -27,7 +27,13 @@ module Datadog
               o.lazy
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :distributed_tracing, default: true
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+
             option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/client.rb

@@ -1,9 +1,11 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -36,6 +38,10 @@ module Datadog
             def annotate!(trace, span, metadata, call)
               span.set_tags(metadata)
 
+              span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+
+              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)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_CLIENT)
 
@@ -44,10 +50,13 @@ module Datadog
               host, _port = find_host_port(call)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
 
+              deadline = find_deadline(call)
+              span.set_tag(Ext::TAG_CLIENT_DEADLINE, deadline) if deadline
+
               # Set analytics sample rate
               Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
-              Tracing::Propagation::GRPC.inject!(trace, metadata)
+              Distributed::Propagation::INSTANCE.inject!(trace, metadata) if distributed_tracing?
             rescue StandardError => e
               Datadog.logger.debug("GRPC client trace failed: #{e}")
             end
@@ -60,6 +69,12 @@ module Datadog
                 .join('.')
             end
 
+            def find_deadline(call)
+              return unless call.respond_to?(:deadline) && call.deadline.is_a?(Time)
+
+              call.deadline.utc.iso8601(3)
+            end
+
             def find_host_port(call)
               return unless call
 

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/server.rb

@@ -1,11 +1,11 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/propagation/grpc'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -19,10 +19,11 @@ module Datadog
           # its tracing context with a parent client-side context
           class Server < Base
             def trace(keywords)
+              method = keywords[:method]
               options = {
                 span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
                 service: service_name, # TODO: Remove server-side service name configuration
-                resource: format_resource(keywords[:method]),
+                resource: format_resource(method),
                 on_error: error_handler
               }
               metadata = keywords[:call].metadata
@@ -30,6 +31,10 @@ module Datadog
               set_distributed_context!(metadata)
 
               Tracing.trace(Ext::SPAN_SERVICE, **options) do |span|
+                span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+                span.set_tag(Contrib::Ext::RPC::TAG_SERVICE, method.owner.to_s)
+                span.set_tag(Contrib::Ext::RPC::TAG_METHOD,  method.name)
+
                 annotate!(span, metadata)
 
                 yield
@@ -39,7 +44,7 @@ module Datadog
             private
 
             def set_distributed_context!(metadata)
-              Tracing.continue_trace!(Tracing::Propagation::GRPC.extract(metadata))
+              Tracing.continue_trace!(Distributed::Propagation::INSTANCE.extract(metadata))
             rescue StandardError => e
               Datadog.logger.debug(
                 "unable to propagate GRPC metadata to context: #{e}"
@@ -48,11 +53,14 @@ module Datadog
 
             def annotate!(span, metadata)
               metadata.each do |header, value|
-                next if reserved_headers.include?(header)
+                # Datadog propagation headers are considered internal implementation detail.
+                next if header.to_s.start_with?(Tracing::Distributed::Datadog::TAGS_PREFIX)
 
                 span.set_tag(header, value)
               end
 
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_SERVER)
+
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERVICE)
 
@@ -65,14 +73,6 @@ module Datadog
               Datadog.logger.debug("GRPC client trace failed: #{e}")
             end
 
-            def reserved_headers
-              [
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_TRACE_ID,
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_PARENT_ID,
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_SAMPLING_PRIORITY
-              ]
-            end
-
             def format_resource(proto_method)
               proto_method
                 .owner

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor.rb

@@ -1,9 +1,8 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
-require 'datadog/tracing/contrib/grpc/configuration/settings'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative 'configuration/settings'
 
 module Datadog
   module Tracing
@@ -53,6 +52,10 @@ module Datadog
               Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
             end
 
+            def distributed_tracing?
+              Datadog.configuration_for(self, :distributed_tracing) || datadog_configuration[:distributed_tracing]
+            end
+
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: true
+
+require_relative '../../../distributed/fetcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Distributed
+          # Retrieves values from the gRPC metadata.
+          # One metadata key can be associated with multiple values.
+          #
+          # @see https://github.com/grpc/grpc-go/blob/56ac86fa0f3940cb79946ce2c6e56f7ee7ecae84/Documentation/grpc-metadata.md#constructing-metadata
+          class Fetcher < Tracing::Distributed::Fetcher
+            def [](key)
+              # Metadata values are normally integrals but can also be
+              # arrays when multiple values are associated with the same key.
+              value = super(key)
+              value.is_a?(::Array) ? value[0] : value
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: true
+
+require_relative 'fetcher'
+require_relative '../../../distributed/b3_multi'
+require_relative '../../../distributed/b3_single'
+require_relative '../../../distributed/datadog'
+require_relative '../../../distributed/none'
+require_relative '../../../distributed/propagation'
+require_relative '../../../distributed/trace_context'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Distributed
+          # Extracts and injects propagation through gRPC metadata.
+          # @see https://github.com/grpc/grpc-go/blob/v1.50.1/Documentation/grpc-metadata.md
+          class Propagation < Tracing::Distributed::Propagation
+            def initialize
+              super(
+                propagation_styles: {
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER =>
+                    Tracing::Distributed::B3Multi.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER =>
+                    Tracing::Distributed::B3Single.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG =>
+                    Tracing::Distributed::Datadog.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_TRACE_CONTEXT =>
+                    Tracing::Distributed::TraceContext.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_NONE => Tracing::Distributed::None.new
+                })
+            end
+
+            # DEV: Singleton kept until a larger refactor is performed.
+            # DEV: See {Datadog::Tracing::Distributed::Propagation#initialize} for more information.
+            INSTANCE = Propagation.new
+          end
+        end
+      end
+    end
+  end
+end