ls-trace 0.1.1

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

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/mysql2/ext'
+
+module Datadog
+  module Contrib
+    module Mysql2
+      module Configuration
+        # Custom settings for the Mysql2 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/mysql2/ext.rb

@@ -0,0 +1,15 @@
+module Datadog
+  module Contrib
+    module Mysql2
+      # 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
+        SERVICE_NAME = 'mysql2'.freeze
+        SPAN_QUERY = 'mysql2.query'.freeze
+        TAG_DB_NAME = 'mysql2.db.name'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/sql'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/mysql2/ext'
+
+module Datadog
+  module Contrib
+    module Mysql2
+      # Mysql2::Client patch module
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Mysql2::Client patch instance methods
+        module InstanceMethods
+          def query(sql, options = {})
+            datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
+              span.resource = sql
+              span.service = datadog_pin.service
+              span.span_type = Datadog::Ext::SQL::TYPE
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+              span.set_tag(Ext::TAG_DB_NAME, query_options[:database])
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, query_options[:host])
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, query_options[:port])
+              super(sql, options)
+            end
+          end
+
+          def datadog_pin
+            @datadog_pin ||= Datadog::Pin.new(
+              Datadog.configuration[:mysql2][:service_name],
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::DB,
+              tracer: Datadog.configuration[:mysql2][:tracer]
+            )
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:mysql2]
+          end
+
+          def analytics_enabled?
+            datadog_configuration[:analytics_enabled]
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/mysql2/configuration/settings'
+require 'ddtrace/contrib/mysql2/patcher'
+
+module Datadog
+  module Contrib
+    module Mysql2
+      # Description of Mysql2 integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :mysql2
+
+        def self.version
+          Gem.loaded_specs['mysql2'] && Gem.loaded_specs['mysql2'].version
+        end
+
+        def self.present?
+          super && defined?(::Mysql2)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/mysql2/instrumentation'
+
+module Datadog
+  module Contrib
+    module Mysql2
+      # Patcher enables patching of 'mysql2' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:mysql2)
+        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
+        end
+
+        def patch_mysql2_client
+          ::Mysql2::Client.send(:include, Instrumentation)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/patchable.rb

@@ -0,0 +1,42 @@
+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)
+      end
+
+      # Class methods for integrations
+      module ClassMethods
+        def version
+          nil
+        end
+
+        def present?
+          !version.nil?
+        end
+
+        def compatible?
+          Gem::Version.new(RUBY_VERSION) >= Gem::Version.new(VERSION::MINIMUM_RUBY_VERSION) && present?
+        end
+      end
+
+      # Instance methods for integrations
+      module InstanceMethods
+        def patcher
+          nil
+        end
+
+        def patch
+          if !self.class.compatible? || patcher.nil?
+            Datadog::Tracer.log.warn("Unable to patch #{self.class.name}")
+            return
+          end
+
+          patcher.patch
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/patcher.rb

@@ -0,0 +1,28 @@
+require 'ddtrace/patcher'
+
+module Datadog
+  module Contrib
+    # Common behavior for patcher modules
+    module Patcher
+      def self.included(base)
+        base.send(:include, Datadog::Patcher)
+        base.send(:extend, InstanceMethods)
+        base.send(:include, InstanceMethods)
+      end
+
+      # Class methods for patchers
+      module ClassMethods
+        def patch
+          raise NotImplementedError, '#patch not implemented for Patcher!'
+        end
+      end
+
+      # Instance methods for patchers
+      module InstanceMethods
+        def patch
+          raise NotImplementedError, '#patch not implemented for Patcher!'
+        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,67 @@
+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
+            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