ddtrace 0.16.1 → 0.17.0

data/lib/ddtrace/contrib/aws/instrumentation.rb

@@ -1,3 +1,5 @@
+require 'ddtrace/contrib/aws/ext'
+
 module Datadog
   module Contrib
     module Aws
@@ -15,7 +17,7 @@ module Datadog
 
           return @handler.call(context) unless pin && pin.enabled?
 
-          pin.tracer.trace(RESOURCE) do |span|
+          pin.tracer.trace(Ext::SPAN_COMMAND) do |span|
             result = @handler.call(context)
             annotate!(span, pin, ParsedContext.new(context))
             result
@@ -27,15 +29,15 @@ module Datadog
         def annotate!(span, pin, context)
           span.service = pin.service
           span.span_type = pin.app_type
-          span.name = RESOURCE
+          span.name = Ext::SPAN_COMMAND
           span.resource = context.safely(:resource)
-          span.set_tag('aws.agent', AGENT)
-          span.set_tag('aws.operation', context.safely(:operation))
-          span.set_tag('aws.region', context.safely(:region))
-          span.set_tag('path', context.safely(:path))
-          span.set_tag('host', context.safely(:host))
-          span.set_tag(Ext::HTTP::METHOD, context.safely(:http_method))
-          span.set_tag(Ext::HTTP::STATUS_CODE, context.safely(:status_code))
+          span.set_tag(Ext::TAG_AGENT, Ext::TAG_DEFAULT_AGENT)
+          span.set_tag(Ext::TAG_OPERATION, context.safely(:operation))
+          span.set_tag(Ext::TAG_REGION, context.safely(:region))
+          span.set_tag(Ext::TAG_PATH, context.safely(:path))
+          span.set_tag(Ext::TAG_HOST, context.safely(:host))
+          span.set_tag(Datadog::Ext::HTTP::METHOD, context.safely(:http_method))
+          span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, context.safely(:status_code))
         end
       end
     end

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

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/aws/configuration/settings'
+require 'ddtrace/contrib/aws/patcher'
+
+module Datadog
+  module Contrib
+    module Aws
+      # Description of AWS integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :aws, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['aws-sdk'] && Gem.loaded_specs['aws-sdk'].version
+        end
+
+        def self.present?
+          super && defined?(::Seahorse::Client::Base)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -1,57 +1,58 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/aws/ext'
+
 module Datadog
   module Contrib
     module Aws
-      AGENT = 'aws-sdk-ruby'.freeze
-      RESOURCE = 'aws.command'.freeze
-
-      # Responsible for hooking the instrumentation into aws-sdk
+      # Patcher enables patching of 'aws' module.
       module Patcher
-        include Base
-        register_as :aws, auto_patch: true
-        option :service_name, default: 'aws'
-
-        @patched = false
-
-        class << self
-          def patch
-            return @patched if patched? || !defined?(Seahorse::Client::Base)
+        include Contrib::Patcher
 
-            require 'ddtrace/ext/app_types'
-            require 'ddtrace/contrib/aws/parsed_context'
-            require 'ddtrace/contrib/aws/instrumentation'
-            require 'ddtrace/contrib/aws/services'
+        module_function
 
-            add_pin
-            add_plugin(Seahorse::Client::Base, *loaded_constants)
-
-            @patched = true
-          rescue => e
-            Datadog::Tracer.log.error("Unable to apply AWS integration: #{e}")
-            @patched
-          end
+        def patched?
+          done?(:aws)
+        end
 
-          def patched?
-            @patched
+        def patch
+          do_once(:aws) do
+            begin
+              require 'ddtrace/contrib/aws/parsed_context'
+              require 'ddtrace/contrib/aws/instrumentation'
+              require 'ddtrace/contrib/aws/services'
+
+              add_pin
+              add_plugin(Seahorse::Client::Base, *loaded_constants)
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply AWS integration: #{e}")
+            end
           end
+        end
 
-          private
+        def add_pin
+          Pin
+            .new(
+              get_option(:service_name),
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: get_option(:tracer)
+            ).onto(::Aws)
+        end
 
-          def add_pin
-            Pin
-              .new(get_option(:service_name), app: 'aws', app_type: Ext::AppTypes::WEB)
-              .onto(::Aws)
-          end
+        def add_plugin(*targets)
+          targets.each { |klass| klass.add_plugin(Instrumentation) }
+        end
 
-          def add_plugin(*targets)
-            targets.each { |klass| klass.add_plugin(Instrumentation) }
+        def loaded_constants
+          SERVICES.each_with_object([]) do |service, constants|
+            next if ::Aws.autoload?(service)
+            constants << ::Aws.const_get(service).const_get(:Client) rescue next
           end
+        end
 
-          def loaded_constants
-            SERVICES.each_with_object([]) do |service, constants|
-              next if ::Aws.autoload?(service)
-              constants << ::Aws.const_get(service).const_get(:Client) rescue next
-            end
-          end
+        def get_option(option)
+          Datadog.configuration[:aws].get_option(option)
         end
       end
     end

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

@@ -1,11 +1,13 @@
 require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/concurrent_ruby/ext'
 
 module Datadog
   module Contrib
     module ConcurrentRuby
       module Configuration
+        # Custom settings for the ConcurrentRuby integration
         class Settings < Contrib::Configuration::Settings
-          # Add any custom ConcurrentRuby configuration or behavior here.
+          option :service_name, default: Ext::SERVICE_NAME
         end
       end
     end

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

@@ -0,0 +1,11 @@
+module Datadog
+  module Contrib
+    module ConcurrentRuby
+      # ConcurrentRuby integration constants
+      module Ext
+        APP = 'concurrent-ruby'.freeze
+        SERVICE_NAME = 'concurrent-ruby'.freeze
+      end
+    end
+  end
+end

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

@@ -5,14 +5,18 @@ require 'ddtrace/contrib/concurrent_ruby/configuration/settings'
 module Datadog
   module Contrib
     module ConcurrentRuby
-      # Propagate Tracing context in Concurrent::Future
+      # Describes the ConcurrentRuby integration
       class Integration
         include Contrib::Integration
 
         register_as :concurrent_ruby
 
-        def self.compatible?
-          defined?(::Concurrent::Future)
+        def self.version
+          Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version
+        end
+
+        def self.present?
+          super && defined?(::Concurrent::Future)
         end
 
         def default_configuration

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

@@ -25,6 +25,7 @@ module Datadog
           end
         end
 
+        # Propagate tracing context in Concurrent::Future
         def patch_future
           ::Concurrent::Future.send(:include, FuturePatch)
         end

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

@@ -0,0 +1,15 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/dalli/ext'
+
+module Datadog
+  module Contrib
+    module Dalli
+      module Configuration
+        # Custom settings for the Dalli integration
+        class Settings < Contrib::Configuration::Settings
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Datadog
+  module Contrib
+    module Dalli
+      # Dalli integration constants
+      module Ext
+        APP = 'dalli'.freeze
+        SERVICE_NAME = 'memcached'.freeze
+
+        QUANTIZE_MAX_CMD_LENGTH = 100
+        SPAN_COMMAND = 'memcached.command'.freeze
+        TAG_COMMAND = 'memcached.command'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/dalli/instrumentation.rb

@@ -1,5 +1,5 @@
-require_relative 'quantize'
 require 'ddtrace/ext/net'
+require 'ddtrace/contrib/dalli/quantize'
 
 module Datadog
   module Contrib
@@ -15,14 +15,14 @@ module Datadog
             def request(op, *args)
               pin = Datadog::Pin.get_from(::Dalli)
 
-              pin.tracer.trace(Datadog::Contrib::Dalli::NAME) do |span|
+              pin.tracer.trace(Datadog::Contrib::Dalli::Ext::SPAN_COMMAND) do |span|
                 span.resource = op.to_s.upcase
                 span.service = pin.service
                 span.span_type = pin.app_type
                 span.set_tag(Datadog::Ext::NET::TARGET_HOST, hostname)
                 span.set_tag(Datadog::Ext::NET::TARGET_PORT, port)
                 cmd = Datadog::Contrib::Dalli::Quantize.format_command(op, args)
-                span.set_tag(Datadog::Contrib::Dalli::CMD_TAG, cmd)
+                span.set_tag(Datadog::Contrib::Dalli::Ext::TAG_COMMAND, cmd)
 
                 __request(op, *args)
               end

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

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

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

@@ -1,51 +1,44 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/dalli/ext'
+require 'ddtrace/contrib/dalli/instrumentation'
+
 module Datadog
   module Contrib
     module Dalli
-      COMPATIBLE_WITH = Gem::Version.new('2.0.0')
-      NAME = 'memcached.command'.freeze
-      CMD_TAG = 'memcached.command'.freeze
-
-      # Responsible for hooking the instrumentation into `dalli`
+      # Patcher enables patching of 'dalli' module.
       module Patcher
-        include Base
-        register_as :dalli, auto_patch: true
-        option :service_name, default: 'memcached'
-
-        @patched = false
-
-        class << self
-          def patch
-            return @patched if patched? || !compatible?
+        include Contrib::Patcher
 
-            require 'ddtrace/ext/app_types'
-            require_relative 'instrumentation'
+        module_function
 
-            add_pin!
-            Instrumentation.patch!
-
-            @patched = true
-          rescue => e
-            Tracer.log.error("Unable to apply Dalli integration: #{e}")
-            @patched
-          end
+        def patched?
+          done?(:dalli)
+        end
 
-          def patched?
-            @patched
+        def patch
+          do_once(:dalli) do
+            begin
+              add_pin!
+              Instrumentation.patch!
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Dalli integration: #{e}")
+            end
           end
+        end
 
-          private
-
-          def compatible?
-            return unless defined?(::Dalli::VERSION)
-
-            Gem::Version.new(::Dalli::VERSION) > COMPATIBLE_WITH
-          end
+        def add_pin!
+          Pin
+            .new(
+              get_option(:service_name),
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::CACHE,
+              tracer: get_option(:tracer)
+            ).onto(::Dalli)
+        end
 
-          def add_pin!
-            Pin
-              .new(get_option(:service_name), app: 'dalli', app_type: Ext::AppTypes::CACHE)
-              .onto(::Dalli)
-          end
+        def get_option(option)
+          Datadog.configuration[:dalli].get_option(option)
         end
       end
     end

data/lib/ddtrace/contrib/dalli/quantize.rb

@@ -1,17 +1,17 @@
+require 'ddtrace/contrib/dalli/ext'
+
 module Datadog
   module Contrib
     module Dalli
       # Quantize contains dalli-specic quantization tools.
       module Quantize
-        MAX_CMD_LENGTH = 100
-
         module_function
 
         def format_command(operation, args)
           placeholder = "#{operation} BLOB (OMITTED)"
           command = [operation, *args].join(' ').strip
           command = Utils.utf8_encode(command, binary: true, placeholder: placeholder)
-          Utils.truncate(command, MAX_CMD_LENGTH)
+          Utils.truncate(command, Ext::QUANTIZE_MAX_CMD_LENGTH)
         rescue => e
           Tracer.log.debug("Error sanitizing Dalli operation: #{e}")
           placeholder

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

@@ -0,0 +1,15 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/delayed_job/ext'
+
+module Datadog
+  module Contrib
+    module DelayedJob
+      module Configuration
+        # Custom settings for the DelayedJob integration
+        class Settings < Contrib::Configuration::Settings
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end