ddtrace 0.37.0 → 0.38.0

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

@@ -0,0 +1,44 @@
+require 'ddtrace/contrib/kafka/events/connection/request'
+require 'ddtrace/contrib/kafka/events/consumer/process_batch'
+require 'ddtrace/contrib/kafka/events/consumer/process_message'
+require 'ddtrace/contrib/kafka/events/consumer_group/heartbeat'
+require 'ddtrace/contrib/kafka/events/consumer_group/join_group'
+require 'ddtrace/contrib/kafka/events/consumer_group/leave_group'
+require 'ddtrace/contrib/kafka/events/consumer_group/sync_group'
+require 'ddtrace/contrib/kafka/events/produce_operation/send_messages'
+require 'ddtrace/contrib/kafka/events/producer/deliver_messages'
+
+module Datadog
+  module Contrib
+    module Kafka
+      # Defines collection of instrumented Kafka events
+      module Events
+        ALL = [
+          Events::Connection::Request,
+          Events::Consumer::ProcessBatch,
+          Events::Consumer::ProcessMessage,
+          Events::ConsumerGroup::Heartbeat,
+          Events::ConsumerGroup::JoinGroup,
+          Events::ConsumerGroup::LeaveGroup,
+          Events::ConsumerGroup::SyncGroup,
+          Events::ProduceOperation::SendMessages,
+          Events::Producer::DeliverMessages
+        ].freeze
+
+        module_function
+
+        def all
+          self::ALL
+        end
+
+        def subscriptions
+          all.collect(&:subscriptions).collect(&:to_a).flatten
+        end
+
+        def subscribe!
+          all.each(&:subscribe!)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module Connection
+          # Defines instrumentation for request.connection.kafka event
+          module Request
+            include Kafka::Event
+
+            EVENT_NAME = 'request.connection.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              span.resource = payload[:api]
+
+              span.set_tag(Ext::TAG_REQUEST_SIZE, payload[:request_size]) if payload.key?(:request_size)
+              span.set_tag(Ext::TAG_RESPONSE_SIZE, payload[:response_size]) if payload.key?(:response_size)
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_CONNECTION_REQUEST
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+require 'ddtrace/contrib/kafka/consumer_event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module Consumer
+          # Defines instrumentation for process_batch.consumer.kafka event
+          module ProcessBatch
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+
+            EVENT_NAME = 'process_batch.consumer.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              span.resource = payload[:topic]
+
+              span.set_tag(Ext::TAG_TOPIC, payload[:topic]) if payload.key?(:topic)
+              span.set_tag(Ext::TAG_MESSAGE_COUNT, payload[:message_count]) if payload.key?(:message_count)
+              span.set_tag(Ext::TAG_PARTITION, payload[:partition]) if payload.key?(:partition)
+              if payload.key?(:highwater_mark_offset)
+                span.set_tag(Ext::TAG_HIGHWATER_MARK_OFFSET, payload[:highwater_mark_offset])
+              end
+              span.set_tag(Ext::TAG_OFFSET_LAG, payload[:offset_lag]) if payload.key?(:offset_lag)
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_PROCESS_BATCH
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/kafka/ext'
+require 'ddtrace/contrib/kafka/event'
+require 'ddtrace/contrib/kafka/consumer_event'
+
+module Datadog
+  module Contrib
+    module Kafka
+      module Events
+        module Consumer
+          # Defines instrumentation for process_message.consumer.kafka event
+          module ProcessMessage
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+
+            EVENT_NAME = 'process_message.consumer.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              span.resource = payload[:topic]
+
+              span.set_tag(Ext::TAG_TOPIC, payload[:topic]) if payload.key?(:topic)
+              span.set_tag(Ext::TAG_MESSAGE_KEY, payload[:key]) if payload.key?(:key)
+              span.set_tag(Ext::TAG_PARTITION, payload[:partition]) if payload.key?(:partition)
+              span.set_tag(Ext::TAG_OFFSET, payload[:offset]) if payload.key?(:offset)
+              span.set_tag(Ext::TAG_OFFSET_LAG, payload[:offset_lag]) if payload.key?(:offset_lag)
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_PROCESS_MESSAGE
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+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 heartbeat.consumer.kafka event
+          module Heartbeat
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+            extend Kafka::ConsumerGroupEvent
+
+            EVENT_NAME = 'heartbeat.consumer.kafka'.freeze
+
+            def self.process(span, _event, _id, payload)
+              super
+
+              if payload.key?(:topic_partitions)
+                payload[:topic_partitions].each do |topic, partitions|
+                  span.set_tag("#{Ext::TAG_TOPIC_PARTITIONS}.#{topic}", partitions)
+                end
+              end
+            end
+
+            module_function
+
+            def span_name
+              Ext::SPAN_CONSUMER_HEARTBEAT
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/kafka/events/consumer_group/join_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 join_group.consumer.kafka event
+          module JoinGroup
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+            extend Kafka::ConsumerGroupEvent
+
+            EVENT_NAME = 'join_group.consumer.kafka'.freeze
+
+            module_function
+
+            def span_name
+              Ext::SPAN_CONSUMER_JOIN_GROUP
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/kafka/events/consumer_group/leave_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 leave_group.consumer.kafka event
+          module LeaveGroup
+            include Kafka::Event
+            extend Kafka::ConsumerEvent
+            extend Kafka::ConsumerGroupEvent
+
+            EVENT_NAME = 'leave_group.consumer.kafka'.freeze
+
+            module_function
+
+            def span_name
+              Ext::SPAN_CONSUMER_LEAVE_GROUP
+            end
+          end
+        end
+      end
+    end
+  end
+end

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,38 @@
+module Datadog
+  module Contrib
+    module Kafka
+      # Kafka integration constants
+      module Ext
+        APP = 'kafka'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_KAFKA_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = '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