ddtrace 0.54.2 → 1.0.0.beta1

data/lib/ddtrace/contrib/configuration/resolver.rb

@@ -1,82 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Configuration
-      # Resolves an integration-specific matcher to an associated
-      # object.
-      #
-      # Integrations that perform any configuration matching
-      # based on patterns might want to override this class
-      # to provide richer matching. For example, match configuration
-      # based on: HTTP request parameters, request headers,
-      # async queue name.
-      #
-      # When overriding this class, for simple use cases, only
-      # overriding `#parse_matcher` might suffice. See
-      # `#parse_matcher`'s documentation for more information.
-      class Resolver
-        attr_reader :configurations
-
-        def initialize
-          @configurations = {}
-        end
-
-        # Adds a new `matcher`, associating with it a `value`.
-        #
-        # This `value` is returned when `#resolve` is called
-        # with a matching value for this matcher. When multiple
-        # matchers would match, `#resolve` returns the latest
-        # added one.
-        #
-        # The `matcher` can be transformed internally by the
-        # `#parse_matcher` method before being stored.
-        #
-        # The `value` can also be retrieved by calling `#get`
-        # with the same `matcher` added by this method.
-        #
-        # @param [Object] matcher integration-specific matcher
-        # @param [Object] value arbitrary value to be associated with `matcher`
-        def add(matcher, value)
-          @configurations[parse_matcher(matcher)] = value
-        end
-
-        # Retrieves the stored value for a `matcher`
-        # previously stored by `#add`.
-        #
-        # @param [Object] matcher integration-specific matcher
-        # @return [Object] previously stored `value` from `#add`, or `nil` if not found
-        def get(matcher)
-          @configurations[parse_matcher(matcher)]
-        end
-
-        # Matches an arbitrary value against the configured
-        # matchers previously set with `#add`.
-        #
-        # If multiple matchers would match, returns the latest one.
-        #
-        # @param [Object] value integration-specific value
-        # @return [Object] matching `value` configured at `#add`, or `nil` if none match
-        def resolve(value)
-          @configurations[value]
-        end
-
-        protected
-
-        # Converts `matcher` into an appropriate key
-        # for the internal Hash storage.
-        #
-        # It's recommended to override this method,
-        # instead of the public methods, if the
-        # integration can simply convert both
-        # `matcher` (provided to `#add`) and `value`
-        # (provided to `#resolve`) to the same value.
-        #
-        # @param [Object] matcher integration-specific matcher
-        # @return [Object] processed matcher
-        def parse_matcher(matcher)
-          matcher
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/configuration/resolvers/pattern_resolver.rb

@@ -1,40 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/configuration/resolver'
-
-module Datadog
-  module Contrib
-    module Configuration
-      # Resolves a value to a configuration key
-      module Resolvers
-        # Matches Strings and Regexps against `object.to_s` objects
-        # and Procs against plain objects.
-        class PatternResolver < Contrib::Configuration::Resolver
-          def resolve(value)
-            return if configurations.empty?
-
-            # Try to find a matching pattern
-            _, config = configurations.reverse_each.find do |matcher, _|
-              matcher === if matcher.is_a?(Proc)
-                            value
-                          else
-                            value.to_s
-                          end
-            end
-
-            config
-          end
-
-          protected
-
-          def parse_matcher(matcher)
-            if matcher.is_a?(Regexp) || matcher.is_a?(Proc)
-              matcher
-            else
-              matcher.to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-# typed: false
-require 'ddtrace/configuration/base'
-require 'ddtrace/utils/only_once'
-
-module Datadog
-  module Contrib
-    module Configuration
-      # Common settings for all integrations
-      class Settings
-        include Datadog::Configuration::Base
-
-        DEPRECATION_WARN_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
-
-        option :analytics_enabled, default: false
-        option :analytics_sample_rate, default: 1.0
-        option :enabled, default: true
-        option :service_name
-        option :tracer do |o|
-          o.delegate_to { Datadog.tracer }
-          o.on_set do |_value|
-            log_deprecation_warning
-          end
-        end
-
-        def configure(options = {})
-          self.class.options.dependency_order.each do |name|
-            self[name] = options[name] if options.key?(name)
-          end
-
-          yield(self) if block_given?
-        end
-
-        def [](name)
-          respond_to?(name) ? send(name) : get_option(name)
-        end
-
-        def []=(name, value)
-          respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
-        end
-
-        DEPRECATION_WARNING = %(
-          Explicitly providing a tracer instance is DEPRECATED.
-          It's recommended to not provide an explicit tracer instance
-          and let Datadog::Contrib::Configuration::Settings resolve
-          the correct tracer internally.
-          ).freeze
-
-        def log_deprecation_warning
-          DEPRECATION_WARN_ONLY_ONCE.run do
-            Datadog.logger.warn("tracer:#{DEPRECATION_WARNING}:#{caller.join("\n")}")
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/dalli/ext'
-
-module Datadog
-  module Contrib
-    module Dalli
-      module Configuration
-        # Custom settings for the Dalli 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 :service_name, default: Ext::SERVICE_NAME
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Dalli
-      # Dalli integration constants
-      module Ext
-        APP = 'dalli'.freeze
-        ENV_ENABLED = 'DD_TRACE_DALLI_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_DALLI_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_DALLI_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_DALLI_ANALYTICS_SAMPLE_RATE'.freeze
-        QUANTIZE_MAX_CMD_LENGTH = 100
-        SERVICE_NAME = 'memcached'.freeze
-        SPAN_COMMAND = 'memcached.command'.freeze
-        SPAN_TYPE_COMMAND = 'memcached'.freeze
-        TAG_COMMAND = 'memcached.command'.freeze
-      end
-    end
-  end
-end

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

@@ -1,55 +0,0 @@
-# typed: false
-require 'ddtrace/ext/integration'
-require 'ddtrace/ext/net'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/dalli/ext'
-require 'ddtrace/contrib/dalli/quantize'
-
-module Datadog
-  module Contrib
-    module Dalli
-      # Instruments every interaction with the memcached server
-      module Instrumentation
-        def self.included(base)
-          base.prepend(InstanceMethods)
-        end
-
-        # InstanceMethods - implementing instrumentation
-        module InstanceMethods
-          def request(op, *args)
-            tracer.trace(Datadog::Contrib::Dalli::Ext::SPAN_COMMAND) do |span|
-              span.resource = op.to_s.upcase
-              span.service = datadog_configuration[:service_name]
-              span.span_type = Datadog::Contrib::Dalli::Ext::SPAN_TYPE_COMMAND
-
-              # 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?(datadog_configuration[:analytics_enabled])
-                Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
-              end
-
-              span.set_tag(Datadog::Ext::NET::TARGET_HOST, hostname)
-              span.set_tag(Datadog::Ext::NET::TARGET_PORT, port)
-              cmd = Datadog::Contrib::Dalli::Quantize.format_command(op, args)
-              span.set_tag(Datadog::Contrib::Dalli::Ext::TAG_COMMAND, cmd)
-
-              super
-            end
-          end
-
-          private
-
-          def tracer
-            datadog_configuration[:tracer]
-          end
-
-          def datadog_configuration
-            Datadog.configuration[:dalli, "#{hostname}:#{port}"] || Datadog.configuration[:dalli]
-          end
-        end
-      end
-    end
-  end
-end

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

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

@@ -1,26 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/dalli/ext'
-require 'ddtrace/contrib/dalli/instrumentation'
-
-module Datadog
-  module Contrib
-    module Dalli
-      # Patcher enables patching of 'dalli' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          ::Dalli::Server.include(Instrumentation)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/dalli/quantize.rb

@@ -1,23 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/dalli/ext'
-
-module Datadog
-  module Contrib
-    module Dalli
-      # Quantize contains dalli-specic quantization tools.
-      module Quantize
-        module_function
-
-        def format_command(operation, args)
-          placeholder = "#{operation} BLOB (OMITTED)"
-          command = [operation, *args].join(' ').strip
-          command = Utils.utf8_encode(command, binary: true, placeholder: placeholder)
-          Utils.truncate(command, Ext::QUANTIZE_MAX_CMD_LENGTH)
-        rescue => e
-          Datadog.logger.debug("Error sanitizing Dalli operation: #{e}")
-          placeholder
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/delayed_job/ext'
-
-module Datadog
-  module Contrib
-    module DelayedJob
-      module Configuration
-        # Custom settings for the DelayedJob 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 :service_name, default: Ext::SERVICE_NAME
-          option :client_service_name, default: Ext::CLIENT_SERVICE_NAME
-          option :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
-        end
-      end
-    end
-  end
-end

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

@@ -1,24 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module DelayedJob
-      # DelayedJob integration constants
-      module Ext
-        APP = 'delayed_job'.freeze
-        ENV_ENABLED = 'DD_TRACE_DELAYED_JOB_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_DELAYED_JOB_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_DELAYED_JOB_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'delayed_job'.freeze
-        CLIENT_SERVICE_NAME = 'delayed_job-client'.freeze
-        SPAN_JOB = 'delayed_job'.freeze
-        SPAN_ENQUEUE = 'delayed_job.enqueue'.freeze
-        TAG_ATTEMPTS = 'delayed_job.attempts'.freeze
-        TAG_ID = 'delayed_job.id'.freeze
-        TAG_PRIORITY = 'delayed_job.priority'.freeze
-        TAG_QUEUE = 'delayed_job.queue'.freeze
-      end
-    end
-  end
-end

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

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

@@ -1,29 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
-
-module Datadog
-  module Contrib
-    module DelayedJob
-      # Patcher enables patching of 'delayed_job' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          require 'ddtrace/contrib/delayed_job/plugin'
-          add_instrumentation(::Delayed::Worker)
-        end
-
-        def add_instrumentation(klass)
-          klass.plugins << Plugin
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/delayed_job/plugin.rb

@@ -1,85 +0,0 @@
-# typed: ignore
-require 'delayed/plugin'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/delayed_job/ext'
-
-module Datadog
-  module Contrib
-    module DelayedJob
-      # DelayedJob plugin that instruments invoke_job hook
-      class Plugin < Delayed::Plugin
-        def self.instrument_invoke(job, &block)
-          return yield(job) unless tracer && tracer.enabled
-
-          tracer.trace(Ext::SPAN_JOB, service: configuration[:service_name], resource: job_name(job),
-                                      on_error: configuration[:error_handler]) do |span|
-            set_sample_rate(span)
-
-            # Measure service stats
-            Contrib::Analytics.set_measured(span)
-
-            span.set_tag(Ext::TAG_ID, job.id)
-            span.set_tag(Ext::TAG_QUEUE, job.queue) if job.queue
-            span.set_tag(Ext::TAG_PRIORITY, job.priority)
-            span.set_tag(Ext::TAG_ATTEMPTS, job.attempts)
-            span.span_type = Datadog::Ext::AppTypes::WORKER
-
-            yield job
-          end
-        end
-
-        def self.instrument_enqueue(job, &block)
-          return yield(job) unless tracer && tracer.enabled
-
-          tracer.trace(Ext::SPAN_ENQUEUE, service: configuration[:client_service_name], resource: job_name(job)) do |span|
-            set_sample_rate(span)
-
-            # Measure service stats
-            Contrib::Analytics.set_measured(span)
-
-            span.set_tag(Ext::TAG_QUEUE, job.queue) if job.queue
-            span.set_tag(Ext::TAG_PRIORITY, job.priority)
-            span.span_type = Datadog::Ext::AppTypes::WORKER
-
-            yield job
-          end
-        end
-
-        def self.flush(worker, &block)
-          yield worker
-
-          tracer.shutdown! if tracer && tracer.enabled
-        end
-
-        def self.configuration
-          Datadog.configuration[:delayed_job]
-        end
-
-        def self.tracer
-          configuration[:tracer]
-        end
-
-        def self.job_name(job)
-          # When DelayedJob is used through ActiveJob, we need to parse the payload differentely
-          # to get the actual job name
-          return job.payload_object.job_data['job_class'] if job.payload_object.respond_to?(:job_data)
-
-          job.name
-        end
-
-        def self.set_sample_rate(span)
-          # Set analytics sample rate
-          if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-            Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-          end
-        end
-
-        callbacks do |lifecycle|
-          lifecycle.around(:invoke_job, &method(:instrument_invoke))
-          lifecycle.around(:enqueue, &method(:instrument_enqueue))
-          lifecycle.around(:execute, &method(:flush))
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/elasticsearch/ext'
-
-module Datadog
-  module Contrib
-    module Elasticsearch
-      module Configuration
-        # Custom settings for the Elasticsearch 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 :quantize, default: {}
-          option :service_name, default: Ext::SERVICE_NAME
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Elasticsearch
-      # Elasticsearch integration constants
-      module Ext
-        APP = 'elasticsearch'.freeze
-        ENV_ENABLED = 'DD_TRACE_ELASTICSEARCH_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_ELASTICSEARCH_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ELASTICSEARCH_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'elasticsearch'.freeze
-        SPAN_QUERY = 'elasticsearch.query'.freeze
-        SPAN_TYPE_QUERY = 'elasticsearch'.freeze
-        TAG_BODY = 'elasticsearch.body'.freeze
-        TAG_METHOD = 'elasticsearch.method'.freeze
-        TAG_PARAMS = 'elasticsearch.params'.freeze
-        TAG_URL = 'elasticsearch.url'.freeze
-      end
-    end
-  end
-end