ddtrace 0.34.1 → 1.23.1

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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,23 @@
+# frozen_string_literal: true
+
+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.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+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'
+
+          SPAN_ACTION =  'hanami.action'
+          SPAN_ROUTING = 'hanami.routing'
+          SPAN_RENDER =  'hanami.render'
+
+          TAG_COMPONENT = 'hanami'
+          TAG_OPERATION_ACTION = 'action'
+          TAG_OPERATION_ROUTING = 'routing'
+          TAG_OPERATION_RENDER = 'render'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+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 @@
+# frozen_string_literal: true
+
+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 @@
+# frozen_string_literal: true
+
+::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 @@
+# frozen_string_literal: true
+
+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 @@
+# frozen_string_literal: true
+
+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,40 @@
+# frozen_string_literal: true
+
+require_relative '../../../core/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 internal_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 internal_request?(request)
+            !!(request[Datadog::Core::Transport::Ext::HTTP::HEADER_META_TRACER_VERSION] ||
+              request[Datadog::Core::Transport::Ext::HTTP::HEADER_DD_INTERNAL_UNTRACED_REQUEST])
+          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,75 @@
+# frozen_string_literal: true
+
+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.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            # @!visibility private
+            option :analytics_enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ANALYTICS_ENABLED
+              o.default false
+            end
+
+            option :analytics_sample_rate do |o|
+              o.type :float
+              o.env Ext::ENV_ANALYTICS_SAMPLE_RATE
+              o.default 1.0
+            end
+
+            option :distributed_tracing, default: true, type: :bool
+
+            option :service_name do |o|
+              o.default do
+                Contrib::SpanAttributeSchema.fetch_service_name(
+                  Ext::ENV_SERVICE_NAME,
+                  Ext::DEFAULT_PEER_SERVICE_NAME
+                )
+              end
+            end
+
+            option :error_status_codes do |o|
+              o.env Ext::ENV_ERROR_STATUS_CODES
+              o.default 400...600
+              o.env_parser do |value|
+                values = if value.include?(',')
+                           value.split(',')
+                         else
+                           value.split
+                         end
+                values.map! do |v|
+                  v.gsub!(/\A[\s,]*|[\s,]*\Z/, '')
+
+                  v.empty? ? nil : v
+                end
+
+                values.compact!
+                values
+              end
+            end
+
+            option :peer_service do |o|
+              o.type :string, nilable: true
+              o.env Ext::ENV_PEER_SERVICE
+            end
+
+            option :split_by_domain, default: false, type: :bool
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: 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
+            # @param [String] name the header name
+            # @return [String, nil] the header value or nil if not found
+            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,37 @@
+# frozen_string_literal: 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,29 @@
+# frozen_string_literal: 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'
+          ENV_SERVICE_NAME = 'DD_TRACE_NET_HTTP_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_NET_HTTP_PEER_SERVICE'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_HTTP_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_HTTP_ANALYTICS_SAMPLE_RATE'
+          ENV_ERROR_STATUS_CODES = 'DD_TRACE_HTTP_ERROR_STATUS_CODES'
+          DEFAULT_PEER_SERVICE_NAME = 'net/http'
+          SPAN_REQUEST = 'http.request'
+          TAG_COMPONENT = 'net/http'
+          TAG_OPERATION_REQUEST = 'request'
+          PEER_SERVICE_SOURCES = Array[
+            Tracing::Metadata::Ext::TAG_PEER_HOSTNAME,
+            Tracing::Metadata::Ext::NET::TAG_DESTINATION_NAME,
+            Tracing::Metadata::Ext::NET::TAG_TARGET_HOST,].freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,158 @@
+require 'uri'
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative '../http_annotation_helper'
+require_relative '../utils/quantization/http'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module HTTP
+        # Instrumentation for Net::HTTP
+        module Instrumentation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Span hook invoked after request is completed.
+          def self.after_request(&block)
+            if block
+              # Set hook
+              @after_request = block
+            else
+              # Get hook
+              @after_request ||= nil
+            end
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            include Contrib::HttpAnnotationHelper
+
+            # :yield: +response+
+            def request(req, body = nil, &block)
+              host, = host_and_port(req)
+              request_options = datadog_configuration(host)
+              client_config = Datadog.configuration_for(self)
+
+              return super(req, body, &block) if Contrib::HTTP.should_skip_tracing?(req)
+
+              Tracing.trace(Ext::SPAN_REQUEST, on_error: method(:annotate_span_with_error!)) do |span, trace|
+                begin
+                  span.service = service_name(host, request_options, client_config)
+                  span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+                  span.resource = req.method
+
+                  if Tracing.enabled? && !Contrib::HTTP.should_skip_distributed_tracing?(client_config)
+                    Tracing::Propagation::HTTP.inject!(trace, req)
+                  end
+
+                  # Add additional request specific tags to the span.
+                  annotate_span_with_request!(span, req, request_options)
+                rescue StandardError => e
+                  Datadog.logger.error("error preparing span for http request: #{e}")
+                ensure
+                  response = super(req, body, &block)
+                end
+
+                # Add additional response specific tags to the span.
+                annotate_span_with_response!(span, response, request_options)
+
+                # Invoke hook, if set.
+                unless Contrib::HTTP::Instrumentation.after_request.nil?
+                  Contrib::HTTP::Instrumentation.after_request.call(span, self, req, response)
+                end
+
+                response
+              end
+            end
+
+            def annotate_span_with_request!(span, request, request_options)
+              if request_options[:peer_service]
+                span.set_tag(
+                  Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                  request_options[:peer_service]
+                )
+              end
+
+              # Tag original global service name if not used
+              if span.service != Datadog.configuration.service
+                span.set_tag(Tracing::Contrib::Ext::Metadata::TAG_BASE_SERVICE, Datadog.configuration.service)
+              end
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
+              span.set_tag(
+                Tracing::Metadata::Ext::HTTP::TAG_URL,
+                Contrib::Utils::Quantization::HTTP.url(request.path, { query: { exclude: :all } })
+              )
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request.method)
+
+              host, port = host_and_port(request)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, host)
+              span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, port.to_s)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host)
+
+              # Set analytics sample rate
+              set_analytics_sample_rate(span, request_options)
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.request_tags(request)
+              )
+
+              Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+            end
+
+            def annotate_span_with_response!(span, response, request_options)
+              return unless response && response.code
+
+              span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, response.code)
+
+              span.set_error(response) if request_options[:error_status_codes].include? response.code.to_i
+
+              span.set_tags(
+                Datadog.configuration.tracing.header_tags.response_tags(response)
+              )
+            end
+
+            def annotate_span_with_error!(span, error)
+              span.set_error(error)
+            end
+
+            def set_analytics_sample_rate(span, request_options)
+              return unless analytics_enabled?(request_options)
+
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate(request_options))
+            end
+
+            private
+
+            def host_and_port(request)
+              if request.respond_to?(:uri) && request.uri
+                [request.uri.host, request.uri.port]
+              else
+                [@address, @port]
+              end
+            end
+
+            def datadog_configuration(host = :default)
+              Datadog.configuration.tracing[:http, host]
+            end
+
+            def analytics_enabled?(request_options)
+              Contrib::Analytics.enabled?(request_options[:analytics_enabled])
+            end
+
+            def analytics_sample_rate(request_options)
+              request_options[:analytics_sample_rate]
+            end
+          end
+        end
+      end
+    end
+  end
+end