ddtrace 0.16.1 → 0.17.0

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

@@ -0,0 +1,37 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/resque/configuration/settings'
+require 'ddtrace/contrib/resque/patcher'
+
+module Datadog
+  module Contrib
+    module Resque
+      # Description of Resque integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :resque, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['resque'] && Gem.loaded_specs['resque'].version
+        end
+
+        def self.present?
+          super && defined?(::Resque)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+
+        class << self
+          # Globally-acccesible reference for pre-forking optimization
+          attr_accessor :sync_writer
+        end
+      end
+    end
+  end
+end

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

@@ -1,49 +1,43 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sidekiq/ext'
+
 module Datadog
   module Contrib
-    # Namespace for `resque` integration
     module Resque
-      SERVICE = 'resque'.freeze
-
-      class << self
-        # Globally-acccesible reference for pre-forking optimization
-        attr_accessor :sync_writer
-      end
-
-      # Patcher for Resque integration - sets up the pin for the integration
+      # Patcher enables patching of 'resque' module.
       module Patcher
-        include Base
-        register_as :resque, auto_patch: true
-        option :service_name, default: SERVICE
-
-        @patched = false
-        option :workers, default: []
-
-        class << self
-          def patch
-            return @patched if patched? || !defined?(::Resque)
+        include Contrib::Patcher
 
-            require 'ddtrace/ext/app_types'
-            require_relative 'resque_job'
+        module_function
 
-            add_pin
-            get_option(:workers).each { |worker| worker.extend(ResqueJob) }
-            @patched = true
-          rescue => e
-            Tracer.log.error("Unable to apply Resque integration: #{e}")
-            @patched
-          end
+        def patched?
+          done?(:resque)
+        end
 
-          def patched?
-            @patched
+        def patch
+          do_once(:resque) do
+            begin
+              require_relative 'resque_job'
+              add_pin
+              get_option(:workers).each { |worker| worker.extend(ResqueJob) }
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Resque integration: #{e}")
+            end
           end
+        end
 
-          private
+        def add_pin
+          Pin.new(
+            get_option(:service_name),
+            app: Ext::APP,
+            app_type: Datadog::Ext::AppTypes::WORKER,
+            tracer: get_option(:tracer)
+          ).onto(::Resque)
+        end
 
-          def add_pin
-            Pin
-              .new(get_option(:service_name), app: 'resque', app_type: Ext::AppTypes::WORKER)
-              .onto(::Resque)
-          end
+        def get_option(option)
+          Datadog.configuration[:resque].get_option(option)
         end
       end
     end

data/lib/ddtrace/contrib/resque/resque_job.rb

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/app_types'
 require 'ddtrace/sync_writer'
+require 'ddtrace/contrib/sidekiq/ext'
 require 'resque'
 
 module Datadog
@@ -10,7 +11,7 @@ module Datadog
         def around_perform(*args)
           pin = Pin.get_from(::Resque)
           return yield unless pin && pin.tracer
-          pin.tracer.trace('resque.job', service: pin.service) do |span|
+          pin.tracer.trace(Ext::SPAN_JOB, service: pin.service) do |span|
             span.resource = name
             span.span_type = pin.app_type
             yield

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

@@ -1,20 +1,17 @@
 require 'ddtrace/contrib/configuration/settings'
-require 'ddtrace/contrib/active_record/utils'
+require 'ddtrace/contrib/rest_client/ext'
 
 module Datadog
   module Contrib
     module RestClient
       module Configuration
-        # Unique settings for RestClient
+        # Custom settings for the RestClient integration
         class Settings < Contrib::Configuration::Settings
-          NAME = 'rest_client'.freeze
-
-          option :service_name, default: NAME, depends_on: [:tracer] do |value|
-            get_option(:tracer).set_service_info(value, NAME, Ext::AppTypes::DB)
+          option :distributed_tracing, default: false
+          option :service_name, default: Ext::SERVICE_NAME, depends_on: [:tracer] do |value|
+            get_option(:tracer).set_service_info(value, Ext::APP, Datadog::Ext::AppTypes::DB)
             value
           end
-
-          option :distributed_tracing, default: false
         end
       end
     end

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

@@ -0,0 +1,13 @@
+module Datadog
+  module Contrib
+    module RestClient
+      # RestClient integration constants
+      module Ext
+        APP = 'rest_client'.freeze
+        SERVICE_NAME = 'rest_client'.freeze
+
+        SPAN_REQUEST = 'rest_client.request'.freeze
+      end
+    end
+  end
+end

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

@@ -10,8 +10,16 @@ module Datadog
         include Contrib::Integration
         register_as :rest_client
 
+        def self.version
+          Gem.loaded_specs['rest-client'] && Gem.loaded_specs['rest-client'].version
+        end
+
+        def self.present?
+          super && defined?(::RestClient::Request)
+        end
+
         def self.compatible?
-          RUBY_VERSION >= '1.9.3' && defined?(::RestClient::Request)
+          super && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('1.9.3')
         end
 
         def default_configuration

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

@@ -1,7 +1,7 @@
 module Datadog
   module Contrib
     module RestClient
-      # RestClient integration
+      # Patcher enables patching of 'rest_client' module.
       module Patcher
         include Contrib::Patcher
 

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -1,14 +1,13 @@
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/distributed'
 require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/rest_client/ext'
 
 module Datadog
   module Contrib
     module RestClient
       # RestClient RequestPatch
       module RequestPatch
-        REQUEST_TRACE_NAME = 'rest_client.request'.freeze
-
         def self.included(base)
           if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
             base.class_eval do
@@ -48,14 +47,14 @@ module Datadog
 
           def datadog_tag_request(uri, span)
             span.resource = method.to_s.upcase
-            span.set_tag(Ext::HTTP::URL, uri.path)
-            span.set_tag(Ext::HTTP::METHOD, method.to_s.upcase)
-            span.set_tag(Ext::NET::TARGET_HOST, uri.host)
-            span.set_tag(Ext::NET::TARGET_PORT, uri.port)
+            span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, method.to_s.upcase)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
           end
 
           def datadog_trace_request(uri)
-            span = datadog_configuration[:tracer].trace(REQUEST_TRACE_NAME,
+            span = datadog_configuration[:tracer].trace(Ext::SPAN_REQUEST,
                                                         service: datadog_configuration[:service_name],
                                                         span_type: Datadog::Ext::AppTypes::WEB)
 
@@ -63,11 +62,11 @@ module Datadog
 
             response = yield(span)
 
-            span.set_tag(Ext::HTTP::STATUS_CODE, response.code)
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
             response
           rescue ::RestClient::ExceptionWithResponse => e
-            span.set_error(e) if Ext::HTTP::ERROR_RANGE.cover?(e.http_code)
-            span.set_tag(Ext::HTTP::STATUS_CODE, e.http_code)
+            span.set_error(e) if Datadog::Ext::HTTP::ERROR_RANGE.cover?(e.http_code)
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, e.http_code)
 
             raise e
             # rubocop:disable Lint/RescueException

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

@@ -1,9 +1,11 @@
 require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/sequel/ext'
 
 module Datadog
   module Contrib
     module Sequel
       module Configuration
+        # Custom settings for the Sequel integration
         class Settings < Contrib::Configuration::Settings
           # Add any custom Sequel settings or behavior here.
         end

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

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sequel/ext'
 require 'ddtrace/contrib/sequel/utils'
 
 module Datadog
@@ -18,11 +19,11 @@ module Datadog
 
             response = nil
 
-            datadog_pin.tracer.trace('sequel.query') do |span|
+            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
-              span.set_tag('sequel.db.vendor', adapter_name)
+              span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super(sql, options)
             end
             response
@@ -31,7 +32,7 @@ module Datadog
           def datadog_pin
             @pin ||= Datadog::Pin.new(
               Datadog.configuration[:sequel][:service_name] || adapter_name,
-              app: Integration::APP,
+              app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::DB,
               tracer: Datadog.configuration[:sequel][:tracer] || Datadog.tracer
             )

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

@@ -1,5 +1,6 @@
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sequel/ext'
 require 'ddtrace/contrib/sequel/utils'
 
 module Datadog
@@ -39,11 +40,11 @@ module Datadog
             opts = Utils.parse_opts(sql, options, db.opts)
             response = nil
 
-            datadog_pin.tracer.trace('sequel.query') do |span|
+            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
-              span.set_tag('sequel.db.vendor', adapter_name)
+              span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
               response = super_method.call(sql, options, &block)
             end
             response

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

@@ -0,0 +1,15 @@
+module Datadog
+  module Contrib
+    module Sequel
+      # Sequel integration constants
+      module Ext
+        APP = 'sequel'.freeze
+        SERVICE_NAME = 'sequel'.freeze
+
+        SPAN_QUERY = 'sequel.query'.freeze
+
+        TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+      end
+    end
+  end
+end

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

@@ -9,8 +9,6 @@ module Datadog
       class Integration
         include Contrib::Integration
 
-        APP = 'sequel'.freeze
-
         register_as :sequel, auto_patch: false
 
         def self.version
@@ -22,7 +20,7 @@ module Datadog
         end
 
         def self.compatible?
-          super && RUBY_VERSION >= '2.0.0'
+          super && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0')
         end
 
         def default_configuration

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

@@ -6,7 +6,6 @@ module Datadog
   module Contrib
     module Sequel
       # Patcher enables patching of 'sequel' module.
-      # This is used in monkey.rb to manually apply patches
       module Patcher
         include Contrib::Patcher
 

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

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

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

@@ -0,0 +1,19 @@
+module Datadog
+  module Contrib
+    module Sidekiq
+      # Sidekiq integration constants
+      module Ext
+        APP = 'sidekiq'.freeze
+        SERVICE_NAME = 'sidekiq'.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

@@ -1,32 +1,32 @@
+require 'ddtrace/contrib/patcher'
+
 module Datadog
   module Contrib
     module Sidekiq
-      # Provides instrumentation support for Sidekiq
+      # Patcher enables patching of 'sidekiq' module.
       module Patcher
-        include Base
-        VERSION_REQUIRED = Gem::Version.new('4.0.0')
-        register_as :sidekiq
-        option :service_name, default: 'sidekiq'
-        option :tracer, default: Datadog.tracer
+        include Contrib::Patcher
 
         module_function
 
-        def patch
-          return unless compatible?
-
-          require_relative 'tracer'
+        def patched?
+          done?(:sidekiq)
+        end
 
-          ::Sidekiq.configure_server do |config|
-            config.server_middleware do |chain|
-              chain.add(Sidekiq::Tracer)
+        def patch
+          do_once(:sidekiq) do
+            begin
+              require 'ddtrace/contrib/sidekiq/tracer'
+              ::Sidekiq.configure_server do |config|
+                config.server_middleware do |chain|
+                  chain.add(Sidekiq::Tracer)
+                end
+              end
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Sidekiq integration: #{e}")
             end
           end
         end
-
-        def compatible?
-          defined?(::Sidekiq) &&
-            Gem::Version.new(::Sidekiq::VERSION) >= VERSION_REQUIRED
-        end
       end
     end
   end