ddtrace 1.7.0 → 1.9.0

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.rb

@@ -75,4 +75,5 @@ require_relative 'contrib/shoryuken/integration'
 require_relative 'contrib/sidekiq/integration'
 require_relative 'contrib/sinatra/integration'
 require_relative 'contrib/sneakers/integration'
+require_relative 'contrib/stripe/integration'
 require_relative 'contrib/sucker_punch/integration'

data/lib/datadog/{core → tracing}/diagnostics/ext.rb

@@ -1,19 +1,14 @@
 # typed: true
 
 module Datadog
-  module Core
+  module Tracing
     module Diagnostics
       # @public_api
       module Ext
-        DD_TRACE_STARTUP_LOGS = 'DD_TRACE_STARTUP_LOGS'.freeze
-        DD_TRACE_DEBUG = 'DD_TRACE_DEBUG'.freeze
-        DD_TRACE_ENABLED = 'DD_TRACE_ENABLED'.freeze
         # Health
         module Health
           # Metrics
           module Metrics
-            ENV_ENABLED = 'DD_HEALTH_METRICS_ENABLED'.freeze
-
             METRIC_API_ERRORS = 'datadog.tracer.api.errors'.freeze
             METRIC_API_REQUESTS = 'datadog.tracer.api.requests'.freeze
             METRIC_API_RESPONSES = 'datadog.tracer.api.responses'.freeze

data/lib/datadog/tracing/diagnostics/health.rb

@@ -0,0 +1,40 @@
+# typed: ignore
+
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Diagnostics
+      # Health-related diagnostics
+      module Health
+        # Health metrics for diagnostics
+        module Metrics
+          def self.extended(base)
+            base.class_eval do
+              count :api_errors, Ext::Health::Metrics::METRIC_API_ERRORS
+              count :api_requests, Ext::Health::Metrics::METRIC_API_REQUESTS
+              count :api_responses, Ext::Health::Metrics::METRIC_API_RESPONSES
+              count :error_context_overflow, Ext::Health::Metrics::METRIC_ERROR_CONTEXT_OVERFLOW
+              count :error_instrumentation_patch, Ext::Health::Metrics::METRIC_ERROR_INSTRUMENTATION_PATCH
+              count :error_span_finish, Ext::Health::Metrics::METRIC_ERROR_SPAN_FINISH
+              count :error_unfinished_spans, Ext::Health::Metrics::METRIC_ERROR_UNFINISHED_SPANS
+              count :instrumentation_patched, Ext::Health::Metrics::METRIC_INSTRUMENTATION_PATCHED
+              count :queue_accepted, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED
+              count :queue_accepted_lengths, Ext::Health::Metrics::METRIC_QUEUE_ACCEPTED_LENGTHS
+              count :queue_dropped, Ext::Health::Metrics::METRIC_QUEUE_DROPPED
+              count :traces_filtered, Ext::Health::Metrics::METRIC_TRACES_FILTERED
+              count :transport_trace_too_large, Ext::Health::Metrics::METRIC_TRANSPORT_TRACE_TOO_LARGE
+              count :transport_chunked, Ext::Health::Metrics::METRIC_TRANSPORT_CHUNKED
+              count :writer_cpu_time, Ext::Health::Metrics::METRIC_WRITER_CPU_TIME
+
+              gauge :queue_length, Ext::Health::Metrics::METRIC_QUEUE_LENGTH
+              gauge :queue_max_length, Ext::Health::Metrics::METRIC_QUEUE_MAX_LENGTH
+              gauge :queue_spans, Ext::Health::Metrics::METRIC_QUEUE_SPANS
+              gauge :sampling_service_cache_length, Ext::Health::Metrics::METRIC_SAMPLING_SERVICE_CACHE_LENGTH
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/distributed/{b3.rb → b3_multi.rb}

@@ -7,9 +7,9 @@ require_relative '../trace_digest'
 module Datadog
   module Tracing
     module Distributed
-      # B3-style trace propagation.
+      # B3 multi header-style trace propagation.
       # @see https://github.com/openzipkin/b3-propagation#multiple-headers
-      class B3
+      class B3Multi
         B3_TRACE_ID_KEY = 'x-b3-traceid'
         B3_SPAN_ID_KEY = 'x-b3-spanid'
         B3_SAMPLED_KEY = 'x-b3-sampled'

data/lib/datadog/tracing/distributed/helpers.rb

@@ -2,6 +2,7 @@
 # typed: true
 
 require_relative '../sampling/ext'
+require_relative '../utils'
 
 module Datadog
   module Tracing
@@ -47,7 +48,7 @@ module Datadog
           return if id.nil?
 
           # Zero or greater than max allowed value of 2**64
-          return if id.zero? || id > Span::EXTERNAL_MAX_ID
+          return if id.zero? || id > Tracing::Utils::EXTERNAL_MAX_ID
 
           id < 0 ? id + (2**64) : id
         end

data/lib/datadog/tracing/distributed/none.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# typed: false
+
+module Datadog
+  module Tracing
+    module Distributed
+      # Propagator that does not inject nor extract data. It performs no operation.
+      # Supported for feature parity with OpenTelemetry.
+      # @see https://github.com/open-telemetry/opentelemetry-specification/blob/255a6c52b8914a2ed7e26bb5585abecab276aafc/specification/sdk-environment-variables.md?plain=1#L88
+      class None
+        # No-op
+        def inject!(_digest, _data); end
+
+        # No-op
+        def extract(_data); end
+      end
+    end
+  end
+end