ddtrace 0.42.0 → 0.54.2

data/lib/ddtrace/contrib/extensions.rb

@@ -1,21 +1,35 @@
+# typed: false
 require 'set'
-require 'ddtrace/contrib/registry'
+require 'datadog/contrib'
+require 'ddtrace/configuration/settings'
 
 module Datadog
   module Contrib
     # Extensions that can be added to the base library
     # Adds registry, configuration access for integrations.
+    #
+    # DEV: The Registry should probably be part of the core tracer
+    # as it represents a global tracer repository that is strongly intertwined
+    # with the tracer lifecycle and deeply modifies the tracer initialization
+    # process.
+    # Most of this file should probably live inside the tracer core.
     module Extensions
       def self.extended(base)
-        Datadog.send(:extend, Helpers)
-        Datadog.send(:extend, Configuration)
-        Datadog::Configuration::Settings.send(:include, Configuration::Settings)
+        base.extend(Helpers)
+        base.extend(Configuration)
       end
 
       # Helper methods for Datadog module.
       module Helpers
+        # Returns the global integration registry.
+        #
+        # This method is not safe to use while the tracer is initializing,
+        # thus access to the registry should go through
+        # ::Datadog::Contrib::REGISTRY for internal tracer work.
+        #
+        # External use of this method is always safe.
         def registry
-          configuration.registry
+          Contrib::REGISTRY
         end
       end
 
@@ -27,8 +41,27 @@ module Datadog
 
           # Activate integrations
           if target.respond_to?(:integrations_pending_activation)
+            reduce_verbosity = target.respond_to?(:reduce_verbosity?) ? target.reduce_verbosity? : false
             target.integrations_pending_activation.each do |integration|
-              integration.patch if integration.respond_to?(:patch)
+              next unless integration.respond_to?(:patch)
+
+              # integration.patch returns either true or a hash of details on why patching failed
+              patch_results = integration.patch
+
+              next if patch_results == true
+
+              # if patching failed, only log output if verbosity is unset
+              # or if patching failure is due to compatibility or integration specific reasons
+              next unless !reduce_verbosity ||
+                          ((patch_results[:available] && patch_results[:loaded]) &&
+                           (!patch_results[:compatible] || !patch_results[:patchable]))
+
+              desc = "Available?: #{patch_results[:available]}"
+              desc += ", Loaded? #{patch_results[:loaded]}"
+              desc += ", Compatible? #{patch_results[:compatible]}"
+              desc += ", Patchable? #{patch_results[:patchable]}"
+
+              Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
             end
 
             target.integrations_pending_activation.clear
@@ -41,16 +74,51 @@ module Datadog
         module Settings
           InvalidIntegrationError = Class.new(StandardError)
 
-          def self.included(base)
-            # Add the additional options to the global configuration settings
-            base.instance_eval do
-              option :registry, default: Registry.new
-            end
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated Use `Datadog.registry` instead
+          def registry
+            Datadog.logger.warn('Deprecated access to `Datadog.configuration.registry`, use `Datadog.registry` instead.' \
+                                '`Datadog.configuration.registry` will be removed in a future version.')
+            Contrib::REGISTRY
+          end
+
+          # The registry only holds declarative constant values and cannot be modified.
+          # This option is a no-op and will be removed in the future.
+          #
+          # @deprecated The registry is now a global constant, and can't be overwritten.
+          def registry=(_arg)
+            Datadog.logger.warn('Setting a custom registry is no longer supported and was ignored. ' \
+                                'Remove this assignment from your configuration to stop seeing this warning.')
           end
 
-          def [](integration_name, configuration_name = :default)
+          # For the provided `integration_name`, resolves a matching configuration
+          # for the provided integration from an integration-specific `key`.
+          #
+          # How the matching is performed is integration-specific.
+          #
+          # @param [Symbol] integration_name the integration name
+          # @param [Object] key the integration-specific lookup key
+          # @return [Datadog::Contrib::Configuration::Settings]
+          def [](integration_name, key = :default)
             integration = fetch_integration(integration_name)
-            integration.configuration(configuration_name) unless integration.nil?
+            integration.resolve(key) unless integration.nil?
+          end
+
+          # For the provided `integration_name`, retrieves a configuration previously
+          # stored by `#instrument`. Specifically, `describes` should be
+          # the same value provided in the `describes:` option for `#instrument`.
+          #
+          # If no `describes` value is provided, the default configuration is returned.
+          #
+          # @param [Symbol] integration_name the integration name
+          # @param [Object] describes the previously configured `describes:` object. If `nil`,
+          #   fetches the default configuration
+          # @return [Datadog::Contrib::Configuration::Settings]
+          def configuration(integration_name, describes = nil)
+            integration = fetch_integration(integration_name)
+            integration.configuration(describes) unless integration.nil?
           end
 
           def instrument(integration_name, options = {}, &block)
@@ -83,9 +151,17 @@ module Datadog
           end
 
           def fetch_integration(name)
-            registry[name] ||
+            Contrib::REGISTRY[name] ||
               raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
           end
+
+          def reduce_verbosity?
+            defined?(@reduce_verbosity) ? @reduce_verbosity : false
+          end
+
+          def reduce_log_verbosity
+            @reduce_verbosity ||= true
+          end
         end
       end
     end

data/lib/ddtrace/contrib/faraday/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/faraday/ext'

data/lib/ddtrace/contrib/faraday/connection.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module Faraday

data/lib/ddtrace/contrib/faraday/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Faraday

data/lib/ddtrace/contrib/faraday/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
 require 'ddtrace/contrib/faraday/configuration/settings'

data/lib/ddtrace/contrib/faraday/middleware.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'faraday'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/integration'
@@ -57,9 +58,7 @@ module Datadog
         end
 
         def handle_response(span, env, options)
-          if options.fetch(:error_handler).call(env)
-            span.set_error(["Error #{env[:status]}", env[:body]])
-          end
+          span.set_error(["Error #{env[:status]}", env[:body]]) if options.fetch(:error_handler).call(env)
 
           span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, env[:status])
         end

data/lib/ddtrace/contrib/faraday/patcher.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/faraday/ext'
@@ -20,21 +21,10 @@ module Datadog
         def patch
           require 'ddtrace/contrib/faraday/middleware'
 
-          add_pin!
           register_middleware!
           add_default_middleware!
         end
 
-        def add_pin!
-          DeprecatedPin
-            .new(
-              get_option(:service_name),
-              app: Ext::APP,
-              app_type: Datadog::Ext::AppTypes::WEB,
-              tracer: -> { get_option(:tracer) }
-            ).onto(::Faraday)
-        end
-
         def register_middleware!
           ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
         end
@@ -45,7 +35,7 @@ module Datadog
             ::Faraday.default_connection.use(:ddtrace)
 
             # Patch new connection instances (e.g. +Faraday.new+)
-            ::Faraday::Connection.send(:prepend, Connection)
+            ::Faraday::Connection.prepend(Connection)
           else
             # Patch the default connection (e.g. +Faraday.get+)
             #
@@ -55,32 +45,7 @@ module Datadog
             ::Faraday.default_connection.builder.insert(idx, Middleware)
 
             # Patch new connection instances (e.g. +Faraday.new+)
-            ::Faraday::RackBuilder.send(:prepend, RackBuilder)
-          end
-        end
-
-        def get_option(option)
-          Datadog.configuration[:faraday].get_option(option)
-        end
-
-        # Implementation of deprecated Pin, which raises warnings when accessed.
-        # To be removed when support for Datadog::Pin with Faraday is removed.
-        class DeprecatedPin < Datadog::Pin
-          include Datadog::DeprecatedPin
-
-          DEPRECATION_WARNING = %(
-            Use of Datadog::Pin with Faraday is DEPRECATED.
-            Upgrade to the configuration API using the migration guide here:
-            https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
-
-          def service_name=(service_name)
-            Datadog.configuration[:faraday][:service_name] = service_name
-          end
-
-          def log_deprecation_warning(method_name)
-            do_once(method_name) do
-              Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
-            end
+            ::Faraday::RackBuilder.prepend(RackBuilder)
           end
         end
       end

data/lib/ddtrace/contrib/faraday/rack_builder.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Contrib
     module Faraday

data/lib/ddtrace/contrib/grape/configuration/settings.rb

@@ -1,6 +1,8 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/ext/http'
 require 'ddtrace/contrib/grape/ext'
+require 'ddtrace/contrib/status_code_matcher'
 
 module Datadog
   module Contrib
@@ -24,6 +26,12 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+
+          option :error_statuses, default: nil do |o|
+            o.setter do |new_value, _old_value|
+              Datadog::Contrib::StatusCodeMatcher.new(new_value) unless new_value.nil?
+            end
+          end
         end
       end
     end

data/lib/ddtrace/contrib/grape/endpoint.rb

@@ -1,4 +1,4 @@
-
+# typed: false
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/errors'
 require 'ddtrace/contrib/analytics'
@@ -34,17 +34,27 @@ module Datadog
             end
           end
 
-          def endpoint_start_process(*)
+          def endpoint_start_process(_name, _start, _finish, _id, payload)
             return if Thread.current[KEY_RUN]
             return unless enabled?
 
+            # collect endpoint details
+            endpoint = payload.fetch(:endpoint)
+            api_view = api_view(endpoint.options[:for])
+            request_method = endpoint.options.fetch(:method).first
+            path = endpoint_expand_path(endpoint)
+            resource = "#{api_view} #{request_method} #{path}"
+
             # Store the beginning of a trace
-            tracer.trace(
+            span = tracer.trace(
               Ext::SPAN_ENDPOINT_RUN,
               service: service_name,
-              span_type: Datadog::Ext::HTTP::TYPE_INBOUND
+              span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
+              resource: resource,
             )
 
+            try_setting_rack_request_resource(payload, span.resource)
+
             Thread.current[KEY_RUN] = true
           rescue StandardError => e
             Datadog.logger.error(e.message)
@@ -52,6 +62,7 @@ module Datadog
 
           def endpoint_run(name, start, finish, id, payload)
             return unless Thread.current[KEY_RUN]
+
             Thread.current[KEY_RUN] = false
 
             return unless enabled?
@@ -61,40 +72,30 @@ module Datadog
 
             begin
               # collect endpoint details
-              api = payload[:endpoint].options[:for]
-              # If the API inherits from Grape::API in version >= 1.2.0
-              # then the API will be an instance and the name must be derived from the base.
-              # See https://github.com/ruby-grape/grape/issues/1825
-              api_view = if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
-                           api.base.to_s
-                         else
-                           api.to_s
-                         end
-
-              path = payload[:endpoint].options[:path].join('/')
-              resource = "#{api_view}##{path}"
-              span.resource = resource
-
-              # set the request span resource if it's a `rack.request` span
-              request_span = payload[:env][Datadog::Contrib::Rack::Ext::RACK_ENV_REQUEST_SPAN]
-              if !request_span.nil? && request_span.name == Datadog::Contrib::Rack::Ext::SPAN_REQUEST
-                request_span.resource = resource
-              end
+              endpoint = payload.fetch(:endpoint)
+              api_view = api_view(endpoint.options[:for])
+              request_method = endpoint.options.fetch(:method).first
+              path = endpoint_expand_path(endpoint)
+
+              try_setting_rack_request_resource(payload, span.resource)
 
               # Set analytics sample rate
-              if analytics_enabled?
-                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
-              end
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
               # catch thrown exceptions
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+
+              span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
 
               # override the current span with this notification values
               span.set_tag(Ext::TAG_ROUTE_ENDPOINT, api_view) unless api_view.nil?
               span.set_tag(Ext::TAG_ROUTE_PATH, path)
+              span.set_tag(Ext::TAG_ROUTE_METHOD, request_method)
+
+              span.set_tag(Datadog::Ext::HTTP::METHOD, request_method)
+              span.set_tag(Datadog::Ext::HTTP::URL, path)
             ensure
               span.start(start)
               span.finish(finish)
@@ -121,6 +122,7 @@ module Datadog
 
           def endpoint_render(name, start, finish, id, payload)
             return unless Thread.current[KEY_RENDER]
+
             Thread.current[KEY_RENDER] = false
 
             return unless enabled?
@@ -133,7 +135,7 @@ module Datadog
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+              span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
             ensure
               span.start(start)
               span.finish(finish)
@@ -160,15 +162,14 @@ module Datadog
 
             begin
               # Set analytics sample rate
-              if analytics_enabled?
-                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
-              end
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
               # catch thrown exceptions
-              span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
+              span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
+
               span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
             ensure
               span.start(start)
@@ -180,6 +181,25 @@ module Datadog
 
           private
 
+          def api_view(api)
+            # If the API inherits from Grape::API in version >= 1.2.0
+            # then the API will be an instance and the name must be derived from the base.
+            # See https://github.com/ruby-grape/grape/issues/1825
+            if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
+              api.base.to_s
+            else
+              api.to_s
+            end
+          end
+
+          def endpoint_expand_path(endpoint)
+            route_path = endpoint.options[:path]
+            namespace = endpoint.routes.first && endpoint.routes.first.namespace || ''
+
+            parts = (namespace.split('/') + route_path).reject { |p| p.blank? || p.eql?('/') }
+            parts.join('/').prepend('/')
+          end
+
           def tracer
             datadog_configuration[:tracer]
           end
@@ -196,6 +216,15 @@ module Datadog
             datadog_configuration[:analytics_sample_rate]
           end
 
+          def exception_is_error?(exception)
+            matcher = datadog_configuration[:error_statuses]
+            return false unless exception
+            return true unless matcher
+            return true unless exception.respond_to?('status')
+
+            matcher.include?(exception.status)
+          end
+
           def enabled?
             datadog_configuration[:enabled] == true
           end
@@ -203,6 +232,13 @@ module Datadog
           def datadog_configuration
             Datadog.configuration[:grape]
           end
+
+          def try_setting_rack_request_resource(payload, resource)
+            request_span = payload[:env][Datadog::Contrib::Rack::Ext::RACK_ENV_REQUEST_SPAN]
+            if !request_span.nil? && request_span.name == Datadog::Contrib::Rack::Ext::SPAN_REQUEST
+              request_span.resource = resource
+            end
+          end
         end
       end
     end

data/lib/ddtrace/contrib/grape/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Grape
@@ -16,6 +17,7 @@ module Datadog
         TAG_FILTER_TYPE = 'grape.filter.type'.freeze
         TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
         TAG_ROUTE_PATH = 'grape.route.path'.freeze
+        TAG_ROUTE_METHOD = 'grape.route.method'.freeze
       end
     end
   end

data/lib/ddtrace/contrib/grape/instrumentation.rb

@@ -1,11 +1,12 @@
+# typed: false
 module Datadog
   module Contrib
     module Grape
       # Instrumentation for Grape::Endpoint
       module Instrumentation
         def self.included(base)
-          base.singleton_class.send(:prepend, ClassMethods)
-          base.send(:prepend, InstanceMethods)
+          base.singleton_class.prepend(ClassMethods)
+          base.prepend(InstanceMethods)
         end
 
         # ClassMethods - implementing instrumentation
@@ -23,7 +24,7 @@ module Datadog
         # InstanceMethods - implementing instrumentation
         module InstanceMethods
           def run(*args)
-            ::ActiveSupport::Notifications.instrument('endpoint_run.grape.start_process')
+            ::ActiveSupport::Notifications.instrument('endpoint_run.grape.start_process', endpoint: self, env: env)
             super
           end
         end

data/lib/ddtrace/contrib/grape/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/grape/configuration/settings'
 require 'ddtrace/contrib/grape/patcher'

data/lib/ddtrace/contrib/grape/patcher.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 
@@ -20,53 +21,11 @@ module Datadog
 
         def patch
           # Patch endpoints
-          ::Grape::Endpoint.send(:include, Instrumentation)
-
-          add_pin!
+          ::Grape::Endpoint.include(Instrumentation)
 
           # Subscribe to ActiveSupport events
           Datadog::Contrib::Grape::Endpoint.subscribe
         end
-
-        def add_pin!
-          # Attach a Pin object globally and set the service once
-          pin = DeprecatedPin.new(
-            get_option(:service_name),
-            app: Ext::APP,
-            app_type: Datadog::Ext::AppTypes::WEB,
-            tracer: -> { get_option(:tracer) }
-          )
-          pin.onto(::Grape)
-        end
-
-        def get_option(option)
-          Datadog.configuration[:grape].get_option(option)
-        end
-
-        # Implementation of deprecated Pin, which raises warnings when accessed.
-        # To be removed when support for Datadog::Pin with Grape is removed.
-        class DeprecatedPin < Datadog::Pin
-          include Datadog::DeprecatedPin
-
-          DEPRECATION_WARNING = %(
-            Use of Datadog::Pin with Grape is DEPRECATED.
-            Upgrade to the configuration API using the migration guide here:
-            https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
-
-          def tracer=(tracer)
-            Datadog.configuration[:grape][:tracer] = tracer
-          end
-
-          def service_name=(service_name)
-            Datadog.configuration[:grape][:service_name] = service_name
-          end
-
-          def log_deprecation_warning(method_name)
-            do_once(method_name) do
-              Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
-            end
-          end
-        end
       end
     end
   end

data/lib/ddtrace/contrib/graphql/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/graphql/ext'

data/lib/ddtrace/contrib/graphql/ext.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module GraphQL

data/lib/ddtrace/contrib/graphql/integration.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/graphql/configuration/settings'
 require 'ddtrace/contrib/graphql/patcher'

data/lib/ddtrace/contrib/graphql/patcher.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 
 module Datadog

data/lib/ddtrace/contrib/grpc/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/grpc/ext'
 
@@ -23,6 +24,7 @@ module Datadog
           end
 
           option :service_name, default: Ext::SERVICE_NAME
+          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
         end
       end
     end

data/lib/ddtrace/contrib/grpc/datadog_interceptor/client.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/integration'
 require 'ddtrace/contrib/analytics'

data/lib/ddtrace/contrib/grpc/datadog_interceptor/server.rb

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/integration'
 require 'ddtrace/contrib/analytics'
@@ -17,7 +18,8 @@ module Datadog
             options = {
               span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
               service: service_name,
-              resource: format_resource(keywords[:method])
+              resource: format_resource(keywords[:method]),
+              on_error: error_handler
             }
             metadata = keywords[:call].metadata
 
@@ -44,12 +46,10 @@ module Datadog
           def annotate!(span, metadata)
             metadata.each do |header, value|
               next if reserved_headers.include?(header)
+
               span.set_tag(header, value)
             end
 
-            # Tag as an external peer service
-            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
-
             # Set analytics sample rate
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?