ddtrace 0.53.0 → 1.0.0.beta1

data/lib/ddtrace/contrib/active_job/events.rb

@@ -1,39 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/active_job/events/discard'
-require 'ddtrace/contrib/active_job/events/enqueue'
-require 'ddtrace/contrib/active_job/events/enqueue_at'
-require 'ddtrace/contrib/active_job/events/enqueue_retry'
-require 'ddtrace/contrib/active_job/events/perform'
-require 'ddtrace/contrib/active_job/events/retry_stopped'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      # Defines collection of instrumented ActiveJob events
-      module Events
-        ALL = [
-          Events::Discard,
-          Events::Enqueue,
-          Events::EnqueueAt,
-          Events::EnqueueRetry,
-          Events::Perform,
-          Events::RetryStopped,
-        ].freeze
-
-        module_function
-
-        def all
-          self::ALL
-        end
-
-        def subscriptions
-          all.collect(&:subscriptions).collect(&:to_a).flatten
-        end
-
-        def subscribe!
-          all.each(&:subscribe!)
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module ActiveJob
-      module Ext
-        APP = 'active_job'.freeze
-        SERVICE_NAME = 'active_job'.freeze
-
-        ENV_ENABLED = 'DD_TRACE_ACTIVE_JOB_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTIVE_JOB_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTIVE_JOB_ANALYTICS_SAMPLE_RATE'.freeze
-
-        SPAN_DISCARD = 'active_job.discard'.freeze
-        SPAN_ENQUEUE = 'active_job.enqueue'.freeze
-        SPAN_ENQUEUE_RETRY = 'active_job.enqueue_retry'.freeze
-        SPAN_PERFORM = 'active_job.perform'.freeze
-        SPAN_RETRY_STOPPED = 'active_job.retry_stopped'.freeze
-
-        TAG_ADAPTER = 'active_job.adapter'.freeze
-        TAG_JOB_ERROR = 'active_job.job.error'.freeze
-        TAG_JOB_EXECUTIONS = 'active_job.job.executions'.freeze
-        TAG_JOB_ID = 'active_job.job.id'.freeze
-        TAG_JOB_PRIORITY = 'active_job.job.priority'.freeze
-        TAG_JOB_QUEUE = 'active_job.job.queue'.freeze
-        TAG_JOB_RETRY_WAIT = 'active_job.job.retry_wait'.freeze
-        TAG_JOB_SCHEDULED_AT = 'active_job.job.scheduled_at'.freeze
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/active_job/configuration/settings'
-require 'ddtrace/contrib/active_job/patcher'
-require 'ddtrace/contrib/rails/utils'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      # Describes the ActiveJob integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('4.2')
-
-        register_as :active_job, auto_patch: false
-
-        def self.version
-          Gem.loaded_specs['activejob'] && Gem.loaded_specs['activejob'].version
-        end
-
-        def self.loaded?
-          !defined?(::ActiveJob).nil?
-        end
-
-        def self.compatible?
-          super && version >= MINIMUM_VERSION
-        end
-
-        # enabled by rails integration so should only auto instrument
-        # if detected that it is being used without rails
-        def auto_instrument?
-          !Datadog::Contrib::Rails::Utils.railtie_supported?
-        end
-
-        def default_configuration
-          Configuration::Settings.new
-        end
-
-        def patcher
-          ActiveJob::Patcher
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_job/log_injection.rb

@@ -1,21 +0,0 @@
-# typed: false
-module Datadog
-  module Contrib
-    module ActiveJob
-      # Active Job log injection wrapped around job execution
-      module LogInjection
-        def self.included(base)
-          base.class_eval do
-            around_perform do |_, block|
-              if logger.respond_to?(:tagged)
-                logger.tagged(Datadog.tracer.active_correlation.to_s, &block)
-              else
-                block.call
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/active_job/ext'
-require 'ddtrace/contrib/active_job/events'
-require 'ddtrace/contrib/active_job/log_injection'
-
-module Datadog
-  module Contrib
-    module ActiveJob
-      # Patcher enables patching of 'active_job' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          Events.subscribe!
-          inject_log_correlation if Datadog.configuration[:active_job][:log_injection]
-        end
-
-        def inject_log_correlation
-          ::ActiveSupport.on_load(:active_job) do
-            include LogInjection
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/active_model_serializers/ext'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      module Configuration
-        # Custom settings for the ActiveModelSerializers 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/active_model_serializers/event.rb

@@ -1,69 +0,0 @@
-# typed: true
-require 'ddtrace/ext/http'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/active_support/notifications/event'
-require 'ddtrace/contrib/active_model_serializers/ext'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      # Defines basic behaviors for an ActiveModelSerializers event.
-      module Event
-        def self.included(base)
-          base.include(ActiveSupport::Notifications::Event)
-          base.extend(ClassMethods)
-        end
-
-        # Class methods for ActiveModelSerializers events.
-        # Note, they share the same process method and before_trace method.
-        module ClassMethods
-          def span_options
-            { service: configuration[:service_name] }
-          end
-
-          def tracer
-            -> { configuration[:tracer] }
-          end
-
-          def configuration
-            Datadog.configuration[:active_model_serializers]
-          end
-
-          def process(span, event, _id, payload)
-            span.service = configuration[:service_name]
-
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-
-            # Measure service stats
-            Contrib::Analytics.set_measured(span)
-
-            # Set the resource name and serializer name
-            res = resource(payload[:serializer])
-            span.resource = res
-            span.set_tag(Ext::TAG_SERIALIZER, res)
-
-            span.span_type = Datadog::Ext::HTTP::TEMPLATE
-
-            # Will be nil in 0.9
-            span.set_tag(Ext::TAG_ADAPTER, payload[:adapter].class) unless payload[:adapter].nil?
-          end
-
-          private
-
-          def resource(serializer)
-            # Depending on the version of ActiveModelSerializers
-            # serializer will be a string or an object.
-            if serializer.respond_to?(:name)
-              serializer.name
-            else
-              serializer
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_model_serializers/events/render.rb

@@ -1,33 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/active_model_serializers/ext'
-require 'ddtrace/contrib/active_model_serializers/event'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      module Events
-        # Defines instrumentation for render.active_model_serializers event
-        module Render
-          include ActiveModelSerializers::Event
-
-          EVENT_NAME = 'render.active_model_serializers'.freeze
-
-          module_function
-
-          def supported?
-            Gem.loaded_specs['active_model_serializers'] \
-              && Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.10')
-          end
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_RENDER
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_model_serializers/events/serialize.rb

@@ -1,36 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/active_model_serializers/ext'
-require 'ddtrace/contrib/active_model_serializers/event'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      module Events
-        # Defines instrumentation for !serialize.active_model_serializers event
-        module Serialize
-          include ActiveModelSerializers::Event
-
-          EVENT_NAME = '!serialize.active_model_serializers'.freeze
-
-          module_function
-
-          def supported?
-            Gem.loaded_specs['active_model_serializers'] \
-              && ( \
-                Gem.loaded_specs['active_model_serializers'].version >= Gem::Version.new('0.9') \
-                && Gem.loaded_specs['active_model_serializers'].version < Gem::Version.new('0.10') \
-              )
-          end
-
-          def event_name
-            self::EVENT_NAME
-          end
-
-          def span_name
-            Ext::SPAN_SERIALIZE
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_model_serializers/events.rb

@@ -1,31 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/active_model_serializers/events/render'
-require 'ddtrace/contrib/active_model_serializers/events/serialize'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      # Defines collection of instrumented ActiveModelSerializers events
-      module Events
-        ALL = [
-          Events::Render,
-          Events::Serialize
-        ].freeze
-
-        module_function
-
-        def all
-          self::ALL
-        end
-
-        def subscriptions
-          all.collect(&:subscriptions).collect(&:to_a).flatten
-        end
-
-        def subscribe!
-          all.each(&:subscribe!)
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      # ActiveModelSerializers integration constants
-      module Ext
-        APP = 'active_model_serializers'.freeze
-        ENV_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_ACTIVE_MODEL_SERIALIZERS_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'active_model_serializers'.freeze
-        SPAN_RENDER = 'active_model_serializers.render'.freeze
-        SPAN_SERIALIZE = 'active_model_serializers.serialize'.freeze
-        TAG_ADAPTER = 'active_model_serializers.adapter'.freeze
-        TAG_SERIALIZER = 'active_model_serializers.serializer'.freeze
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/active_model_serializers/configuration/settings'
-require 'ddtrace/contrib/active_model_serializers/patcher'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      # Description of ActiveModelSerializers integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('0.9.0')
-
-        register_as :active_model_serializers
-
-        def self.version
-          Gem.loaded_specs['active_model_serializers'] \
-            && Gem.loaded_specs['active_model_serializers'].version
-        end
-
-        def self.loaded?
-          !defined?(::ActiveModel::Serializer).nil? \
-            && !defined?(::ActiveSupport::Notifications).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/active_model_serializers/patcher.rb

@@ -1,30 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/active_model_serializers/ext'
-require 'ddtrace/contrib/active_model_serializers/events'
-
-module Datadog
-  module Contrib
-    module ActiveModelSerializers
-      # Patcher enables patching of 'active_model_serializers' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          Events.subscribe!
-        end
-
-        def get_option(option)
-          Datadog.configuration[:active_model_serializers].get_option(option)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/active_record/configuration/makara_resolver.rb

@@ -1,31 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module ActiveRecord
-      module Configuration
-        # The `makara` gem has the concept of **role**, which can be
-        # inferred from the configuration `name`, in the form of:
-        # `master/0`, `replica/0`, `replica/1`, etc.
-        # The first part of this string is the database role.
-        #
-        # This allows the matching of a connection based on its role,
-        # instead of connection-specific information.
-        module MakaraResolver
-          def normalize_for_config(active_record_config)
-            hash = super
-            hash[:makara_role] = active_record_config[:makara_role]
-            hash
-          end
-
-          def normalize_for_resolve(active_record_config)
-            hash = super
-
-            hash[:makara_role] = active_record_config[:name].split('/')[0].to_s if active_record_config[:name].is_a?(String)
-
-            hash
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,135 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/resolver'
-require 'ddtrace/vendor/active_record/connection_specification'
-require_relative 'makara_resolver'
-
-module Datadog
-  module Contrib
-    module ActiveRecord
-      module Configuration
-        # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
-        #
-        # When matching using a Hash, these are the valid fields:
-        # ```
-        # {
-        #   adapter: ...,
-        #   host: ...,
-        #   port: ...,
-        #   database: ...,
-        #   username: ...,
-        #   role: ...,
-        # }
-        # ```
-        #
-        # Partial matching is supported: not including certain fields or setting them to `nil`
-        # will cause them to matching all values for that field. For example: `database: nil`
-        # will match any database, given the remaining fields match.
-        #
-        # Any fields not listed above are discarded.
-        #
-        # When more than one configuration could be matched, the last one to match is selected,
-        # based on addition order (`#add`).
-        class Resolver < Contrib::Configuration::Resolver
-          prepend MakaraResolver
-
-          def initialize(active_record_configuration = nil)
-            super()
-
-            @active_record_configuration = active_record_configuration
-          end
-
-          def active_record_configuration
-            @active_record_configuration || ::ActiveRecord::Base.configurations
-          end
-
-          def add(matcher, value)
-            parsed = parse_matcher(matcher)
-
-            # In case of error parsing, don't store `nil` key
-            # as it wouldn't be useful for matching configuration
-            # hashes in `#resolve`.
-            super(parsed, value) if parsed
-          end
-
-          def resolve(db_config)
-            active_record_config = resolve_connection_key(db_config).symbolize_keys
-
-            hash = normalize_for_resolve(active_record_config)
-
-            # Hashes in Ruby maintain insertion order
-            _, config = @configurations.reverse_each.find do |matcher, _|
-              matcher.none? do |key, value|
-                value != hash[key]
-              end
-            end
-
-            config
-          rescue => e
-            Datadog.logger.error(
-              "Failed to resolve ActiveRecord configuration key #{db_config.inspect}. " \
-              "Cause: #{e.message} Source: #{Array(e.backtrace).first}"
-            )
-
-            nil
-          end
-
-          protected
-
-          def parse_matcher(matcher)
-            resolved_pattern = resolve_connection_key(matcher).symbolize_keys
-            normalized = normalize_for_config(resolved_pattern)
-
-            # Remove empty fields to allow for partial matching
-            normalized.reject! { |_, v| v.nil? }
-
-            normalized
-          rescue => e
-            Datadog.logger.error(
-              "Failed to resolve ActiveRecord configuration key #{matcher.inspect}. " \
-              "Cause: #{e.message} Source: #{Array(e.backtrace).first}"
-            )
-          end
-
-          def connection_resolver
-            @resolver ||= if defined?(::ActiveRecord::Base.configurations.resolve)
-                            ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
-                          elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
-                            ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
-                              active_record_configuration
-                            )
-                          else
-                            ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
-                              active_record_configuration
-                            )
-                          end
-          end
-
-          def resolve_connection_key(key)
-            result = connection_resolver.resolve(key)
-
-            if result.respond_to?(:configuration_hash) # Rails >= 6.1
-              result.configuration_hash
-            else # Rails < 6.1
-              result
-            end
-          end
-
-          # Extract only fields we'd like to match
-          # from the ActiveRecord configuration.
-          def normalize_for_config(active_record_config)
-            {
-              adapter: active_record_config[:adapter],
-              host: active_record_config[:host],
-              port: active_record_config[:port],
-              database: active_record_config[:database],
-              username: active_record_config[:username]
-            }
-          end
-
-          # Both resolvers perform the same operations for this implementation, but can be specialized
-          alias_method :normalize_for_resolve, :normalize_for_config
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/active_record/ext'
-require 'ddtrace/contrib/active_record/utils'
-
-module Datadog
-  module Contrib
-    module ActiveRecord
-      module Configuration
-        # Custom settings for the ActiveRecord 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 :orm_service_name
-          option :service_name do |o|
-            o.default { Utils.adapter_name }
-            o.lazy
-          end
-        end
-      end
-    end
-  end
-end