ddtrace 1.1.0 → 1.9.0

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

@@ -1,8 +1,8 @@
 # typed: false
 
-require 'datadog/tracing/span_operation'
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../span_operation'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -27,7 +27,13 @@ module Datadog
               o.lazy
             end
 
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            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_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
           end
         end

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/client.rb

@@ -1,9 +1,11 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -36,6 +38,10 @@ module Datadog
             def annotate!(trace, span, metadata, call)
               span.set_tags(metadata)
 
+              span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+
+              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_CLIENT)
 
@@ -44,10 +50,13 @@ module Datadog
               host, _port = find_host_port(call)
               span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
 
+              deadline = find_deadline(call)
+              span.set_tag(Ext::TAG_CLIENT_DEADLINE, deadline) if deadline
+
               # Set analytics sample rate
               Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
 
-              Tracing::Propagation::GRPC.inject!(trace, metadata)
+              Distributed::Propagation::INSTANCE.inject!(trace, metadata) if distributed_tracing?
             rescue StandardError => e
               Datadog.logger.debug("GRPC client trace failed: #{e}")
             end
@@ -60,6 +69,12 @@ module Datadog
                 .join('.')
             end
 
+            def find_deadline(call)
+              return unless call.respond_to?(:deadline) && call.deadline.is_a?(Time)
+
+              call.deadline.utc.iso8601(3)
+            end
+
             def find_host_port(call)
               return unless call
 

data/lib/datadog/tracing/contrib/grpc/datadog_interceptor/server.rb

@@ -1,11 +1,11 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/distributed/headers/ext'
-require 'datadog/tracing/metadata/ext'
-require 'datadog/tracing/propagation/grpc'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
 
 module Datadog
   module Tracing
@@ -19,10 +19,11 @@ module Datadog
           # its tracing context with a parent client-side context
           class Server < Base
             def trace(keywords)
+              method = keywords[:method]
               options = {
                 span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
                 service: service_name, # TODO: Remove server-side service name configuration
-                resource: format_resource(keywords[:method]),
+                resource: format_resource(method),
                 on_error: error_handler
               }
               metadata = keywords[:call].metadata
@@ -30,6 +31,10 @@ module Datadog
               set_distributed_context!(metadata)
 
               Tracing.trace(Ext::SPAN_SERVICE, **options) do |span|
+                span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+                span.set_tag(Contrib::Ext::RPC::TAG_SERVICE, method.owner.to_s)
+                span.set_tag(Contrib::Ext::RPC::TAG_METHOD,  method.name)
+
                 annotate!(span, metadata)
 
                 yield
@@ -39,7 +44,7 @@ module Datadog
             private
 
             def set_distributed_context!(metadata)
-              Tracing.continue_trace!(Tracing::Propagation::GRPC.extract(metadata))
+              Tracing.continue_trace!(Distributed::Propagation::INSTANCE.extract(metadata))
             rescue StandardError => e
               Datadog.logger.debug(
                 "unable to propagate GRPC metadata to context: #{e}"
@@ -48,11 +53,14 @@ module Datadog
 
             def annotate!(span, metadata)
               metadata.each do |header, value|
-                next if reserved_headers.include?(header)
+                # Datadog propagation headers are considered internal implementation detail.
+                next if header.to_s.start_with?(Tracing::Distributed::Datadog::TAGS_PREFIX)
 
                 span.set_tag(header, value)
               end
 
+              span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_SERVER)
+
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERVICE)
 
@@ -65,14 +73,6 @@ module Datadog
               Datadog.logger.debug("GRPC client trace failed: #{e}")
             end
 
-            def reserved_headers
-              [
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_TRACE_ID,
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_PARENT_ID,
-                Tracing::Distributed::Headers::Ext::GRPC_METADATA_SAMPLING_PRIORITY
-              ]
-            end
-
             def format_resource(proto_method)
               proto_method
                 .owner

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

@@ -1,9 +1,8 @@
 # typed: ignore
 
-require 'datadog/tracing'
-require 'datadog/tracing/contrib/analytics'
-require 'datadog/tracing/contrib/grpc/ext'
-require 'datadog/tracing/contrib/grpc/configuration/settings'
+require_relative '../analytics'
+require_relative 'ext'
+require_relative 'configuration/settings'
 
 module Datadog
   module Tracing
@@ -53,6 +52,10 @@ module Datadog
               Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
             end
 
+            def distributed_tracing?
+              Datadog.configuration_for(self, :distributed_tracing) || datadog_configuration[:distributed_tracing]
+            end
+
             def analytics_sample_rate
               datadog_configuration[:analytics_sample_rate]
             end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# typed: true
+
+require_relative '../../../distributed/fetcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Distributed
+          # Retrieves values from the gRPC metadata.
+          # One metadata key can be associated with multiple values.
+          #
+          # @see https://github.com/grpc/grpc-go/blob/56ac86fa0f3940cb79946ce2c6e56f7ee7ecae84/Documentation/grpc-metadata.md#constructing-metadata
+          class Fetcher < Tracing::Distributed::Fetcher
+            def [](key)
+              # Metadata values are normally integrals but can also be
+              # arrays when multiple values are associated with the same key.
+              value = super(key)
+              value.is_a?(::Array) ? value[0] : value
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: true
+
+require_relative 'fetcher'
+require_relative '../../../distributed/b3_multi'
+require_relative '../../../distributed/b3_single'
+require_relative '../../../distributed/datadog'
+require_relative '../../../distributed/none'
+require_relative '../../../distributed/propagation'
+require_relative '../../../distributed/trace_context'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Distributed
+          # Extracts and injects propagation through gRPC metadata.
+          # @see https://github.com/grpc/grpc-go/blob/v1.50.1/Documentation/grpc-metadata.md
+          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
+
+            # DEV: Singleton kept until a larger refactor is performed.
+            # DEV: See {Datadog::Tracing::Distributed::Propagation#initialize} for more information.
+            INSTANCE = Propagation.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,14 +8,18 @@ module Datadog
         # @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

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

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

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

@@ -1,7 +1,7 @@
 # typed: true
 
-require 'datadog/tracing/contrib/grpc/ext'
-require 'datadog/tracing/contrib/patcher'
+require_relative 'ext'
+require_relative '../patcher'
 
 module Datadog
   module Tracing
@@ -19,9 +19,7 @@ module Datadog
           end
 
           def patch
-            require 'datadog/tracing/propagation/grpc'
-            require 'datadog/tracing/contrib/grpc/datadog_interceptor'
-            require 'datadog/tracing/contrib/grpc/intercept_with_datadog'
+            require_relative 'intercept_with_datadog'
 
             prepend_interceptor
           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

@@ -1,7 +1,6 @@
 # typed: true
 
-require 'datadog/tracing'
-require 'ddtrace/transport/ext'
+require_relative '../../../../ddtrace/transport/ext'
 
 module Datadog
   module Tracing

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

@@ -1,7 +1,7 @@
 # typed: false
 
-require 'datadog/tracing/contrib/configuration/settings'
-require 'datadog/tracing/contrib/http/ext'
+require_relative '../../configuration/settings'
+require_relative '../ext'
 
 module Datadog
   module Tracing
@@ -27,7 +27,17 @@ module Datadog
             end
 
             option :distributed_tracing, default: true
-            option :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+
+            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