ddtrace 0.45.0 → 0.52.0

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/errors'
 require 'ddtrace/contrib/analytics'
@@ -33,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)
@@ -51,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?
@@ -60,34 +72,22 @@ module Datadog
 
             begin
               # collect endpoint details
-              api = payload[:endpoint].options[:for]
-
-              api_view = api_view(api)
+              endpoint = payload.fetch(:endpoint)
+              api_view = api_view(endpoint.options[:for])
+              request_method = endpoint.options.fetch(:method).first
+              path = endpoint_expand_path(endpoint)
 
-              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
-              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
+              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
 
-              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?
@@ -122,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?
@@ -134,9 +135,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)
@@ -163,17 +162,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
@@ -226,6 +221,7 @@ module Datadog
             return false unless exception
             return true unless matcher
             return true unless exception.respond_to?('status')
+
             matcher.include?(exception.status)
           end
 
@@ -236,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

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?
 

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

@@ -1,3 +1,4 @@
+# typed: ignore
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
@@ -15,20 +16,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
@@ -64,6 +65,10 @@ module Datadog
           def analytics_sample_rate
             datadog_configuration[:analytics_sample_rate]
           end
+
+          def error_handler
+            datadog_configuration[:error_handler]
+          end
         end
 
         require_relative 'datadog_interceptor/client'

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: true
 require_relative 'datadog_interceptor'
 
 module Datadog

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/grpc/ext'
 
@@ -6,6 +7,7 @@ module Datadog
     module GRPC
       # Patcher enables patching of 'grpc' module.
       module Patcher
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
         include Contrib::Patcher
 
         module_function
@@ -19,48 +21,12 @@ 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
+            .prepend(Datadog::Contrib::GRPC::InterceptWithDatadog)
         end
       end
     end

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module HTTP
@@ -27,9 +28,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/configuration/settings.rb

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'uri'
 require 'ddtrace/pin'
 require 'ddtrace/ext/app_types'
@@ -14,12 +15,12 @@ module Datadog
       # Instrumentation for Net::HTTP
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # 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 +33,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 +108,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
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/version'
 
 require 'ddtrace/contrib/integration'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/http/ext'
 require 'ddtrace/contrib/http/instrumentation'
@@ -18,7 +19,7 @@ module Datadog
 
         # patch applies our patch if needed
         def patch
-          ::Net::HTTP.send(:include, Instrumentation)
+          ::Net::HTTP.include(Instrumentation)
         end
       end
     end

data/lib/ddtrace/contrib/http_annotation_helper.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     # Contains methods helpful for tracing/annotating HTTP request libraries

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

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

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

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

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
@@ -12,7 +13,7 @@ module Datadog
       # Instrumentation for Httpclient
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for configuration
@@ -88,14 +89,12 @@ module Datadog
             service = config[:service_name]
             tracer = config[:tracer]
 
-            @datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
 
             if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
               @datadog_pin.service = service
@@ -111,14 +110,12 @@ module Datadog
             config = Datadog.configuration[:httpclient]
             service = config[:service_name]
 
-            @default_datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
           end
 
           def datadog_configuration(host = :default)
@@ -134,15 +131,14 @@ 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[:httpclient][:distributed_tracing]
           end
 
           def set_analytics_sample_rate(span, request_options)
             return unless analytics_enabled?(request_options)
+
             Contrib::Analytics.set_sample_rate(span, request_options[:analytics_sample_rate])
           end
         end

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

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

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

@@ -1,5 +1,7 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/httpclient/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,10 +11,12 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:httpclient)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def target_version
@@ -21,11 +25,11 @@ module Datadog
 
         # patch applies our patch
         def patch
-          do_once(:httpclient) do
+          PATCH_ONLY_ONCE.run do
             begin
-              ::HTTPClient.send(:include, Instrumentation)
+              ::HTTPClient.include(Instrumentation)
             rescue StandardError => e
-              Datadog::Logger.error("Unable to apply httpclient integration: #{e}")
+              Datadog.logger.error("Unable to apply httpclient integration: #{e}")
             end
           end
         end