ddtrace 0.43.0 → 0.45.0

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

data/lib/ddtrace/contrib/patchable.rb

@@ -42,16 +42,27 @@ module Datadog
 
         def patch
           if !self.class.patchable? || patcher.nil?
-            desc = "Available?: #{self.class.available?}"
-            desc += ", Loaded? #{self.class.loaded?}"
-            desc += ", Compatible? #{self.class.compatible?}"
-            desc += ", Patchable? #{self.class.patchable?}"
-
-            Datadog.logger.warn("Unable to patch #{self.class.name} (#{desc})")
-            return
+            return {
+              name: self.class.name,
+              available: self.class.available?,
+              loaded: self.class.loaded?,
+              compatible: self.class.compatible?,
+              patchable: self.class.patchable?
+            }
           end
 
           patcher.patch
+          true
+        end
+
+        # Can the patch for this integration be applied automatically?
+        # For example: test integrations should only be applied
+        # by the user explicitly setting `c.use :rspec`
+        # and rails sub-modules are auto-instrumented by enabling rails
+        # so auto-instrumenting them on their own will cause changes in
+        # service naming behavior
+        def auto_instrument?
+          true
         end
       end
     end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/qless/ext'
+
+module Datadog
+  module Contrib
+    module Qless
+      module Configuration
+        # Custom settings for the Qless 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 :tag_job_data do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_JOB_DATA, false) }
+            o.lazy
+          end
+
+          option :tag_job_tags do |o|
+            o.default { env_to_bool(Ext::ENV_TAG_JOB_TAGS, false) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Datadog
+  module Contrib
+    module Qless
+      # Qless integration constants
+      module Ext
+        APP = 'qless'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_QLESS_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_QLESS_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_TAG_JOB_DATA = 'DD_QLESS_TAG_JOB_DATA'.freeze
+        ENV_TAG_JOB_TAGS = 'DD_QLESS_TAG_JOB_TAGS'.freeze
+        SERVICE_NAME = 'qless'.freeze
+        SPAN_JOB = 'qless.job'.freeze
+        TAG_JOB_ID = 'qless.job.id'.freeze
+        TAG_JOB_DATA = 'qless.job.data'.freeze
+        TAG_JOB_QUEUE = 'qless.job.queue'.freeze
+        TAG_JOB_TAGS = 'qless.job.tags'.freeze
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Patcher enables patching of 'qless' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          require_relative 'qless_job'
+          require_relative 'tracer_cleaner'
+
+          # Instrument all Qless Workers
+          ::Qless::Workers::BaseWorker.class_eval do
+            # These are executed in inverse order of listing here
+            include QlessJob
+            include TracerCleaner
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:qless].get_option(option)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/qless/qless_job.rb

@@ -0,0 +1,72 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'qless'
+
+module Datadog
+  module Contrib
+    module Qless
+      # Uses Qless job hooks to create traces
+      module QlessJob
+        def around_perform(job)
+          return super unless datadog_configuration && tracer
+          tracer.trace(Ext::SPAN_JOB, span_options) do |span|
+            span.resource = job.klass_name
+            span.span_type = Datadog::Ext::AppTypes::WORKER
+            span.set_tag(Ext::TAG_JOB_ID, job.jid)
+            span.set_tag(Ext::TAG_JOB_QUEUE, job.queue_name)
+
+            tag_job_tags = datadog_configuration[:tag_job_tags]
+            span.set_tag(Ext::TAG_JOB_TAGS, job.tags) if tag_job_tags
+
+            tag_job_data = datadog_configuration[:tag_job_data]
+            if tag_job_data && !job.data.empty?
+              job_data = job.data.with_indifferent_access
+              formatted_data = job_data.except(:tags).map do |key, value|
+                "#{key}:#{value}".underscore
+              end
+
+              span.set_tag(Ext::TAG_JOB_DATA, formatted_data)
+            end
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            super
+          end
+        end
+
+        def after_fork
+          configuration = Datadog.configuration[:qless]
+          return if configuration.nil?
+
+          # Add a pin, marking the job as forked.
+          # Used to trigger shutdown in forks for performance reasons.
+          # Cleanup happens in the TracerCleaner class
+          Datadog::Pin.new(
+            configuration[:service_name],
+            config: { forked: true }
+          ).onto(::Qless)
+        end
+
+        private
+
+        def span_options
+          { service: datadog_configuration[:service_name] }
+        end
+
+        def tracer
+          datadog_configuration.tracer
+        end
+
+        def datadog_configuration
+          Datadog.configuration[:qless]
+        end
+      end
+    end
+  end
+end