ls-trace 0.1.1

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

@@ -0,0 +1,23 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/sequel/ext'
+
+module Datadog
+  module Contrib
+    module Sequel
+      module Configuration
+        # Custom settings for the Sequel 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
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sequel/database.rb

@@ -0,0 +1,61 @@
+require 'ddtrace/ext/sql'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/sequel/ext'
+require 'ddtrace/contrib/sequel/utils'
+
+module Datadog
+  module Contrib
+    module Sequel
+      # Adds instrumentation to Sequel::Database
+      module Database
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for instrumenting Sequel::Database
+        module InstanceMethods
+          def run(sql, options = ::Sequel::OPTS)
+            opts = parse_opts(sql, options)
+
+            response = nil
+
+            datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
+              span.service = datadog_pin.service
+              span.resource = opts[:query]
+              span.span_type = Datadog::Ext::SQL::TYPE
+              Utils.set_analytics_sample_rate(span)
+              span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              response = super(sql, options)
+            end
+            response
+          end
+
+          def datadog_pin
+            @pin ||= Datadog::Pin.new(
+              Datadog.configuration[:sequel][:service_name] || adapter_name,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::DB,
+              tracer: Datadog.configuration[:sequel][:tracer] || Datadog.tracer
+            )
+          end
+
+          private
+
+          def adapter_name
+            Utils.adapter_name(self)
+          end
+
+          def parse_opts(sql, opts)
+            db_opts = if ::Sequel::VERSION < '3.41.0' && self.class.to_s !~ /Dataset$/
+                        @opts
+                      elsif instance_variable_defined?(:@pool) && @pool
+                        @pool.db.opts
+                      end
+            Utils.parse_opts(sql, opts, db_opts)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sequel/dataset.rb

@@ -0,0 +1,62 @@
+require 'ddtrace/ext/sql'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/sequel/ext'
+require 'ddtrace/contrib/sequel/utils'
+
+module Datadog
+  module Contrib
+    module Sequel
+      # Adds instrumentation to Sequel::Dataset
+      module Dataset
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Instance methods for instrumenting Sequel::Dataset
+        module InstanceMethods
+          def execute(sql, options = ::Sequel::OPTS, &block)
+            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
+          end
+
+          def execute_ddl(sql, options = ::Sequel::OPTS, &block)
+            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
+          end
+
+          def execute_dui(sql, options = ::Sequel::OPTS, &block)
+            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
+          end
+
+          def execute_insert(sql, options = ::Sequel::OPTS, &block)
+            trace_execute(proc { super(sql, options, &block) }, sql, options, &block)
+          end
+
+          def datadog_pin
+            Datadog::Pin.get_from(db)
+          end
+
+          private
+
+          def trace_execute(super_method, sql, options, &block)
+            opts = Utils.parse_opts(sql, options, db.opts)
+            response = nil
+
+            datadog_pin.tracer.trace(Ext::SPAN_QUERY) do |span|
+              span.service = datadog_pin.service
+              span.resource = opts[:query]
+              span.span_type = Datadog::Ext::SQL::TYPE
+              Utils.set_analytics_sample_rate(span)
+              span.set_tag(Ext::TAG_DB_VENDOR, adapter_name)
+              response = super_method.call(sql, options, &block)
+            end
+            response
+          end
+
+          def adapter_name
+            Utils.adapter_name(db)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Datadog
+  module Contrib
+    module Sequel
+      # Sequel integration constants
+      module Ext
+        APP = 'sequel'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SEQUEL_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SEQUEL_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'sequel'.freeze
+        SPAN_QUERY = 'sequel.query'.freeze
+        TAG_DB_VENDOR = 'sequel.db.vendor'.freeze
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,39 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/sequel/database'
+require 'ddtrace/contrib/sequel/dataset'
+
+module Datadog
+  module Contrib
+    module Sequel
+      # Patcher enables patching of 'sequel' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:sequel)
+        end
+
+        def patch
+          do_once(:sequel) do
+            begin
+              patch_sequel_database
+              patch_sequel_dataset
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Sequel integration: #{e}")
+            end
+          end
+        end
+
+        def patch_sequel_database
+          ::Sequel::Database.send(:include, Database)
+        end
+
+        def patch_sequel_dataset
+          ::Sequel::Dataset.send(:include, Dataset)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/sequel/utils.rb

@@ -0,0 +1,46 @@
+module Datadog
+  module Contrib
+    module Sequel
+      # General purpose functions for Sequel
+      module Utils
+        class << self
+          def adapter_name(database)
+            Datadog::Utils::Database.normalize_vendor(database.adapter_scheme.to_s)
+          end
+
+          def parse_opts(sql, opts, db_opts)
+            if ::Sequel::VERSION >= '4.37.0' && !sql.is_a?(String)
+              # In 4.37.0, sql was converted to a prepared statement object
+              sql = sql.prepared_sql unless sql.is_a?(Symbol)
+            end
+
+            {
+              name: opts[:type],
+              query: sql,
+              database: db_opts[:database],
+              host: db_opts[:host]
+            }
+          end
+
+          def set_analytics_sample_rate(span)
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:sequel]
+          end
+
+          def analytics_enabled?
+            Contrib::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/shoryuken/configuration/settings.rb

@@ -0,0 +1,24 @@
+require 'ddtrace/contrib/configuration/settings'
+
+module Datadog
+  module Contrib
+    module Shoryuken
+      module Configuration
+        # Default settings for the Shoryuken 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/shoryuken/ext.rb

@@ -0,0 +1,18 @@
+module Datadog
+  module Contrib
+    module Shoryuken
+      # Shoryuken integration constants
+      module Ext
+        APP = 'shoryuken'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_SHORYUKEN_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_SHORYUKEN_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'shoryuken'.freeze
+        SPAN_JOB = 'shoryuken.job'.freeze
+        TAG_JOB_ID = 'shoryuken.id'.freeze
+        TAG_JOB_QUEUE = 'shoryuken.queue'.freeze
+        TAG_JOB_ATTRIBUTES = 'shoryuken.attributes'.freeze
+        TAG_JOB_BODY = 'shoryuken.body'.freeze
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/shoryuken/tracer'
+
+module Datadog
+  module Contrib
+    module Shoryuken
+      # Patcher enables patching of 'shoryuken' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:shoryuken)
+        end
+
+        def patch
+          do_once(:shoryuken) do
+            begin
+              ::Shoryuken.server_middleware do |chain|
+                chain.add Shoryuken::Tracer
+              end
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Shoryuken integration: #{e}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/shoryuken/tracer.rb

@@ -0,0 +1,45 @@
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module Shoryuken
+      # Tracer is a Shoryuken server-side middleware which traces executed jobs
+      class Tracer
+        def initialize(options = {})
+          @tracer = options[:tracer] || configuration[:tracer]
+          @shoryuken_service = options[:service_name] || configuration[:service_name]
+        end
+
+        def call(worker_instance, queue, sqs_msg, body)
+          @tracer.trace(Ext::SPAN_JOB, service: @shoryuken_service, span_type: Datadog::Ext::AppTypes::WORKER) do |span|
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+            span.resource = resource(worker_instance, body)
+            span.set_tag(Ext::TAG_JOB_ID, sqs_msg.message_id)
+            span.set_tag(Ext::TAG_JOB_QUEUE, queue)
+            span.set_tag(Ext::TAG_JOB_ATTRIBUTES, sqs_msg.attributes) if sqs_msg.respond_to?(:attributes)
+            span.set_tag(Ext::TAG_JOB_BODY, body)
+
+            yield
+          end
+        end
+
+        private
+
+        def resource(worker_instance, body)
+          # If it's a Hash, try to get the job class from it.
+          # This is for ActiveJob compatibility.
+          job_class = body['job_class'] if body.is_a?(Hash)
+          # If nothing is available, use the worker class name.
+          job_class || worker_instance.class.name
+        end
+
+        def configuration
+          Datadog.configuration[:shoryuken]
+        end
+      end
+    end
+  end
+end