ddtrace 0.52.0 → 1.8.0

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

@@ -0,0 +1,22 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Sequel
+        # Sequel integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_SEQUEL_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_SEQUEL_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
+          SPAN_QUERY = 'sequel.query'.freeze
+          TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+          TAG_PREPARED_NAME = 'sequel.prepared.name'.freeze
+          TAG_COMPONENT = 'sequel'.freeze
+          TAG_OPERATION_QUERY = 'query'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Sequel
+        # Description of Sequel integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('3.41')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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 new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# typed: true
+
+require_relative '../patcher'
+require_relative 'database'
+require_relative 'dataset'
+
+module Datadog
+  module Tracing
+    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
+end

data/lib/datadog/tracing/contrib/sequel/utils.rb

@@ -0,0 +1,87 @@
+# typed: true
+
+require_relative '../../metadata/ext'
+require_relative '../utils/database'
+
+module Datadog
+  module Tracing
+    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
+                Contrib::Utils::Database.normalize_vendor(scheme)
+              end
+            end
+
+            # Database engine
+            #
+            # e.g. database:mysql (adapter:mysql2), database:postgres (adapter:jdbc)
+            def database_type(database)
+              Contrib::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, db)
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_QUERY)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              # TODO: Extract host for Sequel with JDBC. The easiest way seem to be through
+              # TODO: the database URI. Unfortunately, JDBC URIs do not work with `URI.parse`.
+              # host, _port = extract_host_port_from_uri(db.uri)
+              # span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, db.opts[:host]) if db.opts[:host]
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.tracing[: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
+end

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

@@ -0,0 +1,38 @@
+# typed: false
+
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Shoryuken
+        module Configuration
+          # Default settings for the Shoryuken 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, 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 :service_name
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :tag_body, default: false
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Shoryuken
+        # Shoryuken integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_SHORYUKEN_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_SHORYUKEN_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_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
+          TAG_COMPONENT = 'shoryuken'.freeze
+          TAG_OPERATION_JOB = 'job'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'ext'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Shoryuken
+        # Description of Shoryuken integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('3.2')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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 new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: false
+
+require_relative 'tracer'
+
+module Datadog
+  module Tracing
+    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
+end

data/lib/datadog/tracing/contrib/shoryuken/tracer.rb

@@ -0,0 +1,63 @@
+# typed: true
+
+require_relative '../analytics'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Shoryuken
+        # Tracer is a Shoryuken server-side middleware which traces executed jobs
+        class Tracer
+          def initialize(options = {})
+            @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)
+            Tracing.trace(
+              Ext::SPAN_JOB,
+              service: @shoryuken_service,
+              span_type: Tracing::Metadata::Ext::AppTypes::TYPE_WORKER,
+              on_error: @error_handler
+            ) do |span|
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_JOB)
+
+              # 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]
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CONSUMER)
+
+              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.tracing[:shoryuken]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/sidekiq/client_tracer.rb

@@ -0,0 +1,57 @@
+# typed: true
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative 'tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Sidekiq
+        # Tracer is a Sidekiq client-side middleware which traces job enqueues/pushes
+        class ClientTracer
+          include Tracing
+
+          def initialize(options = {})
+            @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)
+
+            Datadog::Tracing.trace(Ext::SPAN_PUSH, service: @sidekiq_service) do |span|
+              span.resource = resource
+
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Datadog::Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_PUSH)
+
+              span.set_tag(
+                Datadog::Tracing::Metadata::Ext::TAG_KIND,
+                Datadog::Tracing::Metadata::Ext::SpanKind::TAG_PRODUCER
+              )
+
+              # 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.tracing[:sidekiq]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: false
+
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Sidekiq
+        module Configuration
+          # Custom settings for the Sidekiq 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, 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 :tag_args do |o|
+              o.default { env_to_bool(Ext::ENV_TAG_JOB_ARGS, false) }
+              o.lazy
+            end
+
+            option :service_name
+            option :client_service_name
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+            option :quantize, default: {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Sidekiq
+        # Sidekiq integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          CLIENT_SERVICE_NAME = 'sidekiq-client'.freeze
+          ENV_ENABLED = 'DD_TRACE_SIDEKIQ_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_SIDEKIQ_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_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_REDIS_INFO = 'sidekiq.redis_info'.freeze
+          SPAN_HEARTBEAT = 'sidekiq.heartbeat'.freeze
+          SPAN_SCHEDULED_PUSH = 'sidekiq.scheduled_push'.freeze
+          SPAN_SCHEDULED_WAIT = 'sidekiq.scheduled_poller_wait'.freeze
+          SPAN_STOP = 'sidekiq.stop'.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
+          TAG_COMPONENT = 'sidekiq'.freeze
+          TAG_OPERATION_PUSH = 'push'.freeze
+          TAG_OPERATION_JOB = 'job'.freeze
+          TAG_OPERATION_JOB_FETCH = 'job_fetch'.freeze
+          TAG_OPERATION_REDIS_INFO = 'redis_info'.freeze
+          TAG_OPERATION_HEARTBEAT = 'heartbeat'.freeze
+          TAG_OPERATION_SCHEDULED_PUSH = 'scheduled_push'.freeze
+          TAG_OPERATION_SCHEDULED_WAIT = 'scheduled_poller_wait'.freeze
+          TAG_OPERATION_STOP = 'stop'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    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')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          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 new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# typed: false
+
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    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_relative 'client_tracer'
+            require_relative '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
+            patch_redis_info
+          end
+
+          def patch_server_heartbeat
+            require_relative 'server_internal_tracer/heartbeat'
+
+            ::Sidekiq::Launcher.prepend(ServerInternalTracer::Heartbeat)
+          end
+
+          def patch_server_job_fetch
+            require_relative 'server_internal_tracer/job_fetch'
+
+            ::Sidekiq::Processor.prepend(ServerInternalTracer::JobFetch)
+          end
+
+          def patch_server_scheduled_push
+            require_relative 'server_internal_tracer/scheduled_poller'
+
+            ::Sidekiq::Scheduled::Poller.prepend(ServerInternalTracer::ScheduledPoller)
+          end
+
+          def patch_redis_info
+            require_relative 'server_internal_tracer/redis_info'
+
+            ::Sidekiq.singleton_class.prepend(ServerInternalTracer::RedisInfo)
+          end
+        end
+      end
+    end
+  end
+end