ls-trace 0.1.2 → 0.2.0

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module Que
+      # Tracer is a Que's server-side middleware which traces executed jobs
+      class Tracer
+        def call(job)
+          trace_options = {
+            service:   configuration[:service_name],
+            span_type: Datadog::Ext::AppTypes::WORKER
+          }
+
+          tracer.trace(Ext::SPAN_JOB, trace_options) do |request_span|
+            request_span.resource = job.class.name.to_s
+            request_span.set_tag(Ext::TAG_JOB_QUEUE, job.que_attrs[:queue])
+            request_span.set_tag(Ext::TAG_JOB_ID, job.que_attrs[:id])
+            request_span.set_tag(Ext::TAG_JOB_PRIORITY, job.que_attrs[:priority])
+            request_span.set_tag(Ext::TAG_JOB_ERROR_COUNT, job.que_attrs[:error_count])
+            request_span.set_tag(Ext::TAG_JOB_RUN_AT, job.que_attrs[:run_at])
+            request_span.set_tag(Ext::TAG_JOB_EXPIRED_AT, job.que_attrs[:expired_at])
+            request_span.set_tag(Ext::TAG_JOB_FINISHED_AT, job.que_attrs[:finished_at])
+            request_span.set_tag(Ext::TAG_JOB_ARGS, job.que_attrs[:args]) if configuration[:tag_args]
+            request_span.set_tag(Ext::TAG_JOB_DATA, job.que_attrs[:data]) if configuration[:tag_data]
+
+            set_sample_rate(request_span)
+            Contrib::Analytics.set_measured(request_span)
+
+            yield
+          end
+        end
+
+        private
+
+        def set_sample_rate(request_span)
+          if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+            Contrib::Analytics.set_sample_rate(
+              request_span,
+              configuration[:analytics_sample_rate]
+            )
+          end
+        end
+
+        def tracer
+          configuration[:tracer]
+        end
+
+        def configuration
+          Datadog.configuration[Datadog::Contrib::Que::Ext::APP.to_sym]
+        end
+      end
+    end
+  end
+end

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

@@ -7,13 +7,18 @@ module Datadog
       module Configuration
         # Custom settings for the Racecar integration
         class Settings < Contrib::Configuration::Settings
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, false) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], false) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -41,6 +41,10 @@ module Datadog
             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])

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

@@ -1,5 +1,6 @@
 require 'ddtrace/contrib/racecar/events/batch'
 require 'ddtrace/contrib/racecar/events/message'
+require 'ddtrace/contrib/racecar/events/consume'
 
 module Datadog
   module Contrib
@@ -7,6 +8,7 @@ module Datadog
       # Defines collection of instrumented Racecar events
       module Events
         ALL = [
+          Events::Consume,
           Events::Batch,
           Events::Message
         ].freeze

data/lib/ddtrace/contrib/racecar/events/consume.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 main_loop.racecar event
+        module Consume
+          include Racecar::Event
+
+          EVENT_NAME = 'main_loop.racecar'.freeze
+
+          module_function
+
+          def event_name
+            self::EVENT_NAME
+          end
+
+          def span_name
+            Ext::SPAN_CONSUME
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,9 +4,13 @@ module Datadog
       # 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
+        ENV_ENABLED = 'DD_TRACE_RACECAR_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RACECAR_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RACECAR_ANALYTICS_SAMPLE_RATE'.freeze
         SERVICE_NAME = 'racecar'.freeze
+        SPAN_CONSUME = 'racecar.consume'.freeze
         SPAN_BATCH = 'racecar.batch'.freeze
         SPAN_MESSAGE = 'racecar.message'.freeze
         TAG_CONSUMER = 'kafka.consumer'.freeze

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

@@ -9,18 +9,21 @@ module Datadog
       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.present?
-          super && defined?(::Racecar)
+        def self.loaded?
+          !defined?(::Racecar).nil? \
+            && !defined?(::ActiveSupport::Notifications).nil?
         end
 
         def self.compatible?
-          super && defined?(::ActiveSupport::Notifications)
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

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

@@ -12,19 +12,13 @@ module Datadog
 
         module_function
 
-        def patched?
-          done?(:racecar)
+        def target_version
+          Integration.version
         end
 
         def patch
-          do_once(:racecar) do
-            begin
-              # Subscribe to Racecar events
-              Events.subscribe!
-            rescue StandardError => e
-              Datadog::Tracer.log.error("Unable to apply Racecar integration: #{e}")
-            end
-          end
+          # Subscribe to Racecar events
+          Events.subscribe!
         end
       end
     end

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

@@ -14,13 +14,18 @@ module Datadog
             ]
           }.freeze
 
+          option :enabled do |o|
+            o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+            o.lazy
+          end
+
           option :analytics_enabled do |o|
-            o.default { env_to_bool(Ext::ENV_ANALYTICS_ENABLED, nil) }
+            o.default { env_to_bool([Ext::ENV_ANALYTICS_ENABLED, Ext::ENV_ANALYTICS_ENABLED_OLD], nil) }
             o.lazy
           end
 
           option :analytics_sample_rate do |o|
-            o.default { env_to_float(Ext::ENV_ANALYTICS_SAMPLE_RATE, 1.0) }
+            o.default { env_to_float([Ext::ENV_ANALYTICS_SAMPLE_RATE, Ext::ENV_ANALYTICS_SAMPLE_RATE_OLD], 1.0) }
             o.lazy
           end
 

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

@@ -4,8 +4,11 @@ module Datadog
       # Rack integration constants
       module Ext
         APP = 'rack'.freeze
-        ENV_ANALYTICS_ENABLED = 'DD_RACK_ANALYTICS_ENABLED'.freeze
-        ENV_ANALYTICS_SAMPLE_RATE = 'DD_RACK_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ENABLED = 'DD_TRACE_RACK_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_TRACE_RACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_ENABLED_OLD = 'DD_RACK_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_RACK_ANALYTICS_SAMPLE_RATE'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE_OLD = 'DD_RACK_ANALYTICS_SAMPLE_RATE'.freeze
         RACK_ENV_REQUEST_SPAN = 'datadog.rack_request_span'.freeze
         SERVICE_NAME = 'rack'.freeze
         SPAN_HTTP_SERVER_QUEUE = 'http_server.queue'.freeze

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

@@ -9,14 +9,20 @@ module Datadog
       class Integration
         include Contrib::Integration
 
+        MINIMUM_VERSION = Gem::Version.new('1.1.0')
+
         register_as :rack, auto_patch: false
 
         def self.version
           Gem.loaded_specs['rack'] && Gem.loaded_specs['rack'].version
         end
 
-        def self.present?
-          super && defined?(::Rack)
+        def self.loaded?
+          !defined?(::Rack).nil?
+        end
+
+        def self.compatible?
+          super && version >= MINIMUM_VERSION
         end
 
         def default_configuration

data/lib/ddtrace/contrib/rack/middlewares.rb

@@ -4,6 +4,8 @@ require 'ddtrace/propagation/http_propagator'
 require 'ddtrace/contrib/analytics'
 require 'ddtrace/contrib/rack/ext'
 require 'ddtrace/contrib/rack/request_queue'
+require 'ddtrace/environment'
+require 'date'
 
 module Datadog
   module Contrib
@@ -98,23 +100,26 @@ module Datadog
           request_span.set_error(e) unless request_span.nil?
           raise e
         ensure
-          # Rack is a really low level interface and it doesn't provide any
-          # advanced functionality like routers. Because of that, we assume that
-          # the underlying framework or application has more knowledge about
-          # the result for this request; `resource` and `tags` are expected to
-          # be set in another level but if they're missing, reasonable defaults
-          # are used.
-          set_request_tags!(request_span, env, status, headers, response, original_env)
-
-          # ensure the request_span is finished and the context reset;
-          # this assumes that the Rack middleware creates a root span
-          request_span.finish
+          if request_span
+            # Rack is a really low level interface and it doesn't provide any
+            # advanced functionality like routers. Because of that, we assume that
+            # the underlying framework or application has more knowledge about
+            # the result for this request; `resource` and `tags` are expected to
+            # be set in another level but if they're missing, reasonable defaults
+            # are used.
+            set_request_tags!(request_span, env, status, headers, response, original_env || env)
+
+            # ensure the request_span is finished and the context reset;
+            # this assumes that the Rack middleware creates a root span
+            request_span.finish
+          end
+
           frontend_span.finish unless frontend_span.nil?
 
           # TODO: Remove this once we change how context propagation works. This
           # ensures we clean thread-local variables on each HTTP request avoiding
           # memory leaks.
-          tracer.provider.context = Datadog::Context.new
+          tracer.provider.context = Datadog::Context.new if tracer
         end
 
         def resource_name_for(env, status)
@@ -126,6 +131,7 @@ module Datadog
         end
 
         # rubocop:disable Metrics/AbcSize
+        # rubocop:disable Metrics/MethodLength
         def set_request_tags!(request_span, env, status, headers, response, original_env)
           # http://www.rubydoc.info/github/rack/rack/file/SPEC
           # The source of truth in Rack is the PATH_INFO key that holds the
@@ -152,6 +158,9 @@ module Datadog
             Contrib::Analytics.set_sample_rate(request_span, configuration[:analytics_sample_rate])
           end
 
+          # Measure service stats
+          Contrib::Analytics.set_measured(request_span)
+
           if request_span.get_tag(Datadog::Ext::HTTP::METHOD).nil?
             request_span.set_tag(Datadog::Ext::HTTP::METHOD, env['REQUEST_METHOD'])
           end
@@ -218,7 +227,7 @@ module Datadog
                 if key == :datadog_rack_request_span \
                   && @datadog_span_warning \
                   && @datadog_deprecation_warnings
-                  Datadog::Tracer.log.warn(REQUEST_SPAN_DEPRECATION_WARNING)
+                  Datadog.logger.warn(REQUEST_SPAN_DEPRECATION_WARNING)
                   @datadog_span_warning = true
                 end
                 super
@@ -228,7 +237,7 @@ module Datadog
                 if key == :datadog_rack_request_span \
                   && @datadog_span_warning \
                   && @datadog_deprecation_warnings
-                  Datadog::Tracer.log.warn(REQUEST_SPAN_DEPRECATION_WARNING)
+                  Datadog.logger.warn(REQUEST_SPAN_DEPRECATION_WARNING)
                   @datadog_span_warning = true
                 end
                 super

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

@@ -2,36 +2,33 @@ module Datadog
   module Contrib
     module Rack
       # Provides instrumentation for `rack`
-      module Patcher
+      module MiddlewarePatcher
         include Contrib::Patcher
 
         module_function
 
-        def patched?
-          done?(:rack)
+        def target_version
+          Integration.version
         end
 
         def patch
           # Patch middleware
-          do_once(:rack) do
-            require_relative 'middlewares'
-          end
+          require_relative 'middlewares'
+        end
+      end
 
-          # Patch middleware names
-          if !done?(:rack_middleware_names) && get_option(:middleware_names)
-            if get_option(:application)
-              do_once(:rack_middleware_names) do
-                patch_middleware_names
-              end
-            else
-              Datadog::Tracer.log.warn(%(
-              Rack :middleware_names requires you to also pass :application.
-              Middleware names have NOT been patched; please provide :application.
-              e.g. use: :rack, middleware_names: true, application: my_rack_app).freeze)
-            end
-          end
-        rescue StandardError => e
-          Datadog::Tracer.log.error("Unable to apply Rack integration: #{e}")
+      # Provides instrumentation for Rack middleware names
+      module MiddlewareNamePatcher
+        include Contrib::Patcher
+
+        module_function
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          patch_middleware_names
         end
 
         def patch_middleware_names
@@ -41,7 +38,7 @@ module Datadog
           # context of middleware patching outside a Rails server process (eg. a
           # process that doesn't serve HTTP requests but has Rails environment
           # loaded such as a Resque master process)
-          Tracer.log.debug("Error patching middleware stack: #{e}")
+          Datadog.logger.debug("Error patching middleware stack: #{e}")
         end
 
         def retain_middleware_name(middleware)
@@ -67,6 +64,44 @@ module Datadog
           Datadog.configuration[:rack].get_option(option)
         end
       end
+
+      # Applies multiple patches
+      module Patcher
+        PATCHERS = [
+          MiddlewarePatcher,
+          MiddlewareNamePatcher
+        ].freeze
+
+        module_function
+
+        def patched?
+          PATCHERS.all?(&:patched?)
+        end
+
+        def target_version
+          Integration.version
+        end
+
+        def patch
+          MiddlewarePatcher.patch unless MiddlewarePatcher.patched?
+
+          # Patch middleware names
+          if !MiddlewareNamePatcher.patched? && get_option(:middleware_names)
+            if get_option(:application)
+              MiddlewareNamePatcher.patch
+            else
+              Datadog.logger.warn(%(
+              Rack :middleware_names requires you to also pass :application.
+              Middleware names have NOT been patched; please provide :application.
+              e.g. use: :rack, middleware_names: true, application: my_rack_app).freeze)
+            end
+          end
+        end
+
+        def get_option(option)
+          Datadog.configuration[:rack].get_option(option)
+        end
+      end
     end
   end
 end