ls-trace 0.1.1

data/lib/ddtrace/contrib/redis/tags.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/redis/ext'
+
+module Datadog
+  module Contrib
+    module Redis
+      # Tags handles generic common tags assignment.
+      module Tags
+        class << self
+          def set_common_tags(client, span)
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            span.set_tag Datadog::Ext::NET::TARGET_HOST, client.host
+            span.set_tag Datadog::Ext::NET::TARGET_PORT, client.port
+            span.set_tag Ext::TAG_DB, client.db
+            span.set_tag Ext::TAG_RAW_COMMAND, span.resource
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:redis]
+          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/registerable.rb

@@ -0,0 +1,33 @@
+require 'ddtrace/contrib/registry'
+
+module Datadog
+  module Contrib
+    # Defines registerable behavior for integrations
+    module Registerable
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+        base.send(:include, InstanceMethods)
+      end
+
+      # Class methods for registerable behavior
+      module ClassMethods
+        def register_as(name, options = {})
+          registry = options.fetch(:registry, Datadog.registry)
+          auto_patch = options.fetch(:auto_patch, false)
+
+          registry.add(name, new(name, options), auto_patch)
+        end
+      end
+
+      # Instance methods for registerable behavior
+      module InstanceMethods
+        attr_reader \
+          :name
+
+        def initialize(name, options = {})
+          @name = name
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/registry.rb

@@ -0,0 +1,42 @@
+module Datadog
+  module Contrib
+    # Registry is a collection of integrations.
+    class Registry
+      include Enumerable
+
+      Entry = Struct.new(:name, :klass, :auto_patch)
+
+      def initialize
+        @data = {}
+        @mutex = Mutex.new
+      end
+
+      def add(name, klass, auto_patch = false)
+        @mutex.synchronize do
+          @data[name] = Entry.new(name, klass, auto_patch).freeze
+        end
+      end
+
+      def each
+        @mutex.synchronize do
+          @data.each { |_, entry| yield(entry) }
+        end
+      end
+
+      def [](name)
+        @mutex.synchronize do
+          entry = @data[name]
+          entry.klass if entry
+        end
+      end
+
+      def to_h
+        @mutex.synchronize do
+          @data.each_with_object({}) do |(_, entry), hash|
+            hash[entry.name] = entry.auto_patch
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/resque/ext'
+
+module Datadog
+  module Contrib
+    module Resque
+      module Configuration
+        # Custom settings for the Resque 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
+          option :workers, default: []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module Resque
+      # Resque integration constants
+      module Ext
+        APP = 'resque'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_RESQUE_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RESQUE_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'resque'.freeze
+        SPAN_JOB = 'resque.job'.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/resque/configuration/settings'
+require 'ddtrace/contrib/resque/patcher'
+
+module Datadog
+  module Contrib
+    module Resque
+      # Description of Resque integration
+      class Integration
+        include Contrib::Integration
+
+        register_as :resque, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['resque'] && Gem.loaded_specs['resque'].version
+        end
+
+        def self.present?
+          super && defined?(::Resque)
+        end
+
+        def default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+
+        class << self
+          # Globally-acccesible reference for pre-forking optimization
+          attr_accessor :sync_writer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/sidekiq/ext'
+
+module Datadog
+  module Contrib
+    module Resque
+      # Patcher enables patching of 'resque' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:resque)
+        end
+
+        def patch
+          do_once(:resque) do
+            begin
+              require_relative 'resque_job'
+              get_option(:workers).each { |worker| worker.extend(ResqueJob) }
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply Resque integration: #{e}")
+            end
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:resque].get_option(option)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/resque/resque_job.rb

@@ -0,0 +1,76 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/sync_writer'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/sidekiq/ext'
+require 'resque'
+
+module Datadog
+  module Contrib
+    module Resque
+      # Uses Resque job hooks to create traces
+      module ResqueJob
+        def around_perform(*_)
+          return yield unless datadog_configuration && tracer
+
+          tracer.trace(Ext::SPAN_JOB, span_options) do |span|
+            span.resource = name
+            span.span_type = Datadog::Ext::AppTypes::WORKER
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, datadog_configuration[:analytics_sample_rate])
+            end
+            yield
+          end
+        end
+
+        def after_perform_shutdown_tracer(*_)
+          shutdown_tracer_when_forked!
+        end
+
+        def on_failure_shutdown_tracer(*_)
+          shutdown_tracer_when_forked!
+        end
+
+        def shutdown_tracer_when_forked!
+          tracer.shutdown! if forked?
+        end
+
+        private
+
+        def forked?
+          pin = Datadog::Pin.get_from(::Resque)
+          return false unless pin
+          pin.config[:forked] == true
+        end
+
+        def span_options
+          { service: datadog_configuration[:service_name] }
+        end
+
+        def tracer
+          datadog_configuration.tracer
+        end
+
+        def datadog_configuration
+          Datadog.configuration[:resque]
+        end
+      end
+    end
+  end
+end
+
+Resque.after_fork do
+  configuration = Datadog.configuration[:resque]
+  next if configuration.nil?
+
+  # Add a pin, marking the job as forked.
+  # Used to trigger shutdown in forks for performance reasons.
+  Datadog::Pin.new(
+    configuration[:service_name],
+    config: { forked: true }
+  ).onto(::Resque)
+
+  # Clean the state so no CoW happens
+  next if configuration[:tracer].nil?
+  configuration[:tracer].provider.context = nil
+end

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

@@ -0,0 +1,26 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/rest_client/ext'
+
+module Datadog
+  module Contrib
+    module RestClient
+      module Configuration
+        # Custom settings for the RestClient 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 :distributed_tracing, default: true
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module RestClient
+      # RestClient integration constants
+      module Ext
+        APP = 'rest_client'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_REST_CLIENT_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_REST_CLIENT_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'rest_client'.freeze
+        SPAN_REQUEST = 'rest_client.request'.freeze
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,25 @@
+module Datadog
+  module Contrib
+    module RestClient
+      # Patcher enables patching of 'rest_client' module.
+      module Patcher
+        include Contrib::Patcher
+
+        module_function
+
+        def patched?
+          done?(:rest_client)
+        end
+
+        def patch
+          do_once(:rest_client) do
+            require 'ddtrace/ext/app_types'
+            require 'ddtrace/contrib/rest_client/request_patch'
+
+            ::RestClient::Request.send(:include, RequestPatch)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/rest_client/request_patch.rb

@@ -0,0 +1,89 @@
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/propagation/http_propagator'
+require 'ddtrace/contrib/rest_client/ext'
+
+module Datadog
+  module Contrib
+    module RestClient
+      # RestClient RequestPatch
+      module RequestPatch
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          def execute(&block)
+            uri = URI.parse(url)
+
+            return super(&block) unless datadog_configuration[:tracer].enabled
+
+            datadog_trace_request(uri) do |span|
+              if datadog_configuration[:distributed_tracing]
+                Datadog::HTTPPropagator.inject!(span.context, processed_headers)
+              end
+
+              super(&block)
+            end
+          end
+
+          def datadog_tag_request(uri, span)
+            span.resource = method.to_s.upcase
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            span.set_tag(Datadog::Ext::HTTP::URL, uri.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, method.to_s.upcase)
+            span.set_tag(Datadog::Ext::NET::TARGET_HOST, uri.host)
+            span.set_tag(Datadog::Ext::NET::TARGET_PORT, uri.port)
+          end
+
+          def datadog_trace_request(uri)
+            span = datadog_configuration[:tracer].trace(Ext::SPAN_REQUEST,
+                                                        service: datadog_configuration[:service_name],
+                                                        span_type: Datadog::Ext::HTTP::TYPE_OUTBOUND)
+
+            datadog_tag_request(uri, span)
+
+            yield(span).tap do |response|
+              # Verify return value is a response
+              # If so, add additional tags.
+              if response.is_a?(::RestClient::Response)
+                span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
+              end
+            end
+          rescue ::RestClient::ExceptionWithResponse => e
+            span.set_error(e) if Datadog::Ext::HTTP::ERROR_RANGE.cover?(e.http_code)
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, e.http_code)
+
+            raise e
+            # rubocop:disable Lint/RescueException
+          rescue Exception => e
+            # rubocop:enable Lint/RescueException
+            span.set_error(e)
+
+            raise e
+          ensure
+            span.finish
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:rest_client]
+          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