ddtrace 0.40.0 → 0.45.0

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/grpc/datadog_interceptor/client.rb

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
 
@@ -7,7 +8,7 @@ module Datadog
     module GRPC
       module DatadogInterceptor
         # The DatadogInterceptor::Client implements the tracing strategy
-        # for gRPC client-side endpoitns. This middleware compoent will
+        # for gRPC client-side endpoints. This middleware component will
         # inject trace context information into gRPC metadata prior to
         # sending the request to the server.
         class Client < Base
@@ -32,6 +33,9 @@ module Datadog
           def annotate!(span, metadata)
             span.set_tags(metadata)
 
+            # 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/server.rb

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/grpc/ext'
 
@@ -46,6 +47,9 @@ module Datadog
               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/http/instrumentation.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'ddtrace/pin'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/contrib/analytics'
@@ -83,6 +84,9 @@ module Datadog
             span.set_tag(Datadog::Ext::NET::TARGET_HOST, host)
             span.set_tag(Datadog::Ext::NET::TARGET_PORT, port.to_s)
 
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
             # Set analytics sample rate
             set_analytics_sample_rate(span, request_options)
           end
@@ -114,7 +118,7 @@ module Datadog
             @datadog_pin ||= Datadog::Pin.new(
               service,
               app: Ext::APP,
-              app_type: Datadog::Ext::AppTypes::WEB,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
               tracer: -> { config[:tracer] }
             )
 
@@ -142,7 +146,7 @@ module Datadog
             @default_datadog_pin ||= Datadog::Pin.new(
               service,
               app: Ext::APP,
-              app_type: Datadog::Ext::AppTypes::WEB,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
               tracer: -> { config[:tracer] }
             )
           end

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

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/httpclient/ext'
+
+module Datadog
+  module Contrib
+    module Httpclient
+      module Configuration
+        # Custom settings for the Httpclient integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 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/httpclient/ext.rb

@@ -0,0 +1,17 @@
+module Datadog
+  module Contrib
+    module Httpclient
+      # Httpclient integration constants
+      module Ext
+        APP = 'httpclient'.freeze
+        ENV_ENABLED = 'DD_TRACE_HTTPCLIENT_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTPCLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_HTTPCLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_HTTPCLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'httpclient'.freeze
+        SPAN_REQUEST = 'httpclient.request'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+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 Httpclient
+      # Instrumentation for Httpclient
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
+          def do_get_block(req, proxy, conn, &block)
+            host = req.header.request_uri.host
+            request_options = datadog_configuration(host)
+            pin = datadog_pin(request_options)
+
+            return super 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.header)
+                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 httpclient request: #{e}, Source: #{e.backtrace}")
+              ensure
+                res = super
+              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)
+            http_method = req.header.request_method.upcase
+            uri = req.header.request_uri
+
+            span.resource = http_method
+            span.set_tag(Datadog::Ext::HTTP::METHOD, http_method)
+            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)
+
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
+            set_analytics_sample_rate(span, req_options)
+          end
+
+          def annotate_span_with_response!(span, response)
+            return unless response && response.status
+
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.status)
+
+            case response.status.to_i
+            when 400...599
+              span.set_error(["Error #{response.status}", response.body])
+            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::HTTP::TYPE_OUTBOUND,
+                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[: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
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:httpclient, 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[: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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/httpclient/configuration/settings'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
+require 'ddtrace/contrib/httpclient/patcher'
+
+module Datadog
+  module Contrib
+    module Httpclient
+      # Description of Httpclient integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('2.2.0')
+
+        register_as :httpclient
+
+        def self.version
+          Gem.loaded_specs['httpclient'] && Gem.loaded_specs['httpclient'].version
+        end
+
+        def self.loaded?
+          !defined?(::HTTPClient).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/httpclient/patcher.rb

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

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

@@ -40,7 +40,7 @@ module Datadog
                 # 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}")
+                logger.error("error preparing span for http.rb request: #{e}, Source: #{e.backtrace}")
               ensure
                 res = super(req, options)
               end
@@ -72,6 +72,9 @@ module Datadog
               logger.debug("service #{req_options[:service_name]} span #{Ext::SPAN_REQUEST} missing uri")
             end
 
+            # Tag as an external peer service
+            span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
             set_analytics_sample_rate(span, req_options)
           end
 
@@ -100,7 +103,7 @@ module Datadog
               Datadog::Pin.new(
                 service,
                 app: Ext::APP,
-                app_type: Datadog::Ext::AppTypes::WEB,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
                 tracer: -> { config[:tracer] }
               )
             end
@@ -123,7 +126,7 @@ module Datadog
               Datadog::Pin.new(
                 service,
                 app: Ext::APP,
-                app_type: Datadog::Ext::AppTypes::WEB,
+                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
                 tracer: -> { config[:tracer] }
               )
             end

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

@@ -42,7 +42,7 @@ module Datadog
             # Measure service stats
             Contrib::Analytics.set_measured(span)
 
-            span.set_error(payload[:exception_object]) if payload[:exception_object]
+            report_if_exception(span, payload)
           end
         end
       end

data/lib/ddtrace/contrib/mongodb/subscribers.rb

@@ -1,6 +1,7 @@
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/mongodb/ext'
 require 'ddtrace/contrib/mongodb/parsers'
+require 'ddtrace/ext/integration'
 
 module Datadog
   module Contrib
@@ -24,6 +25,9 @@ module Datadog
           query = MongoDB.query_builder(event.command_name, event.database_name, event.command)
           serialized_query = query.to_s
 
+          # Tag as an external peer service
+          span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
+
           # Set analytics sample rate
           if analytics_enabled?
             Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)

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

@@ -1,4 +1,5 @@
 require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/sql'
 require 'ddtrace/contrib/analytics'
@@ -21,6 +22,9 @@ module Datadog
               span.service = datadog_pin.service
               span.span_type = Datadog::Ext::SQL::TYPE
 
+              # 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?