ddtrace 0.53.0 → 1.9.0

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

@@ -0,0 +1,27 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # gRPC integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_GRPC_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_GRPC_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRPC_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRPC_ANALYTICS_SAMPLE_RATE'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'grpc'.freeze
+          SPAN_CLIENT = 'grpc.client'.freeze
+          SPAN_SERVICE = 'grpc.service'.freeze
+          TAG_CLIENT_DEADLINE = 'grpc.client.deadline'.freeze
+          TAG_COMPONENT = 'grpc'.freeze
+          TAG_OPERATION_CLIENT = 'client'.freeze
+          TAG_OPERATION_SERVICE = 'service'.freeze
+
+          TAG_SYSTEM = 'grpc'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # Description of gRPC integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.7.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :grpc, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['grpc'] && Gem.loaded_specs['grpc'].version
+          end
+
+          def self.loaded?
+            !defined?(::GRPC).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/grpc/intercept_with_datadog.rb

@@ -0,0 +1,53 @@
+# typed: true
+
+require_relative 'datadog_interceptor'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # :nodoc:
+        # The `#intercept!` method is implemented in gRPC; this module
+        # will be prepended to the original class, effectively injecting
+        # our tracing middleware into the head of the call chain.
+        module InterceptWithDatadog
+          def intercept!(type, args = {})
+            if should_prepend?
+              datadog_interceptor = choose_datadog_interceptor(args)
+
+              @interceptors.unshift(datadog_interceptor.new) if datadog_interceptor
+
+              @trace_started = true
+            end
+
+            super
+          end
+
+          private
+
+          def should_prepend?
+            !trace_started? && !already_prepended?
+          end
+
+          def trace_started?
+            defined?(@trace_started) && @trace_started
+          end
+
+          def already_prepended?
+            @interceptors.any? do |interceptor|
+              interceptor.class.ancestors.include?(Datadog::Tracing::Contrib::GRPC::DatadogInterceptor::Base)
+            end
+          end
+
+          def choose_datadog_interceptor(args)
+            if args.key?(:metadata)
+              Datadog::Tracing::Contrib::GRPC::DatadogInterceptor::Client
+            elsif args.key?(:call)
+              Datadog::Tracing::Contrib::GRPC::DatadogInterceptor::Server
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# typed: true
+
+require_relative 'ext'
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # Patcher enables patching of 'grpc' module.
+        module Patcher
+          include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require_relative 'intercept_with_datadog'
+
+            prepend_interceptor
+          end
+
+          def prepend_interceptor
+            ::GRPC::InterceptionContext
+              .prepend(InterceptWithDatadog)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/hanami/action_tracer.rb

@@ -0,0 +1,47 @@
+# typed: ignore
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.action`
+        class ActionTracer
+          def initialize(app, action)
+            @app = app
+            @action = action
+          end
+
+          def call(env)
+            Tracing.trace(
+              Ext::SPAN_ACTION,
+              resource: @action.to_s,
+              service: configuration[:service_name],
+              span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+            ) do |span_op, trace_op|
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ACTION)
+
+              if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+                Contrib::Analytics.set_sample_rate(span_op, configuration[:analytics_sample_rate])
+              end
+
+              trace_op.resource = span_op.resource
+
+              @app.call(env)
+            end
+          end
+
+          private
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# typed: ignore
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        module Configuration
+          # Configuration for Hanami instrumentation
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# typed: ignore
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_HANAMI_ENABLED'.freeze
+
+          SPAN_ACTION =  'hanami.action'.freeze
+          SPAN_ROUTING = 'hanami.routing'.freeze
+          SPAN_RENDER =  'hanami.render'.freeze
+
+          TAG_COMPONENT = 'hanami'.freeze
+          TAG_OPERATION_ACTION = 'action'.freeze
+          TAG_OPERATION_ROUTING = 'routing'.freeze
+          TAG_OPERATION_RENDER = 'render'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: ignore
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Description of Hanami integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.0.0')
+          MAXIMUM_VERSION = Gem::Version.new('2.0.0')
+
+          register_as :hanami
+
+          def self.version
+            Gem.loaded_specs['hanami'] && Gem.loaded_specs['hanami'].version
+          end
+
+          def self.loaded?
+            !defined?(::Hanami).nil?
+          end
+
+          def self.compatible?
+            # Tested with version larger than 1.x, but not 2.x version
+            super && version >= MINIMUM_VERSION && version < MAXIMUM_VERSION
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: ignore
+
+require_relative '../patcher'
+require_relative 'action_tracer'
+require_relative 'renderer_policy_tracing'
+require_relative 'router_tracing'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Patcher enables patching of Hanami
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            # For auto instrumentation, `plugin` must be required before `Hanami.boot`
+            require_relative 'plugin'
+
+            ::Hanami::Router.prepend(RouterTracing)
+            ::Hanami::RenderingPolicy.prepend(RendererPolicyTracing)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/hanami/plugin.rb

@@ -0,0 +1,23 @@
+# typed: ignore
+
+::Hanami.plugin do
+  Datadog.configure do |c|
+    c.tracing.instrument :rack
+  end
+
+  middleware.use Datadog::Tracing::Contrib::Rack::TraceMiddleware
+end
+
+::Hanami::Application.singleton_class.prepend(
+  Module.new do
+    def inherited(base)
+      super
+
+      base.configure do
+        controller.prepare do
+          use Datadog::Tracing::Contrib::Hanami::ActionTracer, self
+        end
+      end
+    end
+  end
+)

data/lib/datadog/tracing/contrib/hanami/renderer_policy_tracing.rb

@@ -0,0 +1,41 @@
+# typed: ignore
+
+require_relative 'ext'
+require_relative '../../metadata/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.render`
+        module RendererPolicyTracing
+          def render(env, response)
+            action = env['hanami.action']
+            # env['hanami.action'] could be empty for endpoints without an action
+            #
+            # For example in config/routes.rb:
+            # get '/hello', to: ->(env) { [200, {}, ['Hello from Hanami!']] }
+            action_klass = (action && action.class) ||
+              ::Hanami::Routing::Default::NullAction
+
+            Tracing.trace(
+              Ext::SPAN_RENDER,
+              service: configuration[:service_name],
+              resource: action_klass.to_s,
+              span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+            ) do |span_op, _trace_op|
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span_op.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_RENDER)
+
+              super
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/hanami/router_tracing.rb

@@ -0,0 +1,44 @@
+# typed: ignore
+
+require_relative 'ext'
+require_relative '../../metadata/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Hanami
+        # Hanami Instrumentation for `hanami.routing`
+        module RouterTracing
+          def call(env)
+            return super if Tracing.active_span && Tracing.active_span.name == Ext::SPAN_ROUTING
+
+            Tracing.trace(
+              Ext::SPAN_ROUTING,
+              service: configuration[:service_name],
+              span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND
+            ) do |span_op, trace_op|
+              begin
+                span_op.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span_op.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ROUTING)
+
+                span_op.resource = nil
+
+                super
+              ensure
+                span_op.resource ||= if trace_op.resource_override?
+                                       trace_op.resource
+                                     else
+                                       env['REQUEST_METHOD']
+                                     end
+              end
+            end
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:hanami]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/http/circuit_breaker.rb

@@ -0,0 +1,43 @@
+# typed: true
+
+require_relative '../../../../ddtrace/transport/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        # HTTP integration circuit breaker behavior
+        # For avoiding recursive traces.
+        module CircuitBreaker
+          def should_skip_tracing?(request)
+            return true if datadog_http_request?(request)
+
+            # we don't want a "shotgun" effect with two nested traces for one
+            # logical get, and request is likely to call itself recursively
+            active = Tracing.active_span
+            return true if active && (active.name == Ext::SPAN_REQUEST)
+
+            false
+          end
+
+          # We don't want to trace our own call to the API (they use net/http)
+          # TODO: We don't want this kind of soft-check on HTTP requests.
+          #       Remove this when transport implements its own "skip tracing" mechanism.
+          def datadog_http_request?(request)
+            if request[Datadog::Transport::Ext::HTTP::HEADER_META_TRACER_VERSION]
+              true
+            else
+              false
+            end
+          end
+
+          def should_skip_distributed_tracing?(client_config)
+            return !client_config[:distributed_tracing] if client_config && client_config.key?(:distributed_tracing)
+
+            !Datadog.configuration.tracing[:http][:distributed_tracing]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# typed: false
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        module Configuration
+          # Custom settings for the HTTP 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
+
+            option :distributed_tracing, default: true
+
+            option :service_name do |o|
+              o.default { ENV.fetch(Ext::ENV_SERVICE_NAME, Ext::DEFAULT_PEER_SERVICE_NAME) }
+              o.lazy
+            end
+
+            option :error_status_codes do |o|
+              o.default { env_to_list(Ext::ENV_ERROR_STATUS_CODES, 400...600, comma_separated_only: false) }
+              o.lazy
+            end
+
+            option :split_by_domain, default: false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/http/distributed/fetcher.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: false
+# typed: false
+
+require_relative '../../../distributed/fetcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        module Distributed
+          # Retrieves HTTP headers from carrier.
+          # Headers will also match if Rack-formatted:
+          # 'my-header' will match 'my-header' and 'HTTP_MY_HEADER'.
+          #
+          # In case both variants are present, the verbatim match will be used.
+          class Fetcher < Tracing::Distributed::Fetcher
+            # DEV: Should we try to parse both verbatim an Rack-formatted headers,
+            # DEV: given Rack-formatted is the most common format in Ruby?
+            def [](name)
+              # Try to fetch with the plain key
+              value = super(name)
+              return value if value && !value.empty?
+
+              # If not found, try the Rack-formatted key
+              rack_header = "HTTP-#{name}"
+              rack_header.upcase!
+              rack_header.tr!('-'.freeze, '_'.freeze)
+
+              hdr = super(rack_header)
+
+              # Only return the value if it is not an empty string
+              hdr if hdr != ''
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/http/distributed/propagation.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# typed: true
+
+require_relative 'fetcher'
+require_relative '../../../distributed/propagation'
+require_relative '../../../distributed/b3_multi'
+require_relative '../../../distributed/b3_single'
+require_relative '../../../distributed/datadog'
+require_relative '../../../distributed/none'
+require_relative '../../../distributed/trace_context'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        module Distributed
+          # Extracts and injects propagation through HTTP headers.
+          class Propagation < Tracing::Distributed::Propagation
+            def initialize
+              super(
+                propagation_styles: {
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_MULTI_HEADER =>
+                    Tracing::Distributed::B3Multi.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_B3_SINGLE_HEADER =>
+                    Tracing::Distributed::B3Single.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_DATADOG =>
+                    Tracing::Distributed::Datadog.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_TRACE_CONTEXT =>
+                    Tracing::Distributed::TraceContext.new(fetcher: Fetcher),
+                  Tracing::Configuration::Ext::Distributed::PROPAGATION_STYLE_NONE => Tracing::Distributed::None.new
+                })
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        # HTTP integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_HTTP_ENABLED'.freeze
+          ENV_SERVICE_NAME = 'DD_TRACE_NET_HTTP_SERVICE_NAME'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTP_ERROR_STATUS_CODES'.freeze
+          DEFAULT_PEER_SERVICE_NAME = 'net/http'.freeze
+          SPAN_REQUEST = 'http.request'.freeze
+          TAG_COMPONENT = 'net/http'.freeze
+          TAG_OPERATION_REQUEST = 'request'.freeze
+        end
+      end
+    end
+  end
+end