ddtrace 0.46.0 → 0.51.0

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

@@ -1,3 +1,4 @@
+require 'ddtrace/patcher'
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/integration'

data/lib/ddtrace/contrib/ethon/easy_patch.rb

@@ -11,7 +11,7 @@ module Datadog
       # Ethon EasyPatch
       module EasyPatch
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation

data/lib/ddtrace/contrib/ethon/multi_patch.rb

@@ -11,7 +11,7 @@ module Datadog
       module MultiPatch
         def self.included(base)
           # No need to prepend here since add method is included into Multi class
-          base.send(:include, InstanceMethods)
+          base.include(InstanceMethods)
         end
 
         # InstanceMethods - implementing instrumentation

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

@@ -16,8 +16,8 @@ module Datadog
           require 'ddtrace/contrib/ethon/easy_patch'
           require 'ddtrace/contrib/ethon/multi_patch'
 
-          ::Ethon::Easy.send(:include, EasyPatch)
-          ::Ethon::Multi.send(:include, MultiPatch)
+          ::Ethon::Easy.include(EasyPatch)
+          ::Ethon::Multi.include(MultiPatch)
         end
       end
     end

data/lib/ddtrace/contrib/extensions.rb

@@ -7,9 +7,9 @@ module Datadog
     # Adds registry, configuration access for integrations.
     module Extensions
       def self.extended(base)
-        Datadog.send(:extend, Helpers)
-        Datadog.send(:extend, Configuration)
-        Datadog::Configuration::Settings.send(:include, Configuration::Settings)
+        Datadog.extend(Helpers)
+        Datadog.extend(Configuration)
+        Datadog::Configuration::Settings.include(Configuration::Settings)
       end
 
       # Helper methods for Datadog module.
@@ -47,7 +47,7 @@ module Datadog
               desc += ", Compatible? #{patch_results[:compatible]}"
               desc += ", Patchable? #{patch_results[:patchable]}"
 
-              Datadog.logger.warn("Unable to patch #{patch_results['name']} (#{desc})")
+              Datadog.logger.warn("Unable to patch #{patch_results[:name]} (#{desc})")
             end
 
             target.integrations_pending_activation.clear
@@ -67,9 +67,32 @@ module Datadog
             end
           end
 
-          def [](integration_name, configuration_name = :default)
+          # For the provided `integration_name`, resolves a matching configuration
+          # for the provided integration from an integration-specific `key`.
+          #
+          # How the matching is performed is integration-specific.
+          #
+          # @param [Symbol] integration_name the integration name
+          # @param [Object] key the integration-specific lookup key
+          # @return [Datadog::Contrib::Configuration::Settings]
+          def [](integration_name, key = :default)
             integration = fetch_integration(integration_name)
-            integration.configuration(configuration_name) unless integration.nil?
+            integration.resolve(key) unless integration.nil?
+          end
+
+          # For the provided `integration_name`, retrieves a configuration previously
+          # stored by `#instrument`. Specifically, `describes` should be
+          # the same value provided in the `describes:` option for `#instrument`.
+          #
+          # If no `describes` value is provided, the default configuration is returned.
+          #
+          # @param [Symbol] integration_name the integration name
+          # @param [Object] describes the previously configured `describes:` object. If `nil`,
+          #   fetches the default configuration
+          # @return [Datadog::Contrib::Configuration::Settings]
+          def configuration(integration_name, describes = nil)
+            integration = fetch_integration(integration_name)
+            integration.configuration(describes) unless integration.nil?
           end
 
           def instrument(integration_name, options = {}, &block)

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

@@ -34,7 +34,7 @@ module Datadog
             ::Faraday.default_connection.use(:ddtrace)
 
             # Patch new connection instances (e.g. +Faraday.new+)
-            ::Faraday::Connection.send(:prepend, Connection)
+            ::Faraday::Connection.prepend(Connection)
           else
             # Patch the default connection (e.g. +Faraday.get+)
             #
@@ -44,7 +44,7 @@ module Datadog
             ::Faraday.default_connection.builder.insert(idx, Middleware)
 
             # Patch new connection instances (e.g. +Faraday.new+)
-            ::Faraday::RackBuilder.send(:prepend, RackBuilder)
+            ::Faraday::RackBuilder.prepend(RackBuilder)
           end
         end
       end

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

@@ -4,8 +4,8 @@ module Datadog
       # Instrumentation for Grape::Endpoint
       module Instrumentation
         def self.included(base)
-          base.singleton_class.send(:prepend, ClassMethods)
-          base.send(:prepend, InstanceMethods)
+          base.singleton_class.prepend(ClassMethods)
+          base.prepend(InstanceMethods)
         end
 
         # ClassMethods - implementing instrumentation

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

@@ -20,7 +20,7 @@ module Datadog
 
         def patch
           # Patch endpoints
-          ::Grape::Endpoint.send(:include, Instrumentation)
+          ::Grape::Endpoint.include(Instrumentation)
 
           # Subscribe to ActiveSupport events
           Datadog::Contrib::Grape::Endpoint.subscribe

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

@@ -24,7 +24,7 @@ module Datadog
 
         def prepend_interceptor
           ::GRPC::InterceptionContext
-            .send(:prepend, Datadog::Contrib::GRPC::InterceptWithDatadog)
+            .prepend(Datadog::Contrib::GRPC::InterceptWithDatadog)
         end
       end
     end

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

@@ -14,7 +14,7 @@ module Datadog
       # Instrumentation for Net::HTTP
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Span hook invoked after request is completed.

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

@@ -18,7 +18,7 @@ module Datadog
 
         # patch applies our patch if needed
         def patch
-          ::Net::HTTP.send(:include, Instrumentation)
+          ::Net::HTTP.include(Instrumentation)
         end
       end
     end

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

@@ -12,7 +12,7 @@ module Datadog
       # Instrumentation for Httpclient
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for configuration
@@ -88,14 +88,12 @@ module Datadog
             service = config[:service_name]
             tracer = config[:tracer]
 
-            @datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
 
             if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
               @datadog_pin.service = service
@@ -111,14 +109,12 @@ module Datadog
             config = Datadog.configuration[:httpclient]
             service = config[:service_name]
 
-            @default_datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
           end
 
           def datadog_configuration(host = :default)

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/httpclient/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,10 +10,12 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:httpclient)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def target_version
@@ -21,9 +24,9 @@ module Datadog
 
         # patch applies our patch
         def patch
-          do_once(:httpclient) do
+          PATCH_ONLY_ONCE.run do
             begin
-              ::HTTPClient.send(:include, Instrumentation)
+              ::HTTPClient.include(Instrumentation)
             rescue StandardError => e
               Datadog::Logger.error("Unable to apply httpclient integration: #{e}")
             end

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

@@ -12,11 +12,10 @@ module Datadog
       # Instrumentation for Httprb
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Instance methods for configuration
-        # rubocop:disable Metrics/ModuleLength
         module InstanceMethods
           include Datadog::Contrib::HttpAnnotationHelper
 
@@ -99,14 +98,12 @@ module Datadog
             service = config[:service_name]
             tracer = config[:tracer]
 
-            @datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
 
             if @datadog_pin.service_name == default_datadog_pin.service_name && @datadog_pin.service_name != service
               @datadog_pin.service = service
@@ -122,14 +119,12 @@ module Datadog
             config = Datadog.configuration[:httprb]
             service = config[:service_name]
 
-            @default_datadog_pin ||= begin
-              Datadog::Pin.new(
-                service,
-                app: Ext::APP,
-                app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
-                tracer: -> { config[:tracer] }
-              )
-            end
+            @default_datadog_pin ||= Datadog::Pin.new(
+              service,
+              app: Ext::APP,
+              app_type: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              tracer: -> { config[:tracer] }
+            )
           end
 
           def datadog_configuration(host = :default)

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/httprb/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,10 +10,12 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:httprb)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def target_version
@@ -21,9 +24,9 @@ module Datadog
 
         # patch applies our patch
         def patch
-          do_once(:httprb) do
+          PATCH_ONLY_ONCE.run do
             begin
-              ::HTTP::Client.send(:include, Instrumentation)
+              ::HTTP::Client.include(Instrumentation)
             rescue StandardError => e
               Datadog::Logger.error("Unable to apply httprb integration: #{e}")
             end

data/lib/ddtrace/contrib/integration.rb

@@ -7,9 +7,9 @@ module Datadog
     # Base provides features that are shared across all integrations
     module Integration
       def self.included(base)
-        base.send(:include, Configurable)
-        base.send(:include, Patchable)
-        base.send(:include, Registerable)
+        base.include(Configurable)
+        base.include(Patchable)
+        base.include(Registerable)
       end
     end
   end

data/lib/ddtrace/contrib/kafka/event.rb

@@ -8,8 +8,8 @@ module Datadog
       # Defines basic behaviors for an ActiveSupport event.
       module Event
         def self.included(base)
-          base.send(:include, ActiveSupport::Notifications::Event)
-          base.send(:extend, ClassMethods)
+          base.include(ActiveSupport::Notifications::Event)
+          base.extend(ClassMethods)
         end
 
         # Class methods for Kafka events.

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

@@ -0,0 +1,18 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/lograge/ext'
+
+module Datadog
+  module Contrib
+    module Lograge
+      module Configuration
+        # Custom settings for the Lograge integration
+        class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Datadog
+  module Contrib
+    module Lograge
+      # Lograge integration constants
+      module Ext
+        ENV_ENABLED = 'DD_TRACE_LOGRAGE_ENABLED'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Datadog
+  module Contrib
+    module Lograge
+      # Instrumentation for Lograge
+      module Instrumentation
+        def self.included(base)
+          base.prepend(InstanceMethods)
+        end
+
+        # Instance methods for configuration
+        module InstanceMethods
+          def custom_options(event)
+            original_custom_options = super(event)
+
+            # Retrieves trace information for current thread
+            correlation = Datadog.tracer.active_correlation
+            # merge original lambda with datadog context
+
+            datadog_trace_log_hash = {
+              # Adds IDs as tags to log output
+              dd: {
+                # To preserve precision during JSON serialization, use strings for large numbers
+                trace_id: correlation.trace_id.to_s,
+                span_id: correlation.span_id.to_s,
+                env: correlation.env.to_s,
+                service: correlation.service.to_s,
+                version: correlation.version.to_s
+              },
+              ddsource: ['ruby']
+            }
+
+            datadog_trace_log_hash.merge(original_custom_options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/lograge/configuration/settings'
+require 'ddtrace/contrib/lograge/patcher'
+
+module Datadog
+  module Contrib
+    module Lograge
+      # Description of Lograge integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.11.0')
+
+        register_as :lograge
+
+        def self.version
+          Gem.loaded_specs['lograge'] && Gem.loaded_specs['lograge'].version
+        end
+
+        def self.loaded?
+          !defined?(::Lograge::LogSubscribers::Base).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        # enabled by rails integration and has a hard dependancy on rails
+        # so can safely say this shouldn't ever be part of auto instrumentation
+        # https://github.com/roidrage/lograge/blob/1729eab7956bb95c5992e4adab251e4f93ff9280/lograge.gemspec#L18-L20
+        def auto_instrument?
+          false
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end