ddtrace 0.42.0 → 0.54.2

data/lib/ddtrace/contrib/integration.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/configurable'
 require 'ddtrace/contrib/patchable'
 require 'ddtrace/contrib/registerable'
@@ -7,9 +8,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/configuration/settings.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/kafka/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Kafka

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Kafka

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/active_support/notifications/event'
 require 'ddtrace/contrib/kafka/ext'
@@ -8,8 +9,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.
@@ -42,7 +43,7 @@ module Datadog
             # Measure service stats
             Contrib::Analytics.set_measured(span)
 
-            span.set_error(payload[:exception_object]) if payload[:exception_object]
+            report_if_exception(span, payload)
           end
         end
       end

data/lib/ddtrace/contrib/kafka/events/connection/request.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 

data/lib/ddtrace/contrib/kafka/events/consumer/process_batch.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/consumer/process_message.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/consumer_group/heartbeat.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/consumer_group/join_group.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/consumer_group/leave_group.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/consumer_group/sync_group.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 require 'ddtrace/contrib/kafka/consumer_event'

data/lib/ddtrace/contrib/kafka/events/produce_operation/send_messages.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 

data/lib/ddtrace/contrib/kafka/events/producer/deliver_messages.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/kafka/ext'
 require 'ddtrace/contrib/kafka/event'
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/kafka/events/connection/request'
 require 'ddtrace/contrib/kafka/events/consumer/process_batch'
 require 'ddtrace/contrib/kafka/events/consumer/process_message'

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Kafka

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/kafka/configuration/settings'
 require 'ddtrace/contrib/kafka/patcher'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/ext/app_types'
 require 'ddtrace/contrib/kafka/ext'

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

@@ -0,0 +1,19 @@
+# typed: false
+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,11 @@
+# typed: true
+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,39 @@
+# typed: true
+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,46 @@
+# typed: false
+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

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

@@ -0,0 +1,26 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/lograge/instrumentation'
+
+module Datadog
+  module Contrib
+    # Datadog Lograge integration.
+    module Lograge
+      # Patcher enables patching of 'lograge' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        # patch applies our patch
+        def patch
+          ::Lograge::LogSubscribers::Base.include(Instrumentation)
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/mongodb/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module MongoDB

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/pin'
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/app_types'
@@ -13,7 +14,7 @@ module Datadog
         # Instrumentation for Mongo::Client
         module Client
           def self.included(base)
-            base.send(:include, InstanceMethods)
+            base.include(InstanceMethods)
           end
 
           # Instance methods for Mongo::Client
@@ -23,6 +24,7 @@ module Datadog
               return unless respond_to? :cluster
               return unless cluster.respond_to? :addresses
               return unless cluster.addresses.respond_to? :first
+
               Datadog::Pin.get_from(cluster.addresses.first)
             end
 
@@ -31,6 +33,7 @@ module Datadog
               return unless respond_to? :cluster
               return unless cluster.respond_to? :addresses
               return unless cluster.addresses.respond_to? :each
+
               # attach the PIN to all cluster addresses. One of them is used
               # when executing a Command and it is attached to the Monitoring
               # Event instance.
@@ -42,14 +45,14 @@ module Datadog
         # Instrumentation for Mongo::Address
         module Address
           def self.included(base)
-            base.send(:include, InstanceMethods)
+            base.include(InstanceMethods)
           end
 
           # Instance methods for Mongo::Address
           module InstanceMethods
             def datadog_pin
               @datadog_pin ||= begin
-                service = Datadog.configuration[:mongo][:service_name]
+                service = Datadog.configuration[:mongo, seed][:service_name]
 
                 Datadog::Pin.new(
                   service,

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

@@ -1,4 +1,6 @@
+# typed: false
 require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/configuration/resolvers/pattern_resolver'
 require 'ddtrace/contrib/mongodb/configuration/settings'
 require 'ddtrace/contrib/mongodb/patcher'
 
@@ -32,6 +34,10 @@ module Datadog
         def patcher
           Patcher
         end
+
+        def resolver
+          @resolver ||= Contrib::Configuration::Resolvers::PatternResolver.new
+        end
       end
     end
   end

data/lib/ddtrace/contrib/mongodb/parsers.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     # MongoDB module includes classes and functions to instrument MongoDB clients

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/mongodb/ext'
 require 'ddtrace/contrib/mongodb/instrumentation'
@@ -16,8 +17,8 @@ module Datadog
         end
 
         def patch
-          ::Mongo::Address.send(:include, Instrumentation::Address)
-          ::Mongo::Client.send(:include, Instrumentation::Client)
+          ::Mongo::Address.include(Instrumentation::Address)
+          ::Mongo::Client.include(Instrumentation::Client)
           add_mongo_monitoring
         end
 

data/lib/ddtrace/contrib/mongodb/subscribers.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/mongodb/ext'
 require 'ddtrace/contrib/mongodb/parsers'
@@ -29,9 +30,7 @@ module Datadog
           span.set_tag(Datadog::Ext::Integration::TAG_PEER_SERVICE, span.service)
 
           # Set analytics sample rate
-          if analytics_enabled?
-            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate)
-          end
+          Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
           # add operation tags; the full query is stored and used as a resource,
           # since it has been quantized and reduced
@@ -92,6 +91,7 @@ module Datadog
 
         def clear_span(event)
           return if Thread.current[:datadog_mongo_span].nil?
+
           Thread.current[:datadog_mongo_span].delete(event.request_id)
         end
 

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/mysql2/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Mysql2

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/ext/app_types'
 require 'ddtrace/ext/integration'
 require 'ddtrace/ext/net'
@@ -11,7 +12,7 @@ module Datadog
       # Mysql2::Client patch module
       module Instrumentation
         def self.included(base)
-          base.send(:prepend, InstanceMethods)
+          base.prepend(InstanceMethods)
         end
 
         # Mysql2::Client patch instance methods

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/mysql2/configuration/settings'
 require 'ddtrace/contrib/mysql2/patcher'

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/mysql2/instrumentation'
 
@@ -19,7 +20,7 @@ module Datadog
         end
 
         def patch_mysql2_client
-          ::Mysql2::Client.send(:include, Instrumentation)
+          ::Mysql2::Client.include(Instrumentation)
         end
       end
     end

data/lib/ddtrace/contrib/patchable.rb

@@ -1,10 +1,11 @@
+# typed: false
 module Datadog
   module Contrib
     # Base provides features that are shared across all integrations
     module Patchable
       def self.included(base)
-        base.send(:extend, ClassMethods)
-        base.send(:include, InstanceMethods)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
       end
 
       # Class methods for integrations
@@ -42,16 +43,27 @@ module Datadog
 
         def patch
           if !self.class.patchable? || patcher.nil?
-            desc = "Available?: #{self.class.available?}"
-            desc += ", Loaded? #{self.class.loaded?}"
-            desc += ", Compatible? #{self.class.compatible?}"
-            desc += ", Patchable? #{self.class.patchable?}"
-
-            Datadog.logger.warn("Unable to patch #{self.class.name} (#{desc})")
-            return
+            return {
+              name: self.class.name,
+              available: self.class.available?,
+              loaded: self.class.loaded?,
+              compatible: self.class.compatible?,
+              patchable: self.class.patchable?
+            }
           end
 
           patcher.patch
+          true
+        end
+
+        # Can the patch for this integration be applied automatically?
+        # For example: test integrations should only be applied
+        # by the user explicitly setting `c.use :rspec`
+        # and rails sub-modules are auto-instrumented by enabling rails
+        # so auto-instrumenting them on their own will cause changes in
+        # service naming behavior
+        def auto_instrument?
+          true
         end
       end
     end

data/lib/ddtrace/contrib/patcher.rb

@@ -1,14 +1,13 @@
-require 'ddtrace/patcher'
+# typed: false
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
     # Common behavior for patcher modules
     module Patcher
       def self.included(base)
-        base.send(:include, Datadog::Patcher)
-
-        base.singleton_class.send(:prepend, CommonMethods)
-        base.send(:prepend, CommonMethods) if base.class == Class
+        base.singleton_class.prepend(CommonMethods)
+        base.prepend(CommonMethods) if base.instance_of?(Class)
       end
 
       # Prepended instance methods for all patchers
@@ -18,13 +17,13 @@ module Datadog
         end
 
         def patched?
-          done?(:patch)
+          patch_only_once.ran?
         end
 
         def patch
           return unless defined?(super)
 
-          do_once(:patch) do
+          patch_only_once.run do
             begin
               super.tap do
                 # Emit a metric
@@ -40,7 +39,7 @@ module Datadog
         # @param e [Exception]
         def on_patch_error(e)
           # Log the error
-          Datadog.logger.error("Failed to apply #{patch_name} patch. Cause: #{e} Location: #{e.backtrace.first}")
+          Datadog.logger.error("Failed to apply #{patch_name} patch. Cause: #{e} Location: #{Array(e.backtrace).first}")
 
           # Emit a metric
           tags = default_tags
@@ -56,6 +55,11 @@ module Datadog
             tags << "target_version:#{target_version}" if respond_to?(:target_version) && !target_version.nil?
           end
         end
+
+        def patch_only_once
+          # NOTE: This is not thread-safe
+          @patch_only_once ||= Datadog::Utils::OnlyOnce.new
+        end
       end
     end
   end

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/configuration/settings'
 require 'ddtrace/contrib/presto/ext'
 

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

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Contrib
     module Presto

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

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/ext/net'
 require 'ddtrace/ext/sql'
 require 'ddtrace/ext/app_types'
@@ -11,7 +12,7 @@ module Datadog
         # Instrumentation for Presto::Client::Client
         module Client
           def self.included(base)
-            base.send(:prepend, InstanceMethods)
+            base.prepend(InstanceMethods)
           end
 
           # Instance methods for Presto::Client

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

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/contrib/integration'
 require 'ddtrace/contrib/presto/configuration/settings'
 require 'ddtrace/contrib/presto/patcher'

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

@@ -1,6 +1,8 @@
+# typed: true
 require 'ddtrace/contrib/patcher'
 require 'ddtrace/contrib/presto/ext'
 require 'ddtrace/contrib/presto/instrumentation'
+require 'ddtrace/utils/only_once'
 
 module Datadog
   module Contrib
@@ -9,16 +11,18 @@ module Datadog
       module Patcher
         include Contrib::Patcher
 
+        PATCH_ONLY_ONCE = Datadog::Utils::OnlyOnce.new
+
         module_function
 
         def patched?
-          done?(:presto)
+          PATCH_ONLY_ONCE.ran?
         end
 
         def patch
-          do_once(:presto) do
+          PATCH_ONLY_ONCE.run do
             begin
-              ::Presto::Client::Client.send(:include, Instrumentation::Client)
+              ::Presto::Client::Client.include(Instrumentation::Client)
             rescue StandardError => e
               Datadog.logger.error("Unable to apply Presto integration: #{e}")
             end