ls-trace 0.1.2 → 0.2.0

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

@@ -0,0 +1,29 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+require 'ddtrace/contrib/kafka/consumer_event'
+require 'ddtrace/contrib/kafka/consumer_group_event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module ConsumerGroup
+          # Defines instrumentation for sync_group.consumer.kafka event
+          module SyncGroup
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+            extend Kafka::ConsumerGroupEvent
+
+            EVENT_NAME = 'sync_group.consumer.kafka'.freeze
+
+            module_function
+
+            def span_name
+              Ext::SPAN_CONSUMER_SYNC_GROUP
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module ProduceOperation
+          # Defines instrumentation for send_messages.producer.kafka event
+          module SendMessages
+            include Kafka::Event
+
+            EVENT_NAME = 'send_messages.producer.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              span.set_tag(Ext::TAG_MESSAGE_COUNT, payload[:message_count]) if payload.key?(:message_count)
+              span.set_tag(Ext::TAG_SENT_MESSAGE_COUNT, payload[:sent_message_count]) if payload.key?(:sent_message_count)
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_SEND_MESSAGES
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module Producer
+          # Defines instrumentation for deliver_messages.producer.kafka event
+          module DeliverMessages
+            include Kafka::Event
+
+            EVENT_NAME = 'deliver_messages.producer.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              span.set_tag(Ext::TAG_ATTEMPTS, payload[:attempts]) if payload.key?(:attempts)
+              span.set_tag(Ext::TAG_MESSAGE_COUNT, payload[:message_count]) if payload.key?(:message_count)
+              if payload.key?(:delivered_message_count)
+                span.set_tag(Ext::TAG_DELIVERED_MESSAGE_COUNT, payload[:delivered_message_count])
+              end
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_DELIVER_MESSAGES
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Datadog
+  module Contrib
+    module Kafka
+      # Kafka integration constants
+      module Ext
+        APP = 'kafka'.freeze
+        ENV_ENABLED = 'DD_TRACE_KAFKA_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_KAFKA_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_KAFKA_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_KAFKA_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_KAFKA_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'kafka'.freeze
+        SPAN_CONNECTION_REQUEST = 'kafka.connection.request'.freeze
+        SPAN_CONSUMER_HEARTBEAT = 'kafka.consumer.heartbeat'.freeze
+        SPAN_CONSUMER_JOIN_GROUP = 'kafka.consumer.join_group'.freeze
+        SPAN_CONSUMER_LEAVE_GROUP = 'kafka.consumer.leave_group'.freeze
+        SPAN_CONSUMER_SYNC_GROUP = 'kafka.consumer.sync_group'.freeze
+        SPAN_DELIVER_MESSAGES = 'kafka.producer.deliver_messages'.freeze
+        SPAN_PROCESS_BATCH = 'kafka.consumer.process_batch'.freeze
+        SPAN_PROCESS_MESSAGE = 'kafka.consumer.process_message'.freeze
+        SPAN_SEND_MESSAGES = 'kafka.producer.send_messages'.freeze
+        TAG_ATTEMPTS = 'kafka.attempts'.freeze
+        TAG_API = 'kafka.api'.freeze
+        TAG_CLIENT = 'kafka.client'.freeze
+        TAG_GROUP = 'kafka.group'.freeze
+        TAG_HIGHWATER_MARK_OFFSET = 'kafka.highwater_mark_offset'.freeze
+        TAG_MESSAGE_COUNT = 'kafka.message_count'.freeze
+        TAG_MESSAGE_KEY = 'kafka.message_key'.freeze
+        TAG_DELIVERED_MESSAGE_COUNT = 'kafka.delivered_message_count'.freeze
+        TAG_OFFSET = 'kafka.offset'.freeze
+        TAG_OFFSET_LAG = 'kafka.offset_lag'.freeze
+        TAG_PARTITION = 'kafka.partition'.freeze
+        TAG_REQUEST_SIZE = 'kafka.request_size'.freeze
+        TAG_RESPONSE_SIZE = 'kafka.response_size'.freeze
+        TAG_SENT_MESSAGE_COUNT = 'kafka.sent_message_count'.freeze
+        TAG_TOPIC = 'kafka.topic'.freeze
+        TAG_TOPIC_PARTITIONS = 'kafka.topic_partitions'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/kafka/configuration/settings'
+require 'ddtrace/contrib/kafka/patcher'
+
+module Datadog
+  module Contrib
+    module Kafka
+      # Description of Kafka integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.7.10')
+
+        register_as :kafka, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['ruby-kafka'] && Gem.loaded_specs['ruby-kafka'].version
+        end
+
+        def self.loaded?
+          !defined?(::Kafka).nil? \
+            && !defined?(::ActiveSupport::Notifications).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/events'
+
+module Datadog
+  module Contrib
+    module Kafka
+      # Patcher enables patching of 'kafka' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          # Subscribe to Kafka events
+          Events.subscribe!
+        end
+      end
+    end
+  end
+end

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

@@ -9,13 +9,18 @@ module Datadog
         class Settings < Contrib::Configuration::Settings
           DEFAULT_QUANTIZE = { show: [:collection, :database, :operation] }.freeze
 
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # MongoDB integration constants
       module Ext
         APP = 'mongodb'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_MONGO_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_MONGO_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_MONGO_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_MONGO_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_MONGO_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_MONGO_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_MONGO_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'mongodb'.freeze
         SPAN_COMMAND = 'mongo.cmd'.freeze
         SPAN_TYPE_COMMAND = 'mongodb'.freeze

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

@@ -49,14 +49,13 @@ module Datadog
           module InstanceMethods
             def datadog_pin
               @datadog_pin ||= begin
-                tracer = Datadog.configuration[:mongo][:tracer]
                 service = Datadog.configuration[:mongo][:service_name]
 
                 Datadog::Pin.new(
                   service,
                   app: Datadog::Contrib::MongoDB::Ext::APP,
                   app_type: Datadog::Ext::AppTypes::DB,
-                  tracer: tracer
+                  tracer: -> { Datadog.configuration[:mongo][:tracer] }
                 )
               end
             end

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

@@ -9,18 +9,20 @@ module Datadog
       class Integration
         include Contrib::Integration
 
+        MINIMUM_VERSION = Gem::Version.new('2.1.0')
+
         register_as :mongo, auto_patch: true
 
         def self.version
           Gem.loaded_specs['mongo'] && Gem.loaded_specs['mongo'].version
         end
 
-        def self.present?
-          super && defined?(::Mongo::Monitoring::Global)
+        def self.loaded?
+          !defined?(::Mongo::Monitoring::Global).nil?
         end
 
         def self.compatible?
-          super && version >= Gem::Version.new('2.1.0')
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

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

@@ -11,20 +11,14 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:mongo)
+        def target_version
+          Integration.version
         end
 
         def patch
-          do_once(:mongo) do
-            begin
-              ::Mongo::Address.send(:include, Instrumentation::Address)
-              ::Mongo::Client.send(:include, Instrumentation::Client)
-              add_mongo_monitoring
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply MongoDB integration: #{e}")
-            end
-          end
+          ::Mongo::Address.send(:include, Instrumentation::Address)
+          ::Mongo::Client.send(:include, Instrumentation::Client)
+          add_mongo_monitoring
         end
 
         def add_mongo_monitoring

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

@@ -50,7 +50,7 @@ module Datadog
           # the framework itself, so we set only the error and the message
           span.set_error(event)
         rescue StandardError => e
-          Datadog::Tracer.log.debug("error when handling MongoDB 'failed' event: #{e}")
+          Datadog.logger.debug("error when handling MongoDB 'failed' event: #{e}")
         ensure
           # whatever happens, the Span must be removed from the local storage and
           # it must be finished to prevent any leak
@@ -66,7 +66,7 @@ module Datadog
           rows = event.reply.fetch('n', nil)
           span.set_tag(Ext::TAG_ROWS, rows) unless rows.nil?
         rescue StandardError => e
-          Datadog::Tracer.log.debug("error when handling MongoDB 'succeeded' event: #{e}")
+          Datadog.logger.debug("error when handling MongoDB 'succeeded' event: #{e}")
         ensure
           # whatever happens, the Span must be removed from the local storage and
           # it must be finished to prevent any leak

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Mysql2 integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Mysql2 integration constants
       module Ext
         APP = 'mysql2'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_MYSQL2_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_MYSQL2_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_MYSQL2_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_MYSQL2_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_MYSQL2_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_MYSQL2_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_MYSQL2_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'mysql2'.freeze
         SPAN_QUERY = 'mysql2.query'.freeze
         TAG_DB_NAME = 'mysql2.db.name'.freeze

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

@@ -36,7 +36,7 @@ module Datadog
               Datadog.configuration[:mysql2][:service_name],
               app: Ext::APP,
               app_type: Datadog::Ext::AppTypes::DB,
-              tracer: Datadog.configuration[:mysql2][:tracer]
+              tracer: -> { Datadog.configuration[:mysql2][:tracer] }
             )
           end
 

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

@@ -9,14 +9,20 @@ module Datadog
       class Integration
         include Contrib::Integration
 
+        MINIMUM_VERSION = Gem::Version.new('0.3.21')
+
         register_as :mysql2
 
         def self.version
           Gem.loaded_specs['mysql2'] && Gem.loaded_specs['mysql2'].version
         end
 
-        def self.present?
-          super && defined?(::Mysql2)
+        def self.loaded?
+          !defined?(::Mysql2).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

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

@@ -10,18 +10,12 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:mysql2)
+        def target_version
+          Integration.version
         end
 
         def patch
-          do_once(:mysql2) do
-            begin
-              patch_mysql2_client
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply mysql2 integration: #{e}")
-            end
-          end
+          patch_mysql2_client
         end
 
         def patch_mysql2_client

data/lib/ddtrace/contrib/patchable.rb

@@ -13,12 +13,24 @@ module Datadog
           nil
         end
 
-        def present?
+        # Is the target available? (e.g. gem installed?)
+        def available?
           !version.nil?
         end
 
+        # Is the target loaded into the application? (e.g. constants defined?)
+        def loaded?
+          true
+        end
+
+        # Is the loaded code compatible with this integration? (e.g. minimum version met?)
         def compatible?
-          Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION) && present?
+          available? && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION)
+        end
+
+        # Can the patch for this integration be applied?
+        def patchable?
+          available? && loaded? && compatible?
         end
       end
 
@@ -29,8 +41,13 @@ module Datadog
         end
 
         def patch
-          if !self.class.compatible? || patcher.nil?
-            Datadog::Tracer.log.warn("Unable to patch #{self.class.name}")
+          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
           end