ddtrace 0.54.2 → 1.0.0.beta1

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -1,64 +0,0 @@
-# typed: false
-require 'ddtrace/ext/sql'
-require 'ddtrace/ext/app_types'
-require 'ddtrace/contrib/analytics'
-require 'ddtrace/contrib/sequel/ext'
-require 'ddtrace/contrib/sequel/utils'
-
-module Datadog
-  module Contrib
-    module Sequel
-      # Adds instrumentation to Sequel::Dataset
-      module Dataset
-        def self.included(base)
-          base.prepend(InstanceMethods)
-        end
-
-        # Instance methods for instrumenting Sequel::Dataset
-        module InstanceMethods
-          def execute(sql, options = ::Sequel::OPTS, &block)
-            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
-          end
-
-          def execute_ddl(sql, options = ::Sequel::OPTS, &block)
-            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
-          end
-
-          def execute_dui(sql, options = ::Sequel::OPTS, &block)
-            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
-          end
-
-          def execute_insert(sql, options = ::Sequel::OPTS, &block)
-            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
-          end
-
-          def datadog_pin
-            Datadog::Pin.get_from(db)
-          end
-
-          private
-
-          def trace_execute(super_method, sql, options, &block)
-            opts = Utils.parse_opts(sql, options, db.opts, self)
-            response = nil
-
-            datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
-              span.service = datadog_pin.service
-              span.resource = opts[:query]
-              span.span_type = Datadog::Ext::SQL::TYPE
-              Utils.set_common_tags(span)
-              span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
-              span.set_tag(Ext::TAG_PREPARED_NAME, opts[:prepared_name]) if opts[:prepared_name]
-              response = super_method.call(sql, options, &block)
-            end
-            response
-          end
-
-          def adapter_name
-            Utils.adapter_name(db)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,20 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Sequel
-      # Sequel integration constants
-      module Ext
-        APP = 'sequel'.freeze
-        ENV_ENABLED = 'DD_TRACE_SEQUEL_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SEQUEL_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_SEQUEL_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'sequel'.freeze
-        SPAN_QUERY = 'sequel.query'.freeze
-        TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
-        TAG_PREPARED_NAME = 'sequel.prepared.name'.freeze
-      end
-    end
-  end
-end

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

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

@@ -1,34 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/patcher'
-require 'ddtrace/contrib/sequel/database'
-require 'ddtrace/contrib/sequel/dataset'
-
-module Datadog
-  module Contrib
-    module Sequel
-      # Patcher enables patching of 'sequel' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          patch_sequel_database
-          patch_sequel_dataset
-        end
-
-        def patch_sequel_database
-          ::Sequel::Database.include(Database)
-        end
-
-        def patch_sequel_dataset
-          ::Sequel::Dataset.include(Dataset)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/sequel/utils.rb

@@ -1,75 +0,0 @@
-# typed: true
-require 'ddtrace/ext/integration'
-
-module Datadog
-  module Contrib
-    module Sequel
-      # General purpose functions for Sequel
-      module Utils
-        class << self
-          # Ruby database connector library
-          #
-          # e.g. adapter:mysql2 (database:mysql), adapter:jdbc (database:postgres)
-          def adapter_name(database)
-            scheme = database.adapter_scheme.to_s
-
-            if scheme == 'jdbc'.freeze
-              # The subtype is more important in this case,
-              # otherwise all database adapters will be 'jdbc'.
-              database_type(database)
-            else
-              Datadog::Utils::Database.normalize_vendor(scheme)
-            end
-          end
-
-          # Database engine
-          #
-          # e.g. database:mysql (adapter:mysql2), database:postgres (adapter:jdbc)
-          def database_type(database)
-            Datadog::Utils::Database.normalize_vendor(database.database_type.to_s)
-          end
-
-          def parse_opts(sql, opts, db_opts, dataset = nil)
-            # Prepared statements don't provide their sql query in the +sql+ parameter.
-            if !sql.is_a?(String) && (dataset && dataset.respond_to?(:prepared_sql) &&
-              (resolved_sql = dataset.prepared_sql))
-              # The dataset contains the resolved SQL query and prepared statement name.
-              prepared_name = dataset.prepared_statement_name
-              sql = resolved_sql
-            end
-
-            {
-              name: opts[:type],
-              query: sql,
-              prepared_name: prepared_name,
-              database: db_opts[:database],
-              host: db_opts[:host]
-            }
-          end
-
-          def set_common_tags(span)
-            # 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?
-          end
-
-          private
-
-          def datadog_configuration
-            Datadog.configuration[:sequel]
-          end
-
-          def analytics_enabled?
-            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
-          end
-
-          def analytics_sample_rate
-            datadog_configuration[:analytics_sample_rate]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-
-module Datadog
-  module Contrib
-    module Shoryuken
-      module Configuration
-        # Default settings for the Shoryuken 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 :error_handler, default: Datadog::Tracer::DEFAULT_ON_ERROR
-          option :tag_body, default: false
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Shoryuken
-      # Shoryuken integration constants
-      module Ext
-        APP = 'shoryuken'.freeze
-        ENV_ENABLED = 'DD_TRACE_SHORYUKEN_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SHORYUKEN_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_SHORYUKEN_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SHORYUKEN_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SHORYUKEN_ANALYTICS_SAMPLE_RATE'.freeze
-        SERVICE_NAME = 'shoryuken'.freeze
-        SPAN_JOB = 'shoryuken.job'.freeze
-        TAG_JOB_ID = 'shoryuken.id'.freeze
-        TAG_JOB_QUEUE = 'shoryuken.queue'.freeze
-        TAG_JOB_ATTRIBUTES = 'shoryuken.attributes'.freeze
-        TAG_JOB_BODY = 'shoryuken.body'.freeze
-      end
-    end
-  end
-end

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

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

@@ -1,25 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/shoryuken/tracer'
-
-module Datadog
-  module Contrib
-    module Shoryuken
-      # Patcher enables patching of 'shoryuken' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          ::Shoryuken.server_middleware do |chain|
-            chain.add Shoryuken::Tracer
-          end
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/shoryuken/tracer.rb

@@ -1,56 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/analytics'
-
-module Datadog
-  module Contrib
-    module Shoryuken
-      # Tracer is a Shoryuken server-side middleware which traces executed jobs
-      class Tracer
-        def initialize(options = {})
-          @tracer = options[:tracer] || configuration[:tracer]
-          @shoryuken_service = options[:service_name] || configuration[:service_name]
-          @error_handler = options[:error_handler] || configuration[:error_handler]
-        end
-
-        def call(worker_instance, queue, sqs_msg, body)
-          @tracer.trace(
-            Ext::SPAN_JOB,
-            service: @shoryuken_service,
-            span_type: Datadog::Ext::AppTypes::WORKER,
-            on_error: @error_handler
-          ) do |span|
-            # 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)
-
-            span.resource = resource(worker_instance, body)
-            span.set_tag(Ext::TAG_JOB_ID, sqs_msg.message_id)
-            span.set_tag(Ext::TAG_JOB_QUEUE, queue)
-            span.set_tag(Ext::TAG_JOB_ATTRIBUTES, sqs_msg.attributes) if sqs_msg.respond_to?(:attributes)
-            span.set_tag(Ext::TAG_JOB_BODY, body) if configuration[:tag_body]
-
-            yield
-          end
-        end
-
-        private
-
-        def resource(worker_instance, body)
-          # If it's a Hash, try to get the job class from it.
-          # This is for ActiveJob compatibility.
-          job_class = body['job_class'] if body.is_a?(Hash)
-          # If nothing is available, use the worker class name.
-          job_class || worker_instance.class.name
-        end
-
-        def configuration
-          Datadog.configuration[:shoryuken]
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/sidekiq/client_tracer.rb

@@ -1,44 +0,0 @@
-# typed: true
-require 'ddtrace/contrib/sidekiq/tracing'
-require 'ddtrace/contrib/analytics'
-
-module Datadog
-  module Contrib
-    module Sidekiq
-      # Tracer is a Sidekiq client-side middleware which traces job enqueues/pushes
-      class ClientTracer
-        include Tracing
-
-        def initialize(options = {})
-          super
-          @sidekiq_service = options[:client_service_name] || configuration[:client_service_name]
-        end
-
-        # Client middleware arguments are documented here:
-        #   https://github.com/mperham/sidekiq/wiki/Middleware#client-middleware
-        def call(worker_class, job, queue, redis_pool)
-          resource = job_resource(job)
-
-          @tracer.trace(Ext::SPAN_PUSH, service: @sidekiq_service) do |span|
-            span.resource = resource
-            # Set analytics sample rate
-            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-            end
-            span.set_tag(Ext::TAG_JOB_ID, job['jid'])
-            span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
-            span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
-
-            yield
-          end
-        end
-
-        private
-
-        def configuration
-          Datadog.configuration[:sidekiq]
-        end
-      end
-    end
-  end
-end

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

@@ -1,38 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/sidekiq/ext'
-
-module Datadog
-  module Contrib
-    module Sidekiq
-      module Configuration
-        # Custom settings for the Sidekiq 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 :tag_args do |o|
-            o.default { env_to_bool(Ext::ENV_TAG_JOB_ARGS, false) }
-            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/sidekiq/ext.rb

@@ -1,31 +0,0 @@
-# typed: true
-module Datadog
-  module Contrib
-    module Sidekiq
-      # Sidekiq integration constants
-      module Ext
-        APP = 'sidekiq'.freeze
-        CLIENT_SERVICE_NAME = 'sidekiq-client'.freeze
-        ENV_ENABLED = 'DD_TRACE_SIDEKIQ_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_TRACE_SIDEKIQ_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_ENABLED_OLD = 'DD_SIDEKIQ_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SIDEKIQ_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_SIDEKIQ_ANALYTICS_SAMPLE_RATE'.freeze
-        ENV_TAG_JOB_ARGS = 'DD_SIDEKIQ_TAG_JOB_ARGS'.freeze
-        SERVICE_NAME = 'sidekiq'.freeze
-        SPAN_PUSH = 'sidekiq.push'.freeze
-        SPAN_JOB = 'sidekiq.job'.freeze
-        SPAN_JOB_FETCH = 'sidekiq.job_fetch'.freeze
-        SPAN_HEARTBEAT = 'sidekiq.heartbeat'.freeze
-        SPAN_SCHEDULED_PUSH = 'sidekiq.scheduled_push'.freeze
-        TAG_JOB_DELAY = 'sidekiq.job.delay'.freeze
-        TAG_JOB_ID = 'sidekiq.job.id'.freeze
-        TAG_JOB_QUEUE = 'sidekiq.job.queue'.freeze
-        TAG_JOB_RETRY = 'sidekiq.job.retry'.freeze
-        TAG_JOB_RETRY_COUNT = 'sidekiq.job.retry_count'.freeze
-        TAG_JOB_WRAPPER = 'sidekiq.job.wrapper'.freeze
-        TAG_JOB_ARGS = 'sidekiq.job.args'.freeze
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/integration'
-require 'ddtrace/contrib/sidekiq/configuration/settings'
-require 'ddtrace/contrib/sidekiq/patcher'
-
-module Datadog
-  module Contrib
-    module Sidekiq
-      # Description of Sidekiq integration
-      class Integration
-        include Contrib::Integration
-
-        MINIMUM_VERSION = Gem::Version.new('3.5.4')
-        MINIMUM_SERVER_INTERNAL_TRACING_VERSION = Gem::Version.new('5.2.4')
-
-        register_as :sidekiq
-
-        def self.version
-          Gem.loaded_specs['sidekiq'] && Gem.loaded_specs['sidekiq'].version
-        end
-
-        def self.loaded?
-          !defined?(::Sidekiq).nil?
-        end
-
-        def self.compatible?
-          super && version >= MINIMUM_VERSION
-        end
-
-        # Only patch server internals on v5.2.4+ because that's when loading of
-        # `Sidekiq::Launcher` stabilized. Sidekiq 4+ technically can support our
-        # patches (with minor adjustments), but in order to avoid explicitly
-        # requiring `sidekiq/launcher` ourselves (which could affect gem
-        # initialization order), we are limiting this tracing to v5.2.4+.
-        def self.compatible_with_server_internal_tracing?
-          version >= MINIMUM_SERVER_INTERNAL_TRACING_VERSION
-        end
-
-        def default_configuration
-          Configuration::Settings.new
-        end
-
-        def patcher
-          Patcher
-        end
-      end
-    end
-  end
-end

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

@@ -1,68 +0,0 @@
-# typed: false
-require 'ddtrace/contrib/patcher'
-
-module Datadog
-  module Contrib
-    module Sidekiq
-      # Patcher enables patching of 'sidekiq' module.
-      module Patcher
-        include Contrib::Patcher
-
-        module_function
-
-        def target_version
-          Integration.version
-        end
-
-        def patch
-          require 'ddtrace/contrib/sidekiq/client_tracer'
-          require 'ddtrace/contrib/sidekiq/server_tracer'
-
-          ::Sidekiq.configure_client do |config|
-            config.client_middleware do |chain|
-              chain.add(Sidekiq::ClientTracer)
-            end
-          end
-
-          ::Sidekiq.configure_server do |config|
-            # If a job enqueues another job, make sure it has the same client
-            # middleware.
-            config.client_middleware do |chain|
-              chain.add(Sidekiq::ClientTracer)
-            end
-
-            config.server_middleware do |chain|
-              chain.add(Sidekiq::ServerTracer)
-            end
-
-            patch_server_internals if Integration.compatible_with_server_internal_tracing?
-          end
-        end
-
-        def patch_server_internals
-          patch_server_heartbeat
-          patch_server_job_fetch
-          patch_server_scheduled_push
-        end
-
-        def patch_server_heartbeat
-          require 'ddtrace/contrib/sidekiq/server_internal_tracer/heartbeat'
-
-          ::Sidekiq::Launcher.prepend(ServerInternalTracer::Heartbeat)
-        end
-
-        def patch_server_job_fetch
-          require 'ddtrace/contrib/sidekiq/server_internal_tracer/job_fetch'
-
-          ::Sidekiq::Processor.prepend(ServerInternalTracer::JobFetch)
-        end
-
-        def patch_server_scheduled_push
-          require 'ddtrace/contrib/sidekiq/server_internal_tracer/scheduled_push'
-
-          ::Sidekiq::Scheduled::Poller.prepend(ServerInternalTracer::ScheduledPush)
-        end
-      end
-    end
-  end
-end

data/lib/ddtrace/contrib/sidekiq/server_internal_tracer/heartbeat.rb

@@ -1,30 +0,0 @@
-# typed: true
-
-module Datadog
-  module Contrib
-    module Sidekiq
-      module ServerInternalTracer
-        # Trace when a Sidekiq process has a heartbeat
-        module Heartbeat
-          private
-
-          def ❤ # rubocop:disable Naming/AsciiIdentifiers, Naming/MethodName
-            configuration = Datadog.configuration[:sidekiq]
-
-            configuration[:tracer].trace(Ext::SPAN_HEARTBEAT) do |span|
-              span.service = configuration[:service_name]
-              span.span_type = Datadog::Ext::AppTypes::WORKER
-
-              # Set analytics sample rate
-              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
-                Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
-              end
-
-              super
-            end
-          end
-        end
-      end
-    end
-  end
-end