ddtrace 0.52.0 → 1.8.0

data/lib/ddtrace/contrib/excon/middleware.rb

@@ -1,164 +0,0 @@
-# typed: ignore
-require 'excon'
-require 'ddtrace/ext/http'
-require 'ddtrace/ext/integration'
-require 'ddtrace/ext/net'
-require 'ddtrace/ext/distributed'
-require 'ddtrace/propagation/http_propagator'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/excon/ext'
-require 'ddtrace/contrib/http_annotation_helper'
-
-module Datadog
-  module Contrib
-    module Excon
-      # Middleware implements an excon-middleware for ddtrace instrumentation
-      class Middleware < ::Excon::Middleware::Base
-        include Datadog::Contrib::HttpAnnotationHelper
-
-        DEFAULT_ERROR_HANDLER = lambda do |response|
-          Datadog::Ext::HTTP::ERROR_RANGE.cover?(response[:status])
-        end
-
-        def initialize(stack, options = {})
-          super(stack)
-          @default_options = datadog_configuration.options_hash.merge(options)
-        end
-
-        def request_call(datum)
-          begin
-            unless datum.key?(:datadog_span)
-              @options = build_request_options!(datum)
-              tracer.trace(Ext::SPAN_REQUEST).tap do |span|
-                datum[:datadog_span] = span
-                annotate!(span, datum)
-                propagate!(span, datum) if distributed_tracing?
-              end
-            end
-          rescue StandardError => e
-            Datadog.logger.debug(e.message)
-          end
-
-          @stack.request_call(datum)
-        end
-
-        def response_call(datum)
-          @stack.response_call(datum).tap do |d|
-            handle_response(d)
-          end
-        end
-
-        def error_call(datum)
-          handle_response(datum)
-          @stack.error_call(datum)
-        end
-
-        # Returns a child class of this trace middleware
-        # With options given as defaults.
-        def self.with(options = {})
-          Class.new(self) do
-            @options = options
-
-            # rubocop:disable Style/TrivialAccessors
-            def self.options
-              @options
-            end
-
-            # default_options in this case contains our specific middleware options
-            # so we want it to take precedence in build_request_options
-            def build_request_options!(datum)
-              datadog_configuration(datum[:host]).options_hash.merge(@default_options)
-            end
-
-            def initialize(stack)
-              super(stack, self.class.options)
-            end
-          end
-        end
-
-        # Returns a copy of the default stack with the trace middleware injected
-        def self.around_default_stack
-          ::Excon.defaults[:middlewares].dup.tap do |default_stack|
-            # If the default stack contains a version of the trace middleware already...
-            existing_trace_middleware = default_stack.find { |m| m <= Middleware }
-            default_stack.delete(existing_trace_middleware) if existing_trace_middleware
-
-            # Inject after the ResponseParser middleware
-            response_middleware_index = default_stack.index(::Excon::Middleware::ResponseParser).to_i
-            default_stack.insert(response_middleware_index + 1, self)
-          end
-        end
-
-        private
-
-        def tracer
-          @options[:tracer]
-        end
-
-        def analytics_enabled?
-          Contrib::Analytics.enabled?(@options[:analytics_enabled])
-        end
-
-        def analytics_sample_rate
-          @options[:analytics_sample_rate]
-        end
-
-        def distributed_tracing?
-          @options[:distributed_tracing] == true && tracer.enabled
-        end
-
-        def error_handler
-          @options[:error_handler] || DEFAULT_ERROR_HANDLER
-        end
-
-        def annotate!(span, datum)
-          span.resource = datum[:method].to_s.upcase
-          span.service = service_name(datum[:host], @options)
-          span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
-
-          # 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?
-
-          span.set_tag(Datadog::Ext::HTTP::URL, datum[:path])
-          span.set_tag(Datadog::Ext::HTTP::METHOD, datum[:method].to_s.upcase)
-          span.set_tag(Datadog::Ext::NET::TARGET_HOST, datum[:host])
-          span.set_tag(Datadog::Ext::NET::TARGET_PORT, datum[:port])
-        end
-
-        def handle_response(datum)
-          if datum.key?(:datadog_span)
-            datum[:datadog_span].tap do |span|
-              return span if span.finished?
-
-              if datum.key?(:response)
-                response = datum[:response]
-                span.set_error(["Error #{response[:status]}", response[:body]]) if error_handler.call(response)
-                span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response[:status])
-              end
-              span.set_error(datum[:error]) if datum.key?(:error)
-              span.finish
-              datum.delete(:datadog_span)
-            end
-          end
-        rescue StandardError => e
-          Datadog.logger.debug(e.message)
-        end
-
-        def propagate!(span, datum)
-          Datadog::HTTPPropagator.inject!(span.context, datum[:headers])
-        end
-
-        def build_request_options!(datum)
-          @default_options.merge(datadog_configuration(datum[:host]).options_hash)
-        end
-
-        def datadog_configuration(host = :default)
-          Datadog.configuration[:excon, host]
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/patcher'
-
-module Datadog
-  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 'ddtrace/contrib/excon/middleware'
-          add_middleware
-        end
-
-        def add_middleware
-          ::Excon.defaults[:middlewares] = Middleware.around_default_stack
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/extensions.rb

@@ -1,169 +0,0 @@
-# typed: false
-require 'set'
-require 'datadog/contrib'
-require 'ddtrace/configuration/settings'
-
-module Datadog
-  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.extended(base)
-        base.extend(Helpers)
-        base.extend(Configuration)
-      end
-
-      # Helper methods for Datadog module.
-      module Helpers
-        # Returns the global integration registry.
-        #
-        # This method is not safe to use while the tracer is initializing,
-        # thus access to the registry should go through
-        # ::Datadog::Contrib::REGISTRY for internal tracer work.
-        #
-        # External use of this method is always safe.
-        def registry
-          Contrib::REGISTRY
-        end
-      end
-
-      # Configuration methods for Datadog module.
-      module Configuration
-        def configure(target = configuration, opts = {})
-          # Reconfigure core settings
-          super
-
-          # Activate integrations
-          if target.respond_to?(:integrations_pending_activation)
-            reduce_verbosity = target.respond_to?(:reduce_verbosity?) ? target.reduce_verbosity? : false
-            target.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
-
-            target.integrations_pending_activation.clear
-          end
-
-          target
-        end
-
-        # Extensions for Datadog::Configuration::Settings
-        module Settings
-          InvalidIntegrationError = Class.new(StandardError)
-
-          # The registry only holds declarative constant values and cannot be modified.
-          # This option is a no-op and will be removed in the future.
-          #
-          # @deprecated Use `Datadog.registry` instead
-          def registry
-            Datadog.logger.warn('Deprecated access to `Datadog.configuration.registry`, use `Datadog.registry` instead.' \
-                                '`Datadog.configuration.registry` will be removed in a future version.')
-            Contrib::REGISTRY
-          end
-
-          # The registry only holds declarative constant values and cannot be modified.
-          # This option is a no-op and will be removed in the future.
-          #
-          # @deprecated The registry is now a global constant, and can't be overwritten.
-          def registry=(_arg)
-            Datadog.logger.warn('Setting a custom registry is no longer supported and was ignored. ' \
-                                'Remove this assignment from your configuration to stop seeing this warning.')
-          end
-
-          # 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.
-          #
-          # @param [Symbol] integration_name the integration name
-          # @param [Object] key the integration-specific lookup key
-          # @return [Datadog::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::Contrib::Configuration::Settings]
-          def configuration(integration_name, describes = nil)
-            integration = fetch_integration(integration_name)
-            integration.configuration(describes) unless integration.nil?
-          end
-
-          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
-
-          alias_method :use, :instrument
-
-          def integrations_pending_activation
-            @integrations_pending_activation ||= Set.new
-          end
-
-          def instrumented_integrations
-            @instrumented_integrations ||= {}
-          end
-
-          def reset!
-            instrumented_integrations.clear
-            super
-          end
-
-          def fetch_integration(name)
-            Contrib::REGISTRY[name] ||
-              raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
-          end
-
-          def reduce_verbosity?
-            defined?(@reduce_verbosity) ? @reduce_verbosity : false
-          end
-
-          def reduce_log_verbosity
-            @reduce_verbosity ||= true
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,39 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/ext/http'
-require 'ddtrace/contrib/faraday/ext'
-
-module Datadog
-  module Contrib
-    module Faraday
-      module Configuration
-        # Custom settings for the Faraday integration
-        class Settings < Contrib::Configuration::Settings
-          DEFAULT_ERROR_HANDLER = lambda do |env|
-            Datadog::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, 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 :error_handler, default: DEFAULT_ERROR_HANDLER
-          option :service_name, default: Ext::SERVICE_NAME
-          option :split_by_domain, default: false
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/faraday/connection.rb

@@ -1,19 +0,0 @@
-# typed: false
-module Datadog
-  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

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

@@ -1,18 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Faraday
-      # Faraday integration constants
-      module Ext
-        APP = 'faraday'.freeze
-        ENV_ENABLED = 'DD_TRACE_FARADAY_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_FARADAY_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_FARADAY_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_FARADAY_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'faraday'.freeze
-        SPAN_REQUEST = 'faraday.request'.freeze
-      end
-    end
-  end
-end

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

@@ -1,44 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
-require 'ddtrace/contrib/faraday/configuration/settings'
-require 'ddtrace/contrib/faraday/patcher'
-
-module Datadog
-  module Contrib
-    module Faraday
-      # Description of Faraday integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('0.14.0')
-
-        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 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/faraday/middleware.rb

@@ -1,86 +0,0 @@
-# typed: ignore
-require 'faraday'
-require 'ddtrace/ext/http'
-require 'ddtrace/ext/integration'
-require 'ddtrace/ext/net'
-require 'ddtrace/propagation/http_propagator'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/faraday/ext'
-require 'ddtrace/contrib/http_annotation_helper'
-
-module Datadog
-  module Contrib
-    module Faraday
-      # Middleware implements a faraday-middleware for ddtrace instrumentation
-      class Middleware < ::Faraday::Middleware
-        include Datadog::Ext::DistributedTracing
-        include Datadog::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)
-
-          request_options[:tracer].trace(Ext::SPAN_REQUEST) do |span|
-            annotate!(span, env, request_options)
-            propagate!(span, env) if request_options[:distributed_tracing] && request_options[:tracer].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 = Datadog::Ext::HTTP::TYPE_OUTBOUND
-
-          # Tag as an external peer service
-          span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
-
-          # 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(Datadog::Ext::HTTP::URL, env[:url].path)
-          span.set_tag(Datadog::Ext::HTTP::METHOD, env[:method].to_s.upcase)
-          span.set_tag(Datadog::Ext::NET::TARGET_HOST, env[:url].host)
-          span.set_tag(Datadog::Ext::NET::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(Datadog::Ext::HTTP::STATUS_CODE, env[:status])
-        end
-
-        def propagate!(span, env)
-          Datadog::HTTPPropagator.inject!(span.context, 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

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

@@ -1,54 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/faraday/ext'
-require 'ddtrace/contrib/faraday/connection'
-require 'ddtrace/contrib/faraday/rack_builder'
-
-module Datadog
-  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 'ddtrace/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

data/lib/ddtrace/contrib/faraday/rack_builder.rb

@@ -1,19 +0,0 @@
-# typed: false
-module Datadog
-  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

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

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