ls-trace 0.1.1

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,26 @@
+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 :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,21 @@
+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
+        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_WRAPPER = 'sidekiq.job.wrapper'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+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
+
+        register_as :sidekiq
+
+        def self.version
+          Gem.loaded_specs['sidekiq'] && Gem.loaded_specs['sidekiq'].version
+        end
+
+        def self.present?
+          super && defined?(::Sidekiq)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('3.5.4')
+        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,40 @@
+require 'ddtrace/contrib/patcher'
+
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Patcher enables patching of 'sidekiq' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:sidekiq)
+        end
+
+        def patch
+          do_once(:sidekiq) do
+            begin
+              require 'ddtrace/contrib/sidekiq/client_tracer'
+              ::Sidekiq.configure_client do |config|
+                config.client_middleware do |chain|
+                  chain.add(Sidekiq::ClientTracer)
+                end
+              end
+
+              require 'ddtrace/contrib/sidekiq/server_tracer'
+              ::Sidekiq.configure_server do |config|
+                config.server_middleware do |chain|
+                  chain.add(Sidekiq::ServerTracer)
+                end
+              end
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Sidekiq integration: #{e}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+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 = service_from_worker_config(resource) || @sidekiq_service
+
+          @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
+            span.set_tag(Ext::TAG_JOB_ID, job['jid'])
+            span.set_tag(Ext::TAG_JOB_RETRY, job['retry'])
+            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))
+
+            yield
+          end
+        end
+
+        private
+
+        def configuration
+          Datadog.configuration[:sidekiq]
+        end
+
+        def service_from_worker_config(resource)
+          # 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[:service_name]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sidekiq/ext'
+
+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']
+          else
+            job['class']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sinatra/ext'
+
+module Datadog
+  module Contrib
+    module Sinatra
+      module Configuration
+        # Custom settings for the Sinatra integration
+        class Settings < Contrib::Configuration::Settings
+          DEFAULT_HEADERS = {
+            response: %w[Content-Type X-Request-ID]
+          }.freeze
+
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
+            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 :distributed_tracing, default: true
+          option :headers, default: DEFAULT_HEADERS
+          option :resource_script_names, default: false
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sinatra/env.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/sinatra/ext'
+
+module Datadog
+  module Contrib
+    module Sinatra
+      # Gets and sets trace information from a Rack Env
+      module Env
+        module_function
+
+        def datadog_span(env)
+          env[Ext::RACK_ENV_REQUEST_SPAN]
+        end
+
+        def set_datadog_span(env, span)
+          env[Ext::RACK_ENV_REQUEST_SPAN] = span
+        end
+
+        def request_header_tags(env, headers)
+          headers ||= []
+
+          {}.tap do |result|
+            headers.each do |header|
+              rack_header = header_to_rack_header(header)
+              if env.key?(rack_header)
+                result[Datadog::Ext::HTTP::RequestHeaders.to_tag(header)] = env[rack_header]
+              end
+            end
+          end
+        end
+
+        def header_to_rack_header(name)
+          "HTTP_#{name.to_s.upcase.gsub(/[-\s]/, '_')}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Datadog
+  module Contrib
+    module Sinatra
+      # Sinatra integration constants
+      module Ext
+        APP = 'sinatra'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SINATRA_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SINATRA_ANALYTICS_SAMPLE_RATE'.freeze
+        RACK_ENV_REQUEST_SPAN = 'datadog.sinatra_request_span'.freeze
+        SERVICE_NAME = 'sinatra'.freeze
+        SPAN_RENDER_TEMPLATE = 'sinatra.render_template'.freeze
+        SPAN_REQUEST = 'sinatra.request'.freeze
+        TAG_ROUTE_PATH = 'sinatra.route.path'.freeze
+        TAG_TEMPLATE_NAME = 'sinatra.template_name'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sinatra/headers.rb

@@ -0,0 +1,31 @@
+require 'ddtrace/ext/http'
+
+module Datadog
+  module Contrib
+    module Sinatra
+      # Gets and sets trace information from a Rack headers Hash
+      module Headers
+        module_function
+
+        def response_header_tags(headers, target_headers)
+          target_headers ||= []
+
+          {}.tap do |result|
+            target_headers.each do |header|
+              if headers.key?(header)
+                result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[header]
+              else
+                # Try a case-insensitive lookup
+                uppercased_header = header.to_s.upcase
+                matching_header = headers.keys.find { |h| h.upcase == uppercased_header }
+                if matching_header
+                  result[Datadog::Ext::HTTP::ResponseHeaders.to_tag(header)] = headers[matching_header]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/sinatra/configuration/settings'
+require 'ddtrace/contrib/sinatra/patcher'
+
+module Datadog
+  module Contrib
+    module Sinatra
+      # Description of Sinatra integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :sinatra
+
+        def self.version
+          Gem.loaded_specs['sinatra'] && Gem.loaded_specs['sinatra'].version
+        end
+
+        def self.present?
+          super && defined?(::Sinatra)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('1.4.0')
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'ddtrace/contrib/patcher'
+
+module Datadog
+  module Contrib
+    module Sinatra
+      # Patcher enables patching of 'sinatra' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:sinatra)
+        end
+
+        def patch
+          do_once(:sinatra) do
+            begin
+              require 'ddtrace/contrib/sinatra/tracer'
+              register_tracer
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Sinatra integration: #{e}")
+            end
+          end
+        end
+
+        def register_tracer
+          ::Sinatra.send(:register, Datadog::Contrib::Sinatra::Tracer)
+        end
+      end
+    end
+  end
+end