ddtrace 0.38.0

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

@@ -0,0 +1,107 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/sql'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/presto/ext'
+
+module Datadog
+  module Contrib
+    module Presto
+      # Instrumentation for Presto integration
+      module Instrumentation
+        # Instrumentation for Presto::Client::Client
+        module Client
+          def self.included(base)
+            base.send(:prepend, InstanceMethods)
+          end
+
+          # Instance methods for Presto::Client
+          module InstanceMethods
+            def run(query)
+              tracer.trace(Ext::SPAN_QUERY, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = query
+                  span.span_type = Datadog::Ext::SQL::TYPE
+                  span.set_tag(Ext::TAG_QUERY_ASYNC, false)
+                rescue StandardError => e
+                  Datadog.logger.debug("error preparing span for presto: #{e}")
+                end
+
+                super(query)
+              end
+            end
+
+            def query(query, &blk)
+              tracer.trace(Ext::SPAN_QUERY, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = query
+                  span.span_type = Datadog::Ext::SQL::TYPE
+                  span.set_tag(Ext::TAG_QUERY_ASYNC, !blk.nil?)
+                rescue StandardError => e
+                  Datadog.logger.debug("error preparing span for presto: #{e}")
+                end
+
+                super(query, &blk)
+              end
+            end
+
+            def kill(query_id)
+              tracer.trace(Ext::SPAN_KILL, span_options) do |span|
+                begin
+                  decorate!(span)
+                  span.resource = Ext::SPAN_KILL
+                  span.span_type = Datadog::Ext::AppTypes::DB
+                  # ^ not an SQL type span, since there's no SQL query
+                  span.set_tag(Ext::TAG_QUERY_ID, query_id)
+                rescue StandardError => e
+                  Datadog.logger.debug("error preparing span for presto: #{e}")
+                end
+
+                super(query_id)
+              end
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration[:presto]
+            end
+
+            def span_options
+              {
+                service: datadog_configuration[:service_name],
+                app: Ext::APP,
+                app_type: Datadog::Ext::AppTypes::DB
+              }
+            end
+
+            def tracer
+              datadog_configuration.tracer
+            end
+
+            def decorate!(span)
+              set_nilable_tag!(span, :server, Datadog::Ext::NET::TARGET_HOST)
+              set_nilable_tag!(span, :user, Ext::TAG_USER_NAME)
+              set_nilable_tag!(span, :schema, Ext::TAG_SCHEMA_NAME)
+              set_nilable_tag!(span, :catalog, Ext::TAG_CATALOG_NAME)
+              set_nilable_tag!(span, :time_zone, Ext::TAG_TIME_ZONE)
+              set_nilable_tag!(span, :language, Ext::TAG_LANGUAGE)
+              set_nilable_tag!(span, :http_proxy, Ext::TAG_PROXY)
+              set_nilable_tag!(span, :model_version, Ext::TAG_MODEL_VERSION)
+
+              # Set analytics sample rate
+              if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+              end
+            end
+
+            def set_nilable_tag!(span, key, tag_name)
+              @options[key].tap { |val| span.set_tag(tag_name, val) if val }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/presto/configuration/settings'
+require 'ddtrace/contrib/presto/patcher'
+
+module Datadog
+  module Contrib
+    module Presto
+      # Description of Presto integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.5.14')
+
+        register_as :presto
+
+        def self.version
+          Gem.loaded_specs['presto-client'] && Gem.loaded_specs['presto-client'].version
+        end
+
+        def self.loaded?
+          !defined?(::Presto::Client::Client).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/presto/patcher.rb

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/presto/ext'
+require 'ddtrace/contrib/presto/instrumentation'
+
+module Datadog
+  module Contrib
+    module Presto
+      # Patcher enables patching of 'presto-client' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:presto)
+        end
+
+        def patch
+          do_once(:presto) do
+            begin
+              ::Presto::Client::Client.send(:include, Instrumentation::Client)
+            rescue StandardError => e
+              Datadog.logger.error("Unable to apply Presto integration: #{e}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/racecar/ext'
+
+module Datadog
+  module Contrib
+    module Racecar
+      module Configuration
+        # Custom settings for the Racecar integration
+        class Settings < Contrib::Configuration::Settings
+          option :analytics_enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.lazy
+          end
+
+          option :analytics_sample_rate do |o|
+            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.lazy
+          end
+
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/active_support/notifications/event'
+require 'ddtrace/contrib/racecar/ext'
+
+module Datadog
+  module Contrib
+    module Racecar
+      # Defines basic behaviors for an ActiveRecord event.
+      module Event
+        def self.included(base)
+          base.send(:include, ActiveSupport::Notifications::Event)
+          base.send(:extend, ClassMethods)
+        end
+
+        # Class methods for Racecar events.
+        # Note, they share the same process method and before_trace method.
+        module ClassMethods
+          def subscription(*args)
+            super.tap do |subscription|
+              subscription.before_trace { ensure_clean_context! }
+            end
+          end
+
+          def span_options
+            { service: configuration[:service_name] }
+          end
+
+          def tracer
+            -> { configuration[:tracer] }
+          end
+
+          def configuration
+            Datadog.configuration[:racecar]
+          end
+
+          def process(span, event, _id, payload)
+            span.service = configuration[:service_name]
+            span.resource = payload[:consumer_class]
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+
+            # Measure service stats
+            Contrib::Analytics.set_measured(span)
+
+            span.set_tag(Ext::TAG_TOPIC, payload[:topic])
+            span.set_tag(Ext::TAG_CONSUMER, payload[:consumer_class])
+            span.set_tag(Ext::TAG_PARTITION, payload[:partition])
+            span.set_tag(Ext::TAG_OFFSET, payload[:offset]) if payload.key?(:offset)
+            span.set_tag(Ext::TAG_FIRST_OFFSET, payload[:first_offset]) if payload.key?(:first_offset)
+            span.set_tag(Ext::TAG_MESSAGE_COUNT, payload[:message_count]) if payload.key?(:message_count)
+            span.set_error(payload[:exception_object]) if payload[:exception_object]
+          end
+
+          private
+
+          # Context objects are thread-bound.
+          # If Racecar re-uses threads, context from a previous trace
+          # could leak into the new trace. This "cleans" current context,
+          # preventing such a leak.
+          def ensure_clean_context!
+            return unless configuration[:tracer].call_context.current_span
+            configuration[:tracer].provider.context = Context.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/racecar/events/batch'
+require 'ddtrace/contrib/racecar/events/message'
+
+module Datadog
+  module Contrib
+    module Racecar
+      # Defines collection of instrumented Racecar events
+      module Events
+        ALL = [
+          Events::Batch,
+          Events::Message
+        ].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/racecar/events/batch.rb

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/racecar/ext'
+require 'ddtrace/contrib/racecar/event'
+
+module Datadog
+  module Contrib
+    module Racecar
+      module Events
+        # Defines instrumentation for process_batch.racecar event
+        module Batch
+          include Racecar::Event
+
+          EVENT_NAME = 'process_batch.racecar'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_BATCH
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/racecar/events/message.rb

@@ -0,0 +1,27 @@
+require 'ddtrace/contrib/racecar/ext'
+require 'ddtrace/contrib/racecar/event'
+
+module Datadog
+  module Contrib
+    module Racecar
+      module Events
+        # Defines instrumentation for process_message.racecar event
+        module Message
+          include Racecar::Event
+
+          EVENT_NAME = 'process_message.racecar'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_MESSAGE
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Datadog
+  module Contrib
+    module Racecar
+      # Racecar integration constants
+      module Ext
+        APP = 'racecar'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'racecar'.freeze
+        SPAN_BATCH = 'racecar.batch'.freeze
+        SPAN_MESSAGE = 'racecar.message'.freeze
+        TAG_CONSUMER = 'kafka.consumer'.freeze
+        TAG_FIRST_OFFSET = 'kafka.first_offset'.freeze
+        TAG_MESSAGE_COUNT = 'kafka.message_count'.freeze
+        TAG_OFFSET = 'kafka.offset'.freeze
+        TAG_PARTITION = 'kafka.partition'.freeze
+        TAG_TOPIC = 'kafka.topic'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/racecar/configuration/settings'
+require 'ddtrace/contrib/racecar/patcher'
+
+module Datadog
+  module Contrib
+    module Racecar
+      # Description of Racecar integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('0.3.5')
+
+        register_as :racecar, auto_patch: false
+
+        def self.version
+          Gem.loaded_specs['racecar'] && Gem.loaded_specs['racecar'].version
+        end
+
+        def self.loaded?
+          !defined?(::Racecar).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/racecar/patcher.rb

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