ddtrace 0.54.2 → 1.0.0.beta1

data/lib/datadog/tracing/contrib/excon/patcher.rb

@@ -0,0 +1,30 @@
+# typed: false
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Excon
+        # Patcher enables patching of 'excon' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require 'datadog/tracing/contrib/excon/middleware'
+            add_middleware
+          end
+
+          def add_middleware
+            ::Excon.defaults[:middlewares] = Middleware.around_default_stack
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/extensions.rb

@@ -0,0 +1,184 @@
+# typed: false
+require 'forwardable'
+require 'set'
+
+require 'datadog/core/configuration/settings'
+require 'datadog/tracing/contrib'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Extensions that can be added to the base library
+      # Adds registry, configuration access for integrations.
+      #
+      # DEV: The Registry should probably be part of the core tracer
+      # as it represents a global tracer repository that is strongly intertwined
+      # with the tracer lifecycle and deeply modifies the tracer initialization
+      # process.
+      # Most of this file should probably live inside the tracer core.
+      module Extensions
+        def self.extend!
+          Datadog.singleton_class.prepend Helpers
+          Datadog.singleton_class.prepend Configuration
+          Core::Configuration::Settings.include Configuration::Settings
+        end
+
+        # Helper methods for Datadog module.
+        module Helpers
+          # The global integration registry.
+          #
+          # This registry holds a reference to all integrations available
+          # to the tracer.
+          #
+          # Integrations registered in the {.registry} can be activated as follows:
+          #
+          # ```
+          # Datadog.configure do |c|
+          #   c.tracing.instrument :my_registered_integration, **my_options
+          # end
+          # ```
+          #
+          # New integrations can be registered by implementing the {Datadog::Tracing::Contrib::Integration} interface.
+          #
+          # @return [Datadog::Tracing::Contrib::Registry]
+          # @!attribute [r] registry
+          # @public_api
+          def registry
+            Contrib::REGISTRY
+          end
+        end
+
+        # Configuration methods for Datadog module.
+        module Configuration
+          # TODO: Is is not possible to separate this configuration method
+          # TODO: from core ddtrace parts ()e.g. the registry).
+          # TODO: Today this method sits here in the `Datadog::Tracing::Contrib::Extensions` namespace
+          # TODO: but cannot empirically constraints to the contrib domain only.
+          # TODO: We should promote most of this logic to core parts of ddtrace.
+          def configure(&block)
+            # Reconfigure core settings
+            super(&block)
+
+            # Activate integrations
+            configuration = self.configuration
+
+            if configuration.respond_to?(:integrations_pending_activation)
+              reduce_verbosity = configuration.respond_to?(:reduce_verbosity?) ? configuration.reduce_verbosity? : false
+              configuration.integrations_pending_activation.each do |integration|
+                next unless integration.respond_to?(:patch)
+
+                # integration.patch returns either true or a hash of details on why patching failed
+                patch_results = integration.patch
+
+                next if patch_results == true
+
+                # if patching failed, only log output if verbosity is unset
+                # or if patching failure is due to compatibility or integration specific reasons
+                next unless !reduce_verbosity ||
+                            ((patch_results[:available] && patch_results[:loaded]) &&
+                            (!patch_results[:compatible] || !patch_results[:patchable]))
+
+                desc = "Available?: #{patch_results[:available]}"
+                desc += ", Loaded? #{patch_results[:loaded]}"
+                desc += ", Compatible? #{patch_results[:compatible]}"
+                desc += ", Patchable? #{patch_results[:patchable]}"
+
+                Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
+              end
+
+              configuration.integrations_pending_activation.clear
+            end
+
+            configuration
+          end
+
+          # Extensions for Datadog::Core::Configuration::Settings
+          # @public_api
+          module Settings
+            InvalidIntegrationError = Class.new(StandardError)
+
+            # For the provided `integration_name`, resolves a matching configuration
+            # for the provided integration from an integration-specific `key`.
+            #
+            # How the matching is performed is integration-specific.
+            #
+            # @example
+            #   Datadog.configuration[:integration_name]
+            # @example
+            #   Datadog.configuration[:integration_name][:sub_configuration]
+            # @param [Symbol] integration_name the integration name
+            # @param [Object] key the integration-specific lookup key
+            # @return [Datadog::Tracing::Contrib::Configuration::Settings]
+            def [](integration_name, key = :default)
+              integration = fetch_integration(integration_name)
+              integration.resolve(key) unless integration.nil?
+            end
+
+            # For the provided `integration_name`, retrieves a configuration previously
+            # stored by `#instrument`. Specifically, `describes` should be
+            # the same value provided in the `describes:` option for `#instrument`.
+            #
+            # If no `describes` value is provided, the default configuration is returned.
+            #
+            # @param [Symbol] integration_name the integration name
+            # @param [Object] describes the previously configured `describes:` object. If `nil`,
+            #   fetches the default configuration
+            # @return [Datadog::Tracing::Contrib::Configuration::Settings]
+            # @!visibility private
+            def configuration(integration_name, describes = nil)
+              integration = fetch_integration(integration_name)
+              integration.configuration(describes) unless integration.nil?
+            end
+
+            # @!visibility private
+            def integrations_pending_activation
+              @integrations_pending_activation ||= Set.new
+            end
+
+            # @!visibility private
+            def instrumented_integrations
+              @instrumented_integrations ||= {}
+            end
+
+            # @!visibility private
+            def reset!
+              instrumented_integrations.clear
+              super
+            end
+
+            # @!visibility private
+            def fetch_integration(name)
+              Contrib::REGISTRY[name] ||
+                raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+            end
+
+            # @!visibility private
+            def reduce_verbosity?
+              defined?(@reduce_verbosity) ? @reduce_verbosity : false
+            end
+
+            def reduce_log_verbosity
+              @reduce_verbosity ||= true
+            end
+
+            private
+
+            def instrument(integration_name, options = {}, &block)
+              integration = fetch_integration(integration_name)
+
+              unless integration.nil? || !integration.default_configuration.enabled
+                configuration_name = options[:describes] || :default
+                filtered_options = options.reject { |k, _v| k == :describes }
+                integration.configure(configuration_name, filtered_options, &block)
+                instrumented_integrations[integration_name] = integration
+
+                # Add to activation list
+                integrations_pending_activation << integration
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/configuration/settings.rb

@@ -0,0 +1,41 @@
+# typed: false
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/faraday/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        module Configuration
+          # Custom settings for the Faraday integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            DEFAULT_ERROR_HANDLER = lambda do |env|
+              Tracing::Metadata::Ext::HTTP::ERROR_RANGE.cover?(env[:status])
+            end
+
+            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, 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 :error_handler, default: DEFAULT_ERROR_HANDLER
+            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :split_by_domain, default: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/connection.rb

@@ -0,0 +1,21 @@
+# typed: false
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Handles installation of our middleware if the user has *not*
+        # already explicitly configured our middleware for this correction.
+        #
+        # Wraps Faraday::Connection#initialize:
+        # https://github.com/lostisland/faraday/blob/ff9dc1d1219a1bbdba95a9a4cf5d135b97247ee2/lib/faraday/connection.rb#L62-L92
+        module Connection
+          def initialize(*args, &block)
+            super.tap do
+              use(:ddtrace) unless builder.handlers.any? { |h| h.klass == Middleware }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/ext.rb

@@ -0,0 +1,20 @@
+# typed: true
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Faraday integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'faraday'.freeze
+          SPAN_REQUEST = 'faraday.request'.freeze
+          TAG_COMPONENT = 'faraday'.freeze
+          TAG_OPERATION_REQUEST = 'request'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/integration.rb

@@ -0,0 +1,47 @@
+# typed: false
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/configuration/resolvers/pattern_resolver'
+require 'datadog/tracing/contrib/faraday/configuration/settings'
+require 'datadog/tracing/contrib/faraday/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Description of Faraday integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.14.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :faraday, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['faraday'] && Gem.loaded_specs['faraday'].version
+          end
+
+          def self.loaded?
+            !defined?(::Faraday).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+
+          def resolver
+            @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -0,0 +1,92 @@
+# typed: ignore
+require 'faraday'
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/propagation/http'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/faraday/ext'
+require 'datadog/tracing/contrib/http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Middleware implements a faraday-middleware for ddtrace instrumentation
+        class Middleware < ::Faraday::Middleware
+          include Contrib::HttpAnnotationHelper
+
+          def initialize(app, options = {})
+            super(app)
+            @options = options
+          end
+
+          def call(env)
+            # Resolve configuration settings to use for this request.
+            # Do this once to reduce expensive regex calls.
+            request_options = build_request_options!(env)
+
+            Tracing.trace(Ext::SPAN_REQUEST) do |span, trace|
+              annotate!(span, env, request_options)
+              propagate!(trace, span, env) if request_options[:distributed_tracing] && Tracing.enabled?
+              app.call(env).on_complete { |resp| handle_response(span, resp, request_options) }
+            end
+          end
+
+          private
+
+          attr_reader :app
+
+          def annotate!(span, env, options)
+            span.resource = resource_name(env)
+            service_name(env[:url].host, options)
+            span.service = options[:split_by_domain] ? env[:url].host : options[:service_name]
+            span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+            span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
+
+            # Tag as an external peer service
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, env[:url].host)
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(options[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, options[:analytics_sample_rate])
+            end
+
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, env[:url].path)
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, env[:method].to_s.upcase)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, env[:url].host)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, env[:url].port)
+          end
+
+          def handle_response(span, env, options)
+            span.set_error(["Error #{env[:status]}", env[:body]]) if options.fetch(:error_handler).call(env)
+
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, env[:status])
+          end
+
+          def propagate!(trace, span, env)
+            Tracing::Propagation::HTTP.inject!(trace, env[:request_headers])
+          end
+
+          def resource_name(env)
+            env[:method].to_s.upcase
+          end
+
+          def build_request_options!(env)
+            datadog_configuration
+              .options_hash # integration level settings
+              .merge(datadog_configuration(env[:url].host).options_hash) # per-host override
+              .merge(@options) # middleware instance override
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration[:faraday, host]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/patcher.rb

@@ -0,0 +1,56 @@
+# typed: false
+require 'datadog/tracing/contrib/faraday/connection'
+require 'datadog/tracing/contrib/faraday/ext'
+require 'datadog/tracing/contrib/faraday/integration'
+require 'datadog/tracing/contrib/faraday/rack_builder'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Patcher enables patching of 'faraday' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require 'datadog/tracing/contrib/faraday/middleware'
+
+            register_middleware!
+            add_default_middleware!
+          end
+
+          def register_middleware!
+            ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
+          end
+
+          def add_default_middleware!
+            if target_version >= Gem::Version.new('1.0.0')
+              # Patch the default connection (e.g. +Faraday.get+)
+              ::Faraday.default_connection.use(:ddtrace)
+
+              # Patch new connection instances (e.g. +Faraday.new+)
+              ::Faraday::Connection.prepend(Connection)
+            else
+              # Patch the default connection (e.g. +Faraday.get+)
+              #
+              # We insert our middleware before the 'adapter', which is
+              # always the last handler.
+              idx = ::Faraday.default_connection.builder.handlers.size - 1
+              ::Faraday.default_connection.builder.insert(idx, Middleware)
+
+              # Patch new connection instances (e.g. +Faraday.new+)
+              ::Faraday::RackBuilder.prepend(RackBuilder)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/rack_builder.rb

@@ -0,0 +1,21 @@
+# typed: false
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Handles installation of our middleware if the user has *not*
+        # already explicitly configured it for this correction.
+        #
+        # RackBuilder class was introduced in faraday 0.9.0:
+        # https://github.com/lostisland/faraday/commit/77d7546d6d626b91086f427c56bc2cdd951353b3
+        module RackBuilder
+          def adapter(*args)
+            use(:ddtrace) unless @handlers.any? { |h| h.klass == Middleware }
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/grape/configuration/settings.rb

@@ -0,0 +1,41 @@
+# typed: false
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/grape/ext'
+require 'datadog/tracing/contrib/status_code_matcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        module Configuration
+          # Custom settings for the Grape integration
+          # @public_api
+          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, nil) }
+              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
+
+            option :error_statuses, default: nil do |o|
+              o.setter do |new_value, _old_value|
+                Contrib::StatusCodeMatcher.new(new_value) unless new_value.nil?
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end