ddtrace 0.43.0 → 0.48.0

data/lib/ddtrace/contrib/extensions.rb

@@ -27,8 +27,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
@@ -48,9 +67,32 @@ module Datadog
             end
           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.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(configuration_name) unless integration.nil?
+            integration.configuration(describes) unless integration.nil?
           end
 
           def instrument(integration_name, options = {}, &block)
@@ -86,6 +128,14 @@ module Datadog
             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/middleware.rb

@@ -57,9 +57,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

@@ -20,21 +20,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::HTTP::TYPE_OUTBOUND,
-              tracer: -> { get_option(:tracer) }
-            ).onto(::Faraday)
-        end
-
         def register_middleware!
           ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
         end
@@ -58,31 +47,6 @@ module Datadog
             ::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
-          end
-        end
       end
     end
   end

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

@@ -51,6 +51,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,17 +62,12 @@ 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}"
+
+              api_view = api_view(api)
+
+              request_method = payload[:endpoint].options[:method].first
+              path = endpoint_expand_path(payload[:endpoint])
+              resource = "#{api_view} #{request_method} #{path}"
               span.resource = resource
 
               # set the request span resource if it's a `rack.request` span
@@ -81,22 +77,22 @@ module Datadog
               end
 
               # 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
 
-              if exception_is_error?(payload[:exception_object])
-                span.set_error(payload[:exception_object])
-              end
+              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)
@@ -123,6 +119,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?
@@ -135,9 +132,7 @@ module Datadog
               # Measure service stats
               Contrib::Analytics.set_measured(span)
 
-              if exception_is_error?(payload[:exception_object])
-                span.set_error(payload[:exception_object])
-              end
+              span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
             ensure
               span.start(start)
               span.finish(finish)
@@ -164,17 +159,13 @@ 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
-              if exception_is_error?(payload[:exception_object])
-                span.set_error(payload[:exception_object])
-              end
+              span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
 
               span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
             ensure
@@ -187,6 +178,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
@@ -208,6 +218,7 @@ module Datadog
             return false unless exception
             return true unless matcher
             return true unless exception.respond_to?('status')
+
             matcher.include?(exception.status)
           end
 

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

@@ -16,6 +16,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/patcher.rb

@@ -22,51 +22,9 @@ module Datadog
           # Patch endpoints
           ::Grape::Endpoint.send(:include, Instrumentation)
 
-          add_pin!
-
           # 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/grpc/datadog_interceptor.rb

@@ -15,20 +15,20 @@ module Datadog
             add_datadog_pin! { |c| yield(c) if block_given? }
           end
 
-          def request_response(**keywords)
-            trace(keywords) { yield }
+          def request_response(**keywords, &block)
+            trace(keywords, &block)
           end
 
-          def client_streamer(**keywords)
-            trace(keywords) { yield }
+          def client_streamer(**keywords, &block)
+            trace(keywords, &block)
           end
 
-          def server_streamer(**keywords)
-            trace(keywords) { yield }
+          def server_streamer(**keywords, &block)
+            trace(keywords, &block)
           end
 
-          def bidi_streamer(**keywords)
-            trace(keywords) { yield }
+          def bidi_streamer(**keywords, &block)
+            trace(keywords, &block)
           end
 
           private

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

@@ -44,6 +44,7 @@ module Datadog
           def annotate!(span, metadata)
             metadata.each do |header, value|
               next if reserved_headers.include?(header)
+
               span.set_tag(header, value)
             end
 

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

@@ -19,49 +19,13 @@ module Datadog
           require 'ddtrace/contrib/grpc/datadog_interceptor'
           require 'ddtrace/contrib/grpc/intercept_with_datadog'
 
-          add_pin!
-
           prepend_interceptor
         end
 
-        def add_pin!
-          DeprecatedPin.new(
-            get_option(:service_name),
-            app: Ext::APP,
-            app_type: Datadog::Ext::AppTypes::WEB,
-            tracer: -> { get_option(:tracer) }
-          ).onto(::GRPC)
-        end
-
         def prepend_interceptor
           ::GRPC::InterceptionContext
             .send(:prepend, Datadog::Contrib::GRPC::InterceptWithDatadog)
         end
-
-        def get_option(option)
-          Datadog.configuration[:grpc].get_option(option)
-        end
-
-        # Implementation of deprecated Pin, which raises warnings when accessed.
-        # To be removed when support for Datadog::Pin with GRPC is removed.
-        class DeprecatedPin < Datadog::Pin
-          include Datadog::DeprecatedPin
-
-          DEPRECATION_WARNING = %(
-            Use of Datadog::Pin with GRPC 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[:grpc][: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/http/circuit_breaker.rb

@@ -27,9 +27,7 @@ module Datadog
         end
 
         def should_skip_distributed_tracing?(pin)
-          if pin.config && pin.config.key?(:distributed_tracing)
-            return !pin.config[:distributed_tracing]
-          end
+          return !pin.config[:distributed_tracing] if pin.config && pin.config.key?(:distributed_tracing)
 
           !Datadog.configuration[:http][:distributed_tracing]
         end

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

@@ -19,7 +19,7 @@ module Datadog
 
         # Span hook invoked after request is completed.
         def self.after_request(&block)
-          if block_given?
+          if block
             # Set hook
             @after_request = block
           else
@@ -32,15 +32,14 @@ module Datadog
         module InstanceMethods
           include Datadog::Contrib::HttpAnnotationHelper
 
-          def request(req, body = nil, &block) # :yield: +response+
+          # :yield: +response+
+          def request(req, body = nil, &block)
             host, = host_and_port(req)
             request_options = datadog_configuration(host)
             pin = datadog_pin(request_options)
             return super(req, body, &block) unless pin && pin.tracer
 
-            if Datadog::Contrib::HTTP.should_skip_tracing?(req, pin.tracer)
-              return super(req, body, &block)
-            end
+            return super(req, body, &block) if Datadog::Contrib::HTTP.should_skip_tracing?(req, pin.tracer)
 
             pin.tracer.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span|
               begin
@@ -108,6 +107,7 @@ module Datadog
 
           def set_analytics_sample_rate(span, request_options)
             return unless analytics_enabled?(request_options)
+
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate(request_options))
           end