ddtrace 1.4.2 → 1.23.3

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../patcher'
 

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

@@ -0,0 +1,55 @@
+# 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'
+          PEER_SERVICE_SOURCES = Array[TAG_INSTANCE,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+        end
+
+        module RPC
+          TAG_SYSTEM = 'rpc.system'
+          TAG_SERVICE = 'rpc.service'
+          TAG_METHOD = 'rpc.method'
+          PEER_SERVICE_SOURCES = Array[TAG_SERVICE,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+          module GRPC
+            TAG_STATUS_CODE = 'rpc.grpc.status_code'
+            TAG_FULL_METHOD = 'rpc.grpc.full_method'
+          end
+        end
+
+        module Messaging
+          TAG_SYSTEM = 'messaging.system'
+          PEER_SERVICE_SOURCES = Array[Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+        end
+
+        module Metadata
+          # Name of tag from which where peer.service information was extracted from
+          TAG_PEER_SERVICE_SOURCE = '_dd.peer.service.source'
+
+          # Value of tag from which peer.service value was remapped from
+          TAG_PEER_SERVICE_REMAP = '_dd.peer.service.remapped_from'
+
+          # Set equal to the global service when contrib span.service is overriden
+          TAG_BASE_SERVICE = '_dd.base_service'
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require 'set'
 
 require_relative '../../core/configuration/settings'
@@ -110,6 +108,38 @@ module Datadog
           module Settings
             InvalidIntegrationError = Class.new(StandardError)
 
+            def self.included(base)
+              base.class_eval do
+                settings :contrib do
+                  # Key-value map for explicitly re-mapping peer.service values
+                  #
+                  # @default `DD_TRACE_PEER_SERVICE_MAPPING` environment variable converted to hash
+                  # @return [Hash]
+                  option :peer_service_mapping do |o|
+                    o.env Tracing::Configuration::Ext::SpanAttributeSchema::ENV_PEER_SERVICE_MAPPING
+                    o.type :hash
+                    o.default({})
+                  end
+
+                  # Global service name behavior
+                  settings :global_default_service_name do
+                    # Overrides default service name to global service name
+                    #
+                    # Allows for usage of v1 service name changes without
+                    # being forced to update schema versions
+                    #
+                    # @default `DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED` environment variable, otherwise `false`
+                    # @return [Boolean]
+                    option :enabled do |o|
+                      o.env Tracing::Configuration::Ext::SpanAttributeSchema::ENV_GLOBAL_DEFAULT_SERVICE_NAME_ENABLED
+                      o.type :bool
+                      o.default false
+                    end
+                  end
+                end
+              end
+            end
+
             # Applies instrumentation for the provided `integration_name`.
             #
             # Options may be provided, that are specific to that instrumentation.
@@ -138,8 +168,12 @@ module Datadog
               integration
             end
 
-            # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
-            alias_method :use, :instrument
+            def use(integration_name, options = {}, &block)
+              Core.log_deprecation do
+                'Configuration with `use` has been deprecated, use `instrument` instead.'
+              end
+              instrument(integration_name, options, &block)
+            end
 
             # For the provided `integration_name`, resolves a matching configuration
             # for the provided integration from an integration-specific `key`.

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../../configuration/settings'
 require_relative '../ext'
@@ -16,24 +16,50 @@ module Datadog
             end
 
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
-            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 :distributed_tracing, default: true, type: :bool
+
+            option :error_handler do |o|
+              o.type :proc
+              o.default_proc(&DEFAULT_ERROR_HANDLER)
+            end
+
+            option :on_error do |o|
+              o.type :proc, nilable: true
+            end
+
+            option :split_by_domain, default: false, type: :bool
+
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
           end
         end
       end

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

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

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Tracing
@@ -7,13 +7,21 @@ module Datadog
         # Faraday integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'.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
-          SPAN_REQUEST = 'faraday.request'.freeze
-          TAG_COMPONENT = 'faraday'.freeze
-          TAG_OPERATION_REQUEST = 'request'.freeze
+          ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'
+          ENV_SERVICE_NAME = 'DD_TRACE_FARADAY_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_FARADAY_PEER_SERVICE'
+
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'faraday'
+          SPAN_REQUEST = 'faraday.request'
+          TAG_COMPONENT = 'faraday'
+          TAG_OPERATION_REQUEST = 'request'
+          PEER_SERVICE_SOURCES = Array[
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
         end
       end
     end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../integration'
 require_relative '../configuration/resolvers/pattern_resolver'
 require_relative 'configuration/settings'

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

@@ -1,5 +1,3 @@
-# typed: ignore
-
 require 'faraday'
 
 require_relative '../../metadata/ext'
@@ -26,7 +24,7 @@ module Datadog
             # Do this once to reduce expensive regex calls.
             request_options = build_request_options!(env)
 
-            Tracing.trace(Ext::SPAN_REQUEST) do |span, trace|
+            Tracing.trace(Ext::SPAN_REQUEST, on_error: request_options[:on_error]) do |span, trace|
               annotate!(span, env, request_options)
               propagate!(trace, span, env) if request_options[:distributed_tracing] && Tracing.enabled?
               app.call(env).on_complete { |resp| handle_response(span, resp, request_options) }
@@ -39,15 +37,26 @@ 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
 
+            if options[:peer_service]
+              span.set_tag(
+                Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                options[:peer_service]
+              )
+            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)
             span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 
-            # Tag as an external peer service
-            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
             span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, env[:url].host)
 
             # Set analytics sample rate
@@ -59,12 +68,21 @@ module Datadog
             span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, env[:method].to_s.upcase)
             span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, env[:url].host)
             span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, env[:url].port)
+            span.set_tags(
+              Datadog.configuration.tracing.header_tags.request_tags(env[:request_headers])
+            )
+
+            Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
           end
 
           def handle_response(span, env, options)
             span.set_error(["Error #{env[:status]}", env[:body]]) if options.fetch(:error_handler).call(env)
 
             span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, env[:status])
+
+            span.set_tags(
+              Datadog.configuration.tracing.header_tags.response_tags(env[:response_headers])
+            )
           end
 
           def propagate!(trace, span, env)

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative 'connection'
 require_relative 'ext'
 require_relative 'rack_builder'

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

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

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../../configuration/settings'
 require_relative '../ext'
@@ -13,18 +13,21 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
-              o.lazy
+              o.type :bool, nilable: true
+              o.env Ext::ENV_ANALYTICS_ENABLED
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
             option :service_name

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../../../core'
 require_relative '../../metadata/ext'
 require_relative '../analytics'
@@ -9,7 +7,6 @@ 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
@@ -245,7 +242,6 @@ module Datadog
             end
           end
         end
-        # rubocop:enable Metrics/ModuleLength
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Tracing
@@ -7,20 +7,21 @@ module Datadog
         # Grape integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_GRAPE_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'.freeze
-          SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'.freeze
-          SPAN_ENDPOINT_RUN = 'grape.endpoint_run'.freeze
-          SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'.freeze
-          TAG_COMPONENT = 'grape'.freeze
-          TAG_FILTER_TYPE = 'grape.filter.type'.freeze
-          TAG_OPERATION_ENDPOINT_RENDER = 'endpoint_render'.freeze
-          TAG_OPERATION_ENDPOINT_RUN = 'endpoint_run'.freeze
-          TAG_OPERATION_ENDPOINT_RUN_FILTERS = 'endpoint_run_filters'.freeze
-          TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
-          TAG_ROUTE_PATH = 'grape.route.path'.freeze
-          TAG_ROUTE_METHOD = 'grape.route.method'.freeze
+          ENV_ENABLED = 'DD_TRACE_GRAPE_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'
+          SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'
+          SPAN_ENDPOINT_RUN = 'grape.endpoint_run'
+          SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'
+          TAG_COMPONENT = 'grape'
+          TAG_FILTER_TYPE = 'grape.filter.type'
+          TAG_OPERATION_ENDPOINT_RENDER = 'endpoint_render'
+          TAG_OPERATION_ENDPOINT_RUN = 'endpoint_run'
+          TAG_OPERATION_ENDPOINT_RUN_FILTERS = 'endpoint_run_filters'
+          TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'
+          TAG_ROUTE_PATH = 'grape.route.path'
+          TAG_ROUTE_METHOD = 'grape.route.method'
         end
       end
     end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 module Datadog
   module Tracing
     module Contrib

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../integration'
 require_relative 'configuration/settings'
 require_relative 'patcher'

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 require_relative 'endpoint'
 require_relative 'ext'

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../../configuration/settings'
 require_relative '../ext'
@@ -12,22 +12,25 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
-              o.lazy
+              o.type :bool, nilable: true
+              o.env Ext::ENV_ANALYTICS_ENABLED
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
             option :schemas
-            option :service_nam
+            option :service_name
           end
         end
       end

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

@@ -1,4 +1,4 @@
-# typed: true
+# frozen_string_literal: true
 
 module Datadog
   module Tracing
@@ -7,11 +7,12 @@ module Datadog
         # GraphQL integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'.freeze
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'.freeze
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'.freeze
-          SERVICE_NAME = 'graphql'.freeze
-          TAG_COMPONENT = 'graphql'.freeze
+          ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'
+          SERVICE_NAME = 'graphql'
+          TAG_COMPONENT = 'graphql'
         end
       end
     end

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../integration'
 require_relative 'configuration/settings'
 require_relative 'patcher'

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

@@ -1,5 +1,3 @@
-# typed: false
-
 require_relative '../analytics'
 require_relative '../patcher'
 

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

@@ -1,4 +1,4 @@
-# typed: false
+# frozen_string_literal: true
 
 require_relative '../../../span_operation'
 require_relative '../../configuration/settings'
@@ -13,23 +13,64 @@ module Datadog
           # @public_api
           class Settings < Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
+            # @!visibility private
             option :analytics_enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
             end
 
             option :analytics_sample_rate do |o|
-              o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
-              o.lazy
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
             end
 
-            option :distributed_tracing, default: true
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
-            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :distributed_tracing, default: true, type: :bool
+
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :error_handler do |o|
+              o.type :proc
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+              o.after_set do |value|
+                if value != Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+                  Datadog.logger.warn(
+                    'The gRPC `error_handler` setting has been deprecated for removal. Please replace ' \
+                    'it with `server_error_handler` which is explicit about only handling errors from ' \
+                    'server interceptors. Alternatively, to handle errors from client interceptors use ' \
+                    'the `client_error_handler` setting instead.'
+                  )
+                end
+              end
+            end
+
+            option :server_error_handler do |o|
+              o.type :proc
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+            end
+
+            option :client_error_handler do |o|
+              o.type :proc
+              o.default_proc(&Tracing::SpanOperation::Events::DEFAULT_ON_ERROR)
+            end
           end
         end
       end