ddtrace 1.1.0 → 1.9.0

data/lib/datadog/tracing/contrib/sinatra/tracer.rb

@@ -2,14 +2,13 @@
 
 require 'sinatra/base'
 
-require 'datadog/core/utils/only_once'
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/propagation/http'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/sinatra/env'
-require 'datadog/tracing/contrib/sinatra/ext'
-require 'datadog/tracing/contrib/sinatra/tracer_middleware'
+require_relative '../../../core/utils/only_once'
+require_relative '../../metadata/ext'
+require_relative '../../propagation/http'
+require_relative '../analytics'
+require_relative 'env'
+require_relative 'ext'
+require_relative 'tracer_middleware'
 
 module Datadog
   module Tracing
@@ -18,69 +17,12 @@ module Datadog
         # Datadog::Tracing::Contrib::Sinatra::Tracer is a Sinatra extension which traces
         # requests.
         module Tracer
-          def route(verb, action, *)
-            # Keep track of the route name when the app is instantiated for an
-            # incoming request.
-            condition do
-              # If the option to prepend script names is enabled, then
-              # prepend the script name from the request onto the action.
-              #
-              # DEV: env['sinatra.route'] already exists with very similar information,
-              # DEV: but doesn't account for our `resource_script_names` logic.
-              #
-              @datadog_route = if Datadog.configuration.tracing[:sinatra][:resource_script_names]
-                                 "#{request.script_name}#{action}"
-                               else
-                                 action
-                               end
-            end
-
-            super
-          end
-
           def self.registered(app)
             app.use TracerMiddleware, app_instance: app
-
-            app.after do
-              next unless Tracing.enabled?
-
-              span = Sinatra::Env.datadog_span(env, app)
-
-              # TODO: `route` should *only* be populated if @datadog_route is defined.
-              # TODO: If @datadog_route is not defined, then this Sinatra app is not responsible
-              # TODO: for handling this request.
-              # TODO:
-              # TODO: This change would be BREAKING for any Sinatra app (classic or modular),
-              # TODO: as it affects the `resource` value for requests not handled by the Sinatra app.
-              # TODO: Currently we use "#{method} #{path}" in such aces, but `path` is the raw,
-              # TODO: high-cardinality HTTP path, and can contain PII.
-              # TODO:
-              # TODO: The value we should use as the `resource` when the Sinatra app is not
-              # TODO: responsible for the request is a tricky subject.
-              # TODO: The best option is a value that clearly communicates that this app did not
-              # TODO: handle this request. It's important to keep in mind that an unhandled request
-              # TODO: by this Sinatra app might still be handled by another Rack middleware (which can
-              # TODO: be a Sinatra app itself) or it might just 404 if not handled at all.
-              # TODO:
-              # TODO: A possible value for `resource` could set a high level description, e.g.
-              # TODO: `request.request_method`, given we don't have the response object available yet.
-              route = if defined?(@datadog_route)
-                        @datadog_route
-                      else
-                        # Fallback in case no routes have matched
-                        request.path
-                      end
-
-              span.resource = "#{request.request_method} #{route}"
-              span.set_tag(Ext::TAG_ROUTE_PATH, route)
-            end
           end
 
           # Method overrides for Sinatra::Base
           module Base
-            MISSING_REQUEST_SPAN_ONLY_ONCE = Core::Utils::OnlyOnce.new
-            private_constant :MISSING_REQUEST_SPAN_ONLY_ONCE
-
             def render(engine, data, *)
               return super unless Tracing.enabled?
 
@@ -103,19 +45,21 @@ module Datadog
 
             # Invoked when a matching route is found.
             # This method yields directly to user code.
-            # rubocop:disable Metrics/MethodLength
             def route_eval
               configuration = Datadog.configuration.tracing[:sinatra]
               return super unless Tracing.enabled?
 
+              datadog_route = Sinatra::Env.route_path(env)
+
               Tracing.trace(
                 Ext::SPAN_ROUTE,
                 service: configuration[:service_name],
                 span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
-                resource: "#{request.request_method} #{@datadog_route}",
+                resource: "#{request.request_method} #{datadog_route}",
               ) do |span, trace|
                 span.set_tag(Ext::TAG_APP_NAME, settings.name || settings.superclass.name)
-                span.set_tag(Ext::TAG_ROUTE_PATH, @datadog_route)
+                span.set_tag(Ext::TAG_ROUTE_PATH, datadog_route)
+
                 if request.script_name && !request.script_name.empty?
                   span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
                 end
@@ -125,32 +69,15 @@ module Datadog
 
                 trace.resource = span.resource
 
-                sinatra_request_span =
-                  if self.class <= ::Sinatra::Application # Classic style (top-level) application
-                    Sinatra::Env.datadog_span(env, ::Sinatra::Application)
-                  else
-                    Sinatra::Env.datadog_span(env, self.class)
-                  end
-                if sinatra_request_span
-                  sinatra_request_span.resource = span.resource
-                else
-                  MISSING_REQUEST_SPAN_ONLY_ONCE.run do
-                    Datadog.logger.warn do
-                      'Sinatra integration is misconfigured, reported traces will be missing request metadata ' \
-                      'such as path and HTTP status code. ' \
-                      'Did you forget to add `register Datadog::Tracing::Contrib::Sinatra::Tracer` to your ' \
-                      '`Sinatra::Base` subclass? ' \
-                      'See <https://docs.datadoghq.com/tracing/setup_overview/setup/ruby/#sinatra> for more details.'
-                    end
-                  end
-                end
+                sinatra_request_span = Sinatra::Env.datadog_span(env)
+
+                sinatra_request_span.resource = span.resource
 
                 Contrib::Analytics.set_measured(span)
 
                 super
               end
             end
-            # rubocop:enable Metrics/MethodLength
           end
         end
       end

data/lib/datadog/tracing/contrib/sinatra/tracer_middleware.rb

@@ -1,12 +1,11 @@
 # typed: false
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/rack/ext'
-require 'datadog/tracing/contrib/sinatra/env'
-require 'datadog/tracing/contrib/sinatra/ext'
-require 'datadog/tracing/contrib/sinatra/headers'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../rack/ext'
+require_relative 'env'
+require_relative 'ext'
+require_relative 'headers'
 
 module Datadog
   module Tracing
@@ -26,10 +25,12 @@ module Datadog
           def call(env)
             # Set the trace context (e.g. distributed tracing)
             if configuration[:distributed_tracing] && Tracing.active_trace.nil?
-              original_trace = Propagation::HTTP.extract(env)
+              original_trace = Tracing::Propagation::HTTP.extract(env)
               Tracing.continue_trace!(original_trace)
             end
 
+            return @app.call(env) if Sinatra::Env.datadog_span(env)
+
             Tracing.trace(
               Ext::SPAN_REQUEST,
               service: configuration[:service_name],
@@ -40,7 +41,7 @@ module Datadog
                 # the nil signals that there's no good one yet and is also seen by profiler, when sampling the resource
                 span.resource = nil
 
-                Sinatra::Env.set_datadog_span(env, @app_instance, span)
+                Sinatra::Env.set_datadog_span(env, span)
 
                 response = @app.call(env)
               ensure
@@ -52,14 +53,18 @@ module Datadog
                 span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
 
                 request = ::Sinatra::Request.new(env)
+
                 span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, request.path)
                 span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request.request_method)
+
+                datadog_route = Sinatra::Env.route_path(env)
+
+                span.set_tag(Ext::TAG_ROUTE_PATH, datadog_route) if datadog_route
+
                 if request.script_name && !request.script_name.empty?
                   span.set_tag(Ext::TAG_SCRIPT_NAME, request.script_name)
                 end
 
-                span.set_tag(Ext::TAG_APP_NAME, @app_instance.settings.name)
-
                 # If this app handled the request, then Contrib::Sinatra::Tracer OR Contrib::Sinatra::Base set the
                 # resource; if no resource was set, let's use a fallback
                 span.resource = env['REQUEST_METHOD'] if span.resource.nil?
@@ -80,7 +85,10 @@ module Datadog
                   end
 
                   if (headers = response[1])
-                    Sinatra::Headers.response_header_tags(headers, configuration[:headers][:response]).each do |name, value|
+                    Sinatra::Headers.response_header_tags(
+                      headers,
+                      configuration[:headers][:response]
+                    ).each do |name, value|
                       span.set_tag(name, value) if span.get_tag(name).nil?
                     end
                   end
@@ -112,10 +120,6 @@ module Datadog
           def configuration
             Datadog.configuration.tracing[:sinatra]
           end
-
-          def header_to_rack_header(name)
-            "HTTP_#{name.to_s.upcase.gsub(/[-\s]/, '_')}"
-          end
         end
       end
     end

data/lib/datadog/tracing/contrib/sneakers/configuration/settings.rb

@@ -2,8 +2,8 @@
 
 # typed: false
 
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/contrib/configuration/settings'
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sneakers/integration.rb

@@ -2,10 +2,10 @@
 
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/sneakers/ext'
-require 'datadog/tracing/contrib/sneakers/configuration/settings'
-require 'datadog/tracing/contrib/sneakers/patcher'
+require_relative '../integration'
+require_relative 'ext'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sneakers/patcher.rb

@@ -2,8 +2,8 @@
 
 # typed: false
 
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/sneakers/tracer'
+require_relative '../patcher'
+require_relative 'tracer'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sneakers/tracer.rb

@@ -2,9 +2,8 @@
 
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
 
 module Datadog
   module Tracing
@@ -42,6 +41,8 @@ module Datadog
 
               request_span.set_tag(Ext::TAG_JOB_BODY, deserialized_msg) if configuration[:tag_body]
 
+              request_span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CONSUMER)
+
               @app.call(deserialized_msg, delivery_info, metadata, handler)
             end
           end

data/lib/datadog/tracing/contrib/status_code_matcher.rb

@@ -2,8 +2,8 @@
 
 require 'set'
 
-require 'datadog/core'
-require 'datadog/tracing/metadata/ext'
+require_relative '../../core'
+require_relative '../metadata/ext'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/stripe/configuration/settings.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Stripe
+        module Configuration
+          # Custom settings for the Stripe integration
+          # @public_api
+          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.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
+end

data/lib/datadog/tracing/contrib/stripe/ext.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Stripe
+        # Stripe integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_STRIPE_ENABLED'
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_STRIPE_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_STRIPE_ANALYTICS_SAMPLE_RATE'
+          SPAN_REQUEST = 'stripe.request'
+          SPAN_TYPE_REQUEST = 'custom'
+          TAG_COMPONENT = 'stripe'
+          TAG_OPERATION_REQUEST = 'request'
+          TAG_REQUEST_HTTP_STATUS = 'stripe.request.http_status'
+          TAG_REQUEST_ID = 'stripe.request.id'
+          TAG_REQUEST_METHOD = 'stripe.request.method'
+          TAG_REQUEST_NUM_RETRIES = 'stripe.request.num_retries'
+          TAG_REQUEST_PATH = 'stripe.request.path'
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/stripe/integration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Stripe
+        # Description of Stripe integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('5.15.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :stripe
+
+          def self.version
+            Gem.loaded_specs['stripe'] && Gem.loaded_specs['stripe'].version
+          end
+
+          def self.loaded?
+            !defined?(::Stripe).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/stripe/patcher.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+# typed: false
+
+require_relative '../patcher'
+require_relative 'request'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Stripe
+        # Provides instrumentation for `stripe` through the Stripe instrumentation framework
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Stripe::Instrumentation.subscribe(:request_begin, :datadog_tracing) { |event| Request.start_span(event) }
+            ::Stripe::Instrumentation.subscribe(:request_end, :datadog_tracing) { |event| Request.finish_span(event) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/stripe/request.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative '../../metadata/ext'
+require_relative '../../analytics'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Stripe
+        # Defines instrumentation for Stripe requests
+        module Request
+          module_function
+
+          def start_span(event)
+            # Start a trace
+            Tracing.trace(Ext::SPAN_REQUEST).tap do |span|
+              event.user_data[:datadog_span] = span
+            end
+          end
+
+          def finish_span(event)
+            span = event.user_data[:datadog_span]
+            # If no active span, return.
+            return nil if span.nil?
+
+            begin
+              tag_span(span, event)
+            ensure
+              # Finish the span
+              span.finish
+            end
+          end
+
+          def tag_span(span, event)
+            # dependent upon stripe/stripe-ruby#1168
+            span.resource = "stripe.#{event.object_name}" if event.respond_to?(:object_name) && event.object_name
+
+            span.span_type = Ext::SPAN_TYPE_REQUEST
+            span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+            span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
+
+            # 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_REQUEST_ID, event.request_id)
+            span.set_tag(Ext::TAG_REQUEST_HTTP_STATUS, event.http_status.to_s)
+            span.set_tag(Ext::TAG_REQUEST_METHOD, event.method)
+            span.set_tag(Ext::TAG_REQUEST_PATH, event.path)
+            span.set_tag(Ext::TAG_REQUEST_NUM_RETRIES, event.num_retries.to_s)
+          rescue StandardError => e
+            Datadog.logger.debug(e.message)
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:stripe]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/sucker_punch/configuration/settings.rb

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/sucker_punch/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sucker_punch/instrumentation.rb

@@ -2,10 +2,9 @@
 
 require 'sucker_punch'
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/sucker_punch/ext'
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sucker_punch/integration.rb

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/contrib/integration'
-require 'datadog/tracing/contrib/sucker_punch/configuration/settings'
-require 'datadog/tracing/contrib/sucker_punch/patcher'
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
 
 module Datadog
   module Tracing

data/lib/datadog/tracing/contrib/sucker_punch/patcher.rb

@@ -1,8 +1,7 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/patcher'
-require 'datadog/tracing/contrib/sucker_punch/ext'
+require_relative '../patcher'
+require_relative 'ext'
 
 module Datadog
   module Tracing
@@ -20,8 +19,8 @@ module Datadog
           end
 
           def patch
-            require 'datadog/tracing/contrib/sucker_punch/exception_handler'
-            require 'datadog/tracing/contrib/sucker_punch/instrumentation'
+            require_relative 'exception_handler'
+            require_relative 'instrumentation'
 
             ExceptionHandler.patch!
             Instrumentation.patch!