ddtrace 0.16.1 → 0.17.0

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

@@ -1,44 +1,28 @@
-require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/patcher'
 
 module Datadog
   module Contrib
     module Excon
-      # Responsible for hooking the instrumentation into Excon
+      # Patcher enables patching of 'excon' module.
       module Patcher
-        include Base
-
-        DEFAULT_SERVICE = 'excon'.freeze
-
-        register_as :excon
-        option :tracer, default: Datadog.tracer
-        option :service_name, default: DEFAULT_SERVICE
-        option :distributed_tracing, default: false
-        option :split_by_domain, default: false
-        option :error_handler, default: nil
-
-        @patched = false
+        include Contrib::Patcher
 
         module_function
 
-        def patch
-          return @patched if patched? || !compatible?
-
-          require 'ddtrace/contrib/excon/middleware'
-
-          add_middleware
-
-          @patched = true
-        rescue => e
-          Tracer.log.error("Unable to apply Excon integration: #{e}")
-          @patched
-        end
-
         def patched?
-          @patched
+          done?(:excon)
         end
 
-        def compatible?
-          defined?(::Excon)
+        def patch
+          do_once(:excon) do
+            begin
+              require 'ddtrace/contrib/excon/middleware'
+
+              add_middleware
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Excon integration: #{e}")
+            end
+          end
         end
 
         def add_middleware

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

@@ -0,0 +1,23 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/faraday/ext'
+
+module Datadog
+  module Contrib
+    module Faraday
+      module Configuration
+        # Custom settings for the Faraday integration
+        class Settings < Contrib::Configuration::Settings
+          DEFAULT_ERROR_HANDLER = lambda do |env|
+            Datadog::Ext::HTTP::ERROR_RANGE.cover?(env[:status])
+          end
+
+          option :distributed_tracing, default: false
+          option :error_handler, default: DEFAULT_ERROR_HANDLER
+          option :service_name, default: Ext::SERVICE_NAME
+          option :split_by_domain, default: false
+        end
+      end
+    end
+  end
+end

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

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

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

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

data/lib/ddtrace/contrib/faraday/middleware.rb

@@ -2,23 +2,24 @@ require 'faraday'
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/net'
 require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/faraday/ext'
 
 module Datadog
   module Contrib
     module Faraday
       # Middleware implements a faraday-middleware for ddtrace instrumentation
       class Middleware < ::Faraday::Middleware
-        include Ext::DistributedTracing
+        include Datadog::Ext::DistributedTracing
 
         def initialize(app, options = {})
           super(app)
-          @options = Datadog.configuration[:faraday].merge(options)
+          @options = Datadog.configuration[:faraday].to_h.merge(options)
           @tracer = Pin.get_from(::Faraday).tracer
           setup_service!
         end
 
         def call(env)
-          tracer.trace(NAME) do |span|
+          tracer.trace(Ext::SPAN_REQUEST) do |span|
             annotate!(span, env)
             propagate!(span, env) if options[:distributed_tracing] && tracer.enabled
             app.call(env).on_complete { |resp| handle_response(span, resp) }
@@ -32,11 +33,11 @@ module Datadog
         def annotate!(span, env)
           span.resource = env[:method].to_s.upcase
           span.service = service_name(env)
-          span.span_type = Ext::HTTP::TYPE
-          span.set_tag(Ext::HTTP::URL, env[:url].path)
-          span.set_tag(Ext::HTTP::METHOD, env[:method].to_s.upcase)
-          span.set_tag(Ext::NET::TARGET_HOST, env[:url].host)
-          span.set_tag(Ext::NET::TARGET_PORT, env[:url].port)
+          span.span_type = Datadog::Ext::HTTP::TYPE
+          span.set_tag(Datadog::Ext::HTTP::URL, env[:url].path)
+          span.set_tag(Datadog::Ext::HTTP::METHOD, env[:method].to_s.upcase)
+          span.set_tag(Datadog::Ext::NET::TARGET_HOST, env[:url].host)
+          span.set_tag(Datadog::Ext::NET::TARGET_PORT, env[:url].port)
         end
 
         def handle_response(span, env)
@@ -44,7 +45,7 @@ module Datadog
             span.set_error(["Error #{env[:status]}", env[:body]])
           end
 
-          span.set_tag(Ext::HTTP::STATUS_CODE, env[:status])
+          span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, env[:status])
         end
 
         def propagate!(span, env)

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

@@ -1,71 +1,56 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/faraday/ext'
+
 module Datadog
   module Contrib
     module Faraday
-      COMPATIBLE_UNTIL = Gem::Version.new('1.0.0')
-      SERVICE = 'faraday'.freeze
-      NAME = 'faraday.request'.freeze
-
-      # Responsible for hooking the instrumentation into faraday
+      # Patcher enables patching of 'faraday' module.
       module Patcher
-        include Base
+        include Contrib::Patcher
 
-        register_as :faraday, auto_patch: true
+        module_function
 
-        DEFAULT_ERROR_HANDLER = lambda do |env|
-          Ext::HTTP::ERROR_RANGE.cover?(env[:status])
+        def patched?
+          done?(:faraday)
         end
 
-        option :service_name, default: SERVICE
-        option :distributed_tracing, default: false
-        option :error_handler, default: DEFAULT_ERROR_HANDLER
-        option :tracer, default: Datadog.tracer
-
-        @patched = false
-
-        class << self
-          def patch
-            return @patched if patched? || !compatible?
-
-            require 'ddtrace/ext/app_types'
-            require 'ddtrace/contrib/faraday/middleware'
-
-            add_pin
-            add_middleware
-
-            @patched = true
-          rescue => e
-            Tracer.log.error("Unable to apply Faraday integration: #{e}")
-            @patched
-          end
-
-          def patched?
-            @patched
-          end
+        def patch
+          do_once(:faraday) do
+            begin
+              require 'ddtrace/contrib/faraday/middleware'
 
-          def register_service(name)
-            get_option(:tracer).set_service_info(name, 'faraday', Ext::AppTypes::WEB)
+              add_pin
+              add_middleware
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Faraday integration: #{e}")
+            end
           end
+        end
 
-          private
-
-          def compatible?
-            return unless defined?(::Faraday::VERSION)
+        def add_pin
+          Pin.new(
+            get_option(:service_name),
+            app: Ext::APP,
+            app_type: Datadog::Ext::AppTypes::WEB,
+            tracer: get_option(:tracer)
+          ).onto(::Faraday)
+        end
 
-            Gem::Version.new(::Faraday::VERSION) < COMPATIBLE_UNTIL
-          end
+        def add_middleware
+          ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
+        end
 
-          def add_pin
-            Pin.new(
-              get_option(:service_name),
-              app: 'faraday',
-              app_type: Ext::AppTypes::WEB,
-              tracer: get_option(:tracer)
-            ).onto(::Faraday)
-          end
+        def register_service(name)
+          get_option(:tracer).set_service_info(
+            name,
+            Ext::APP,
+            Datadog::Ext::AppTypes::WEB
+          )
+        end
 
-          def add_middleware
-            ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
-          end
+        def get_option(option)
+          Datadog.configuration[:faraday].get_option(option)
         end
       end
     end

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

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

data/lib/ddtrace/contrib/grape/endpoint.rb

@@ -1,6 +1,6 @@
 require 'ddtrace/ext/http'
 require 'ddtrace/ext/errors'
-require 'ddtrace/contrib/rack/middlewares'
+require 'ddtrace/contrib/rack/ext'
 
 module Datadog
   module Contrib
@@ -13,9 +13,6 @@ module Datadog
         KEY_RENDER = 'datadog_grape_endpoint_render'.freeze
 
         def self.subscribe
-          # Grape is instrumented only if it's available
-          return unless defined?(::Grape) && defined?(::ActiveSupport::Notifications)
-
           # subscribe when a Grape endpoint is hit
           ::ActiveSupport::Notifications.subscribe('endpoint_run.grape.start_process') do |*args|
             endpoint_start_process(*args)
@@ -45,7 +42,7 @@ module Datadog
           tracer = pin.tracer
           service = pin.service
           type = Datadog::Ext::HTTP::TYPE
-          tracer.trace('grape.endpoint_run', service: service, span_type: type)
+          tracer.trace(Ext::SPAN_ENDPOINT_RUN, service: service, span_type: type)
 
           Thread.current[KEY_RUN] = true
         rescue StandardError => e
@@ -61,7 +58,7 @@ module Datadog
           return unless pin && pin.enabled?
 
           tracer = pin.tracer
-          span = tracer.active_span()
+          span = tracer.active_span
           return unless span
 
           begin
@@ -72,8 +69,8 @@ module Datadog
             span.resource = resource
 
             # set the request span resource if it's a `rack.request` span
-            request_span = payload[:env][Datadog::Contrib::Rack::TraceMiddleware::RACK_REQUEST_SPAN]
-            if !request_span.nil? && request_span.name == 'rack.request'
+            request_span = payload[:env][Datadog::Contrib::Rack::Ext::RACK_ENV_REQUEST_SPAN]
+            if !request_span.nil? && request_span.name == Datadog::Contrib::Rack::Ext::SPAN_REQUEST
               request_span.resource = resource
             end
 
@@ -81,8 +78,8 @@ module Datadog
             span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
 
             # override the current span with this notification values
-            span.set_tag('grape.route.endpoint', api_view)
-            span.set_tag('grape.route.path', path)
+            span.set_tag(Ext::TAG_ROUTE_ENDPOINT, api_view)
+            span.set_tag(Ext::TAG_ROUTE_PATH, path)
           ensure
             span.start_time = start
             span.finish(finish)
@@ -102,7 +99,7 @@ module Datadog
           tracer = pin.tracer
           service = pin.service
           type = Datadog::Ext::HTTP::TYPE
-          tracer.trace('grape.endpoint_render', service: service, span_type: type)
+          tracer.trace(Ext::SPAN_ENDPOINT_RENDER, service: service, span_type: type)
 
           Thread.current[KEY_RENDER] = true
         rescue StandardError => e
@@ -118,7 +115,7 @@ module Datadog
           return unless pin && pin.enabled?
 
           tracer = pin.tracer
-          span = tracer.active_span()
+          span = tracer.active_span
           return unless span
 
           # catch thrown exceptions
@@ -151,7 +148,7 @@ module Datadog
           begin
             # catch thrown exceptions
             span.set_error(payload[:exception_object]) unless payload[:exception_object].nil?
-            span.set_tag('grape.filter.type', type.to_s)
+            span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
           ensure
             span.start_time = start
             span.finish(finish)

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

@@ -0,0 +1,19 @@
+module Datadog
+  module Contrib
+    module Grape
+      # Grape integration constants
+      module Ext
+        APP = 'grape'.freeze
+        SERVICE_NAME = 'grape'.freeze
+
+        SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'.freeze
+        SPAN_ENDPOINT_RUN = 'grape.endpoint_run'.freeze
+        SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'.freeze
+
+        TAG_FILTER_TYPE = 'grape.filter.type'.freeze
+        TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
+        TAG_ROUTE_PATH = 'grape.route.path'.freeze
+      end
+    end
+  end
+end

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

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