ddtrace 0.38.0

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

@@ -0,0 +1,24 @@
+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 :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, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Datadog
+  module Contrib
+    module Shoryuken
+      # Shoryuken integration constants
+      module Ext
+        APP = 'shoryuken'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SHORYUKEN_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = '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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,49 @@
+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]
+        end
+
+        def call(worker_instance, queue, sqs_msg, body)
+          @tracer.trace(Ext::SPAN_JOB, service: @shoryuken_service, span_type: Datadog::Ext::AppTypes::WORKER) 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)
+
+            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

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,31 @@
+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 :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, default: Ext::SERVICE_NAME
+          option :client_service_name, default: Ext::CLIENT_SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Sidekiq integration constants
+      module Ext
+        APP = 'sidekiq'.freeze
+        CLIENT_SERVICE_NAME = 'sidekiq-client'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SIDEKIQ_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = '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
+        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

@@ -0,0 +1,38 @@
+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')
+
+        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
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'ddtrace/contrib/sidekiq/tracing'
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Tracer is a Sidekiq server-side middleware which traces executed jobs
+      class ServerTracer
+        include Tracing
+
+        def initialize(options = {})
+          super
+          @sidekiq_service = options[:service_name] || configuration[:service_name]
+        end
+
+        def call(worker, job, queue)
+          resource = job_resource(job)
+
+          service = worker_config(resource, :service_name) || @sidekiq_service
+          tag_args = worker_config(resource, :tag_args) || configuration[:tag_args]
+
+          @tracer.trace(Ext::SPAN_JOB, service: service, span_type: Datadog::Ext::AppTypes::WORKER) 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
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            span.set_tag(Ext::TAG_JOB_ID, job['jid'])
+            span.set_tag(Ext::TAG_JOB_RETRY, job['retry'])
+            span.set_tag(Ext::TAG_JOB_RETRY_COUNT, job['retry_count'])
+            span.set_tag(Ext::TAG_JOB_QUEUE, job['queue'])
+            span.set_tag(Ext::TAG_JOB_WRAPPER, job['class']) if job['wrapped']
+            span.set_tag(Ext::TAG_JOB_DELAY, 1000.0 * (Time.now.utc.to_f - job['enqueued_at'].to_f))
+            if tag_args && !job['args'].nil? && !job['args'].empty?
+              span.set_tag(Ext::TAG_JOB_ARGS, job['args'])
+            end
+
+            yield
+          end
+        end
+
+        private
+
+        def configuration
+          Datadog.configuration[:sidekiq]
+        end
+
+        def worker_config(resource, key)
+          # Try to get the Ruby class from the resource name.
+          worker_klass = begin
+            Object.const_get(resource)
+          rescue NameError
+            nil
+          end
+
+          if worker_klass.respond_to?(:datadog_tracer_config)
+            worker_klass.datadog_tracer_config[key]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sidekiq/ext'
+
+require 'yaml'
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Common functionality used by both client-side and server-side tracers.
+      module Tracing
+        def initialize(options = {})
+          @tracer = options[:tracer] || Datadog.configuration[:sidekiq][:tracer]
+        end
+
+        protected
+
+        # If class is wrapping something else, the interesting resource info
+        # is the underlying, wrapped class, and not the wrapper. This is
+        # primarily to support `ActiveJob`.
+        def job_resource(job)
+          if job['wrapped']
+            job['wrapped'].to_s
+          elsif job['class'] == 'Sidekiq::Extensions::DelayedClass'
+            delay_extension_class(job).to_s
+          else
+            job['class'].to_s
+          end
+        rescue => e
+          Datadog.logger.debug { "Error retrieving Sidekiq job class name (jid:#{job['jid']}): #{e}" }
+
+          job['class'].to_s
+        end
+
+        #
+        def delay_extension_class(job)
+          clazz, method = YAML.parse(job['args'].first).children.first.children
+
+          method = method.value[1..-1] # Remove leading `:` from method symbol
+
+          "#{clazz.value}.#{method}"
+        end
+      end
+    end
+  end
+end