ddtrace 0.13.0 → 0.47.0

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

@@ -1,3 +1,8 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/integration'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
 module Datadog
   module Contrib
     module GRPC
@@ -10,15 +15,15 @@ module Datadog
         class Server < Base
           def trace(keywords)
             options = {
-              span_type: Datadog::Ext::GRPC::TYPE,
-              service: datadog_pin.service_name,
+              span_type: Datadog::Ext::HTTP::TYPE_INBOUND,
+              service: service_name,
               resource: format_resource(keywords[:method])
             }
             metadata = keywords[:call].metadata
 
             set_distributed_context!(tracer, metadata)
 
-            tracer.trace('grpc.service', options) do |span|
+            tracer.trace(Ext::SPAN_SERVICE, options) do |span|
               annotate!(span, metadata)
 
               yield
@@ -31,7 +36,7 @@ module Datadog
             tracer.provider.context = Datadog::GRPCPropagator
                                       .extract(metadata)
           rescue StandardError => e
-            Datadog::Tracer.log.debug(
+            Datadog.logger.debug(
               "unable to propagate GRPC metadata to context: #{e}"
             )
           end
@@ -39,10 +44,20 @@ 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?
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
           rescue StandardError => e
-            Datadog::Tracer.log.debug("GRPC client trace failed: #{e}")
+            Datadog.logger.debug("GRPC client trace failed: #{e}")
           end
 
           def reserved_headers

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

@@ -0,0 +1,18 @@
+module Datadog
+  module Contrib
+    module GRPC
+      # gRPC integration constants
+      module Ext
+        APP = 'grpc'.freeze
+        ENV_ENABLED = 'DD_TRACE_GRPC_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRPC_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_GRPC_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRPC_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_GRPC_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'grpc'.freeze
+        SPAN_CLIENT = 'grpc.client'.freeze
+        SPAN_SERVICE = 'grpc.service'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/grpc/configuration/settings'
+require 'ddtrace/contrib/grpc/patcher'
+
+module Datadog
+  module Contrib
+    module GRPC
+      # Description of gRPC integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('1.7.0')
+
+        register_as :grpc, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['grpc'] && Gem.loaded_specs['grpc'].version
+        end
+
+        def self.loaded?
+          !defined?(::GRPC).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -1,60 +1,30 @@
-# requirements should be kept minimal as Patcher is a shared requirement.
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/grpc/ext'
 
 module Datadog
   module Contrib
     module GRPC
-      SERVICE = 'grpc'.freeze
-
       # Patcher enables patching of 'grpc' module.
       module Patcher
-        include Base
-        register_as :grpc, auto_patch: true
-        option :tracer, default: Datadog.tracer
-        option :service_name, default: SERVICE
-
-        @patched = false
+        include Contrib::Patcher
 
         module_function
 
-        def patch
-          return false unless compatible?
-          return @patched if @patched
+        def target_version
+          Integration.version
+        end
 
-          require 'ddtrace/ext/grpc'
+        def patch
           require 'ddtrace/propagation/grpc_propagator'
           require 'ddtrace/contrib/grpc/datadog_interceptor'
           require 'ddtrace/contrib/grpc/intercept_with_datadog'
 
-          add_pin
           prepend_interceptor
-
-          @patched = true
-        rescue StandardError => e
-          Datadog::Tracer.log.error("Unable to apply gRPC integration: #{e}")
-        ensure
-          @patched
-        end
-
-        def compatible?
-          defined?(::GRPC::VERSION) && Gem::Version.new(::GRPC::VERSION) >= Gem::Version.new('0.10.0')
-        end
-
-        def patched?
-          @patched
-        end
-
-        def add_pin
-          Pin.new(
-            get_option(:service_name),
-            app: 'grpc',
-            app_type: 'grpc',
-            tracer: get_option(:tracer)
-          ).onto(::GRPC)
         end
 
         def prepend_interceptor
           ::GRPC::InterceptionContext
-            .prepend(Datadog::Contrib::GRPC::InterceptWithDatadog)
+            .send(:prepend, Datadog::Contrib::GRPC::InterceptWithDatadog)
         end
       end
     end

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

@@ -0,0 +1,37 @@
+module Datadog
+  module Contrib
+    module HTTP
+      # HTTP integration circuit breaker behavior
+      # For avoiding recursive traces.
+      module CircuitBreaker
+        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
+          active = tracer.active_span
+          return true if active && (active.name == Ext::SPAN_REQUEST)
+
+          false
+        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 soft-check on HTTP requests.
+        #       Remove this when transport implements its own "skip tracing" mechanism.
+        def datadog_http_request?(request)
+          if request[Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION]
+            true
+          else
+            false
+          end
+        end
+
+        def should_skip_distributed_tracing?(pin)
+          return !pin.config[:distributed_tracing] if pin.config && pin.config.key?(:distributed_tracing)
+
+          !Datadog.configuration[:http][:distributed_tracing]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/http/ext'
+
+module Datadog
+  module Contrib
+    module HTTP
+      module Configuration
+        # Custom settings for the HTTP 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/http/ext.rb

@@ -0,0 +1,17 @@
+module Datadog
+  module Contrib
+    module HTTP
+      # HTTP integration constants
+      module Ext
+        APP = 'net/http'.freeze
+        ENV_ENABLED = 'DD_TRACE_HTTP_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'net/http'.freeze
+        SPAN_REQUEST = 'http.request'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,179 @@
+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'
+require 'ddtrace/contrib/http_annotation_helper'
+
+module Datadog
+  module Contrib
+    module HTTP
+      # Instrumentation for Net::HTTP
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Span hook invoked after request is completed.
+        def self.after_request(&block)
+          if block
+            # Set hook
+            @after_request = block
+          else
+            # Get hook
+            @after_request ||= nil
+          end
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          include Datadog::Contrib::HttpAnnotationHelper
+
+          # :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
+
+            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
+                # even though service_name might already be in request_options,
+                # we need to capture the name from the pin since it could be
+                # overridden
+                request_options[:service_name] = pin.service_name
+                span.service = service_name(host, request_options)
+                span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
+                span.resource = req.method
+
+                if pin.tracer.enabled && !Datadog::Contrib::HTTP.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
+                Datadog.logger.error("error preparing span for http request: #{e}")
+              ensure
+                response = super(req, body, &block)
+              end
+
+              # Add additional response specific tags to the span.
+              annotate_span_with_response!(span, response)
+
+              # Invoke hook, if set.
+              unless Contrib::HTTP::Instrumentation.after_request.nil?
+                Contrib::HTTP::Instrumentation.after_request.call(span, self, req, response)
+              end
+
+              response
+            end
+          end
+
+          def annotate_span_with_request!(span, request, request_options)
+            span.set_tag(Datadog::Ext::HTTP::URL, request.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, request.method)
+
+            host, port = host_and_port(request)
+            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
+
+          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
+              span.set_error(response)
+            end
+          end
+
+          def annotate_span_with_error!(span, error)
+            span.set_error(error)
+          end
+
+          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
+
+          def datadog_pin(config = Datadog.configuration[:http])
+            service = config[:service_name]
+            tracer = config[:tracer]
+
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              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
+            # would cause the :default config to be used. If a request is then
+            # run for a hostname that matches a different configuration, we
+            # would use the wrong configs since the pin is memoized.
+            # The solution is to detect if we are using the default config and
+            # apply the new config if necessary, while still allowing custom
+            # values to be supplied
+            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[:http]
+            service = config[:service_name]
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
+          end
+
+          private
+
+          def host_and_port(request)
+            if request.respond_to?(:uri) && request.uri
+              [request.uri.host, request.uri.port]
+            else
+              [@address, @port]
+            end
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:http, host]
+          end
+
+          def analytics_enabled?(request_options)
+            Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+          end
+
+          def analytics_sample_rate(request_options)
+            request_options[:analytics_sample_rate]
+          end
+        end
+      end
+    end
+  end
+end