ddtrace 0.35.0 → 0.38.0

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

@@ -4,8 +4,8 @@ module Datadog
       # HTTP integration circuit breaker behavior
       # For avoiding recursive traces.
       module CircuitBreaker
-        def should_skip_tracing?(req, address, port, tracer)
-          return true if datadog_http_request?(req, address, port, tracer)
+        def should_skip_tracing?(request, tracer)
+          return true if datadog_http_request?(request)
 
           # we don't want a "shotgun" effect with two nested traces for one
           # logical get, and request is likely to call itself recursively
@@ -16,38 +16,14 @@ module Datadog
         end
 
         # We don't want to trace our own call to the API (they use net/http)
-        # TODO: We don't want this kind of coupling with the transport.
+        # TODO: We don't want this kind of soft-check on HTTP requests.
         #       Remove this when transport implements its own "skip tracing" mechanism.
-        def datadog_http_request?(req, address, port, tracer)
-          transport = tracer.writer.transport
-
-          transport_hostname = nil
-          transport_port = nil
-
-          # Get settings from transport, if available.
-          case transport
-          when Datadog::Transport::HTTP::Client
-            adapter = transport.current_api.adapter
-            if adapter.is_a?(Datadog::Transport::HTTP::Adapters::Net)
-              transport_hostname = adapter.hostname.to_s
-              transport_port = adapter.port.to_i
-            end
-          end
-
-          # When we know the host & port (from the URI) we use it, else (most-likely
-          # called with a block) rely on the URL at the end.
-          if req.respond_to?(:uri) && req.uri
-            if req.uri.host.to_s == transport_hostname &&
-               req.uri.port.to_i == transport_port
-              return true
-            end
-          elsif address && port &&
-                address.to_s == transport_hostname &&
-                port.to_i == transport_port
-            return true
+        def datadog_http_request?(request)
+          if request[Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION]
+            true
+          else
+            false
           end
-
-          false
         end
 
         def should_skip_distributed_tracing?(pin)

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

@@ -37,7 +37,7 @@ module Datadog
             pin = datadog_pin(request_options)
             return super(req, body, &block) unless pin && pin.tracer
 
-            if Datadog::Contrib::HTTP.should_skip_tracing?(req, @address, @port, pin.tracer)
+            if Datadog::Contrib::HTTP.should_skip_tracing?(req, pin.tracer)
               return super(req, body, &block)
             end
 
@@ -111,9 +111,12 @@ module Datadog
             service = config[:service_name]
             tracer = config[:tracer]
 
-            @datadog_pin ||= begin
-              Datadog::Pin.new(service, app: Ext::APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
-            end
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: -> { config[:tracer] }
+            )
 
             # this shockingly poor code exists to solve the case where someone
             # calls datadog_pin on this object before running a request, which
@@ -136,10 +139,12 @@ module Datadog
           def default_datadog_pin
             config = Datadog.configuration[:http]
             service = config[:service_name]
-            tracer = config[:tracer]
-            @default_datadog_pin ||= begin
-              Datadog::Pin.new(service, app: Ext::APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
-            end
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: -> { config[:tracer] }
+            )
           end
 
           private

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

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/httprb/ext'
+
+module Datadog
+  module Contrib
+    module Httprb
+      module Configuration
+        # Custom settings for the Httprb integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :distributed_tracing, default: true
+          option :service_name, default: Ext::SERVICE_NAME
+          option :split_by_domain, default: false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module Httprb
+      # Httprb integration constants
+      module Ext
+        APP = 'httprb'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_HTTPRB_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_HTTPRB_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'httprb'.freeze
+        SPAN_REQUEST = 'httprb.request'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,163 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/http_annotation_helper'
+
+module Datadog
+  module Contrib
+    module Httprb
+      # Instrumentation for Httprb
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        # rubocop:disable Metrics/ModuleLength
+        module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
+          def perform(req, options)
+            host = req.uri.host if req.respond_to?(:uri) && req.uri
+            request_options = datadog_configuration(host)
+            pin = datadog_pin(request_options)
+
+            return super(req, options) unless pin && pin.tracer
+
+            pin.tracer.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span|
+              begin
+                request_options[:service_name] = pin.service_name
+                span.service = service_name(host, request_options)
+                span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
+
+                if pin.tracer.enabled && !should_skip_distributed_tracing?(pin)
+                  Datadog::HTTPPropagator.inject!(span.context, req)
+                end
+
+                # Add additional request specific tags to the span.
+                annotate_span_with_request!(span, req, request_options)
+              rescue StandardError => e
+                logger.error("error preparing span for http.rb request: #{e}, Soure: #{e.backtrace}")
+              ensure
+                res = super(req, options)
+              end
+
+              # Add additional response specific tags to the span.
+              annotate_span_with_response!(span, res)
+
+              res
+            end
+          end
+
+          private
+
+          def annotate_span_with_request!(span, req, req_options)
+            if req.verb && req.verb.is_a?(String) || req.verb.is_a?(Symbol)
+              http_method = req.verb.to_s.upcase
+              span.resource = http_method
+              span.set_tag(Datadog::Ext::HTTP::METHOD, http_method)
+            else
+              logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing request verb")
+            end
+
+            if req.uri
+              uri = req.uri
+              span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+            else
+              logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing uri")
+            end
+
+            set_analytics_sample_rate(span, req_options)
+          end
+
+          def annotate_span_with_response!(span, response)
+            return unless response && response.code
+
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
+
+            case response.code.to_i
+            when 400...599
+              begin
+                message = JSON.parse(response.body)['message']
+              rescue
+                message = 'Error'
+              end
+              span.set_error(["Error #{response.code}", message])
+            end
+          end
+
+          def annotate_span_with_error!(span, error)
+            span.set_error(error)
+          end
+
+          def datadog_pin(config = Datadog.configuration[:httprb])
+            service = config[:service_name]
+            tracer = config[:tracer]
+
+            @datadog_pin ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::WEB,
+                tracer: -> { config[:tracer] }
+              )
+            end
+
+            if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
+              @datadog_pin.service = service
+            end
+            if @datadog_pin.tracer == default_datadog_pin.tracer && @datadog_pin.tracer != tracer
+              @datadog_pin.tracer = tracer
+            end
+
+            @datadog_pin
+          end
+
+          def default_datadog_pin
+            config = Datadog.configuration[:httprb]
+            service = config[:service_name]
+
+            @default_datadog_pin ||= begin
+              Datadog::Pin.new(
+                service,
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::WEB,
+                tracer: -> { config[:tracer] }
+              )
+            end
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:httprb, host]
+          end
+
+          def analytics_enabled?(request_options)
+            Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+          end
+
+          def logger
+            Datadog.logger
+          end
+
+          def should_skip_distributed_tracing?(pin)
+            if pin.config && pin.config.key?(:distributed_tracing)
+              return !pin.config[:distributed_tracing]
+            end
+
+            !Datadog.configuration[:httprb][: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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/httprb/configuration/settings'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
+require 'ddtrace/contrib/httprb/patcher'
+
+module Datadog
+  module Contrib
+    module Httprb
+      # Description of Httprb integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('2.0.0')
+
+        register_as :httprb
+
+        def self.version
+          Gem.loaded_specs['http'] && Gem.loaded_specs['http'].version
+        end
+
+        def self.loaded?
+          !defined?(::HTTP).nil? && !defined?(::HTTP::Client).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+
+        def resolver
+          @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/httprb/instrumentation'
+
+module Datadog
+  module Contrib
+    # Datadog Httprb integration.
+    module Httprb
+      # Patcher enables patching of 'httprb' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:httprb)
+        end
+
+        def target_version
+          Integration.version
+        end
+
+        # patch applies our patch
+        def patch
+          do_once(:httprb) do
+            begin
+              ::HTTP::Client.send(:include, Instrumentation)
+            rescue StandardError => e
+              Datadog::Logger.error("Unable to apply httprb integration: #{e}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/kafka/ext'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Configuration
+        # Custom settings for the Kafka integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/kafka/consumer_event.rb

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module Kafka
+      # Defines basic behaviors for an event for a consumer.
+      module ConsumerEvent
+        def process(span, _event, _id, payload)
+          super
+
+          span.set_tag(Ext::TAG_GROUP, payload[:group_id])
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/kafka/consumer_group_event.rb

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module Kafka
+      # Defines basic behaviors for an event for a consumer group.
+      module ConsumerGroupEvent
+        def process(span, _event, _id, payload)
+          super
+
+          span.resource = payload[:group_id]
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/kafka/event.rb

@@ -0,0 +1,51 @@
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/kafka/ext'
+
+module Datadog
+  module Contrib
+    module Kafka
+      # Defines basic behaviors for an ActiveSupport event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for Kafka events.
+        module ClassMethods
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:kafka]
+          end
+
+          def process(span, _event, _id, payload)
+            span.service = configuration[:service_name]
+            span.set_tag(Ext::TAG_CLIENT, payload[:client_id])
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            span.set_error(payload[:exception_object]) if payload[:exception_object]
+          end
+        end
+      end
+    end
+  end
+end