ddtrace 0.34.1 → 1.23.1

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

@@ -0,0 +1,119 @@
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
+require_relative '../formatting'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module DatadogInterceptor
+          # The DatadogInterceptor::Client implements the tracing strategy
+          # for gRPC client-side endpoints. This middleware component will
+          # inject trace context information into gRPC metadata prior to
+          # sending the request to the server.
+          class Client < Base
+            def trace(keywords)
+              formatter = GRPC::Formatting::FullMethodStringFormatter.new(keywords[:method])
+
+              options = {
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND,
+                service: service_name, # Maintain client-side service name configuration
+                resource: formatter.resource_name,
+                on_error: error_handler
+              }
+
+              Tracing.trace(Ext::SPAN_CLIENT, **options) do |span, trace|
+                annotate!(trace, span, keywords, formatter)
+
+                begin
+                  result = yield
+                rescue StandardError => e
+                  code = e.is_a?(::GRPC::BadStatus) ? e.code : ::GRPC::Core::StatusCodes::UNKNOWN
+                  span.set_tag(Contrib::Ext::RPC::GRPC::TAG_STATUS_CODE, code)
+
+                  raise
+                end
+                span.set_tag(Contrib::Ext::RPC::GRPC::TAG_STATUS_CODE, ::GRPC::Core::StatusCodes::OK)
+                result
+              end
+            end
+
+            private
+
+            def annotate!(trace, span, keywords, formatter)
+              metadata = keywords[:metadata] || {}
+              call = keywords[:call]
+
+              span.set_tags(metadata)
+
+              if datadog_configuration[:peer_service]
+                span.set_tag(
+                  Tracing::Metadata::Ext::TAG_PEER_SERVICE,
+                  datadog_configuration[: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_CLIENT)
+
+              span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+              span.set_tag(Contrib::Ext::RPC::GRPC::TAG_FULL_METHOD, formatter.grpc_full_method)
+              span.set_tag(Contrib::Ext::RPC::TAG_SERVICE, formatter.rpc_service)
+
+              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?
+
+              Distributed::Propagation::INSTANCE.inject!(trace, metadata) if distributed_tracing?
+              Contrib::SpanAttributeSchema.set_peer_service!(span, Ext::PEER_SERVICE_SOURCES)
+            rescue StandardError => e
+              Datadog.logger.debug("GRPC client trace failed: #{e}")
+            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
+
+              peer_address = if call.respond_to?(:peer)
+                               call.peer
+                             else
+                               # call is a "view" class with restricted method visibility.
+                               # We reach into it to find our data source anyway.
+                               call.instance_variable_get(:@wrapped).peer
+                             end
+
+              Core::Utils.extract_host_port(peer_address)
+            rescue => e
+              Datadog.logger.debug { "Could not parse host:port from #{call}: #{e}" }
+              nil
+            end
+
+            def error_handler
+              Datadog.configuration_for(self, :error_handler) || datadog_configuration[:client_error_handler]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+require_relative '../../../../tracing'
+require_relative '../../../metadata/ext'
+require_relative '../distributed/propagation'
+require_relative '../../analytics'
+require_relative '../ext'
+require_relative '../../ext'
+require_relative '../formatting'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module DatadogInterceptor
+          # The DatadogInterceptor::Server implements the tracing strategy
+          # for gRPC server-side endpoints. When the datadog fields have been
+          # added to the gRPC call metadata, this middleware component will
+          # extract any client-side tracing information, attempting to associate
+          # its tracing context with a parent client-side context
+          class Server < Base
+            def trace(keywords)
+              formatter = GRPC::Formatting::MethodObjectFormatter.new(keywords[:method])
+
+              options = {
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
+                service: service_name, # TODO: Remove server-side service name configuration
+                resource: formatter.resource_name,
+                on_error: error_handler
+              }
+              metadata = keywords[:call].metadata
+
+              set_distributed_context!(metadata)
+
+              Tracing.trace(Ext::SPAN_SERVICE, **options) do |span|
+                annotate!(span, metadata, formatter)
+
+                begin
+                  yield
+                rescue StandardError => e
+                  code = e.is_a?(::GRPC::BadStatus) ? e.code : ::GRPC::Core::StatusCodes::UNKNOWN
+                  span.set_tag(Contrib::Ext::RPC::GRPC::TAG_STATUS_CODE, code)
+
+                  raise
+                else
+                  span.set_tag(Contrib::Ext::RPC::GRPC::TAG_STATUS_CODE, ::GRPC::Core::StatusCodes::OK)
+                end
+              end
+            end
+
+            private
+
+            def set_distributed_context!(metadata)
+              Tracing.continue_trace!(Distributed::Propagation::INSTANCE.extract(metadata))
+            rescue StandardError => e
+              Datadog.logger.debug(
+                "unable to propagate GRPC metadata to context: #{e}"
+              )
+            end
+
+            def annotate!(span, metadata, formatter)
+              metadata.each do |header, value|
+                # 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
+
+              # 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_SERVER)
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERVICE)
+
+              span.set_tag(Contrib::Ext::RPC::TAG_SYSTEM, Ext::TAG_SYSTEM)
+              span.set_tag(Contrib::Ext::RPC::TAG_SERVICE, formatter.legacy_grpc_service)
+              span.set_tag(Contrib::Ext::RPC::TAG_METHOD, formatter.legacy_grpc_method)
+              span.set_tag(Contrib::Ext::RPC::GRPC::TAG_FULL_METHOD, formatter.grpc_full_method)
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+              # Measure service stats
+              Contrib::Analytics.set_measured(span)
+            rescue StandardError => e
+              Datadog.logger.debug("GRPC server trace failed: #{e}")
+            end
+
+            def error_handler
+              self_handler = Datadog.configuration_for(self, :error_handler)
+              return self_handler if self_handler
+
+              unless datadog_configuration.using_default?(:server_error_handler)
+                return datadog_configuration[:server_error_handler]
+              end
+
+              # As a last resort, fallback to the deprecated error_handler
+              # configuration option.
+              datadog_configuration[:error_handler]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+require_relative '../analytics'
+require_relative 'ext'
+require_relative 'configuration/settings'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # :nodoc:
+        module DatadogInterceptor
+          # :nodoc:
+          class Base < ::GRPC::Interceptor
+            def initialize(options = {})
+              super
+              return unless block_given?
+
+              # Set custom configuration on the interceptor if block is given
+              pin_adapter = PinAdapter.new
+              yield(pin_adapter)
+              Datadog.configure_onto(self, **pin_adapter.options)
+            end
+
+            def request_response(**keywords, &block)
+              trace(keywords, &block)
+            end
+
+            def client_streamer(**keywords, &block)
+              trace(keywords, &block)
+            end
+
+            def server_streamer(**keywords, &block)
+              trace(keywords, &block)
+            end
+
+            def bidi_streamer(**keywords, &block)
+              trace(keywords, &block)
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:grpc]
+            end
+
+            def service_name
+              Datadog.configuration_for(self, :service_name) || datadog_configuration[:service_name]
+            end
+
+            def analytics_enabled?
+              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
+
+            # Allows interceptors to define settings using methods instead of `[]`
+            class PinAdapter
+              OPTIONS = Configuration::Settings.instance_methods(false).freeze
+
+              attr_reader :options
+
+              def initialize
+                @options = {}
+              end
+
+              def self.add_setter!(option)
+                define_method(option) do |value|
+                  @options[option.to_s[0...-1].to_sym] = value
+                end
+              end
+
+              def self.add_getter!(option)
+                define_method(option) do
+                  return @options[option] if @options.key?(option)
+
+                  Datadog.configuration.tracing[:grpc][option]
+                end
+              end
+
+              OPTIONS.each do |option|
+                if option.to_s[-1] == '='
+                  add_setter!(option)
+                else
+                  add_getter!(option)
+                end
+              end
+            end
+          end
+
+          require_relative 'datadog_interceptor/client'
+          require_relative 'datadog_interceptor/server'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: 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,42 @@
+# frozen_string_literal: 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

@@ -0,0 +1,29 @@
+# frozen_string_literal: 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'
+          ENV_SERVICE_NAME = 'DD_TRACE_GRPC_SERVICE_NAME'
+          ENV_PEER_SERVICE = 'DD_TRACE_GRPC_PEER_SERVICE'
+          # @!visibility private
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRPC_ANALYTICS_ENABLED'
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRPC_ANALYTICS_SAMPLE_RATE'
+          DEFAULT_PEER_SERVICE_NAME = 'grpc'
+          SPAN_CLIENT = 'grpc.client'
+          SPAN_SERVICE = 'grpc.service'
+          TAG_CLIENT_DEADLINE = 'grpc.client.deadline'
+          TAG_COMPONENT = 'grpc'
+          TAG_OPERATION_CLIENT = 'client'
+          TAG_OPERATION_SERVICE = 'service'
+          TAG_SYSTEM = 'grpc'
+          PEER_SERVICE_SOURCES = Contrib::Ext::RPC::PEER_SERVICE_SOURCES.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Formatting
+          VALUE_UNKNOWN = 'unknown'
+
+          # A class to extract GRPC span attributes from the GRPC implementing class method object.
+          class MethodObjectFormatter
+            # grpc_full_method is a string containing all the rpc method information (from the Protobuf definition)
+            # in a single string with the following format: /$package.$service/$method
+            attr_reader :grpc_full_method
+
+            # legacy_grpc_service is built using the Ruby GRPC service implementation package and class name instead
+            # of the rpc interface representation from Protobuf. It's kept for compatibility.
+            attr_reader :legacy_grpc_service
+
+            # legacy_grpc_method is built using the Ruby GRPC service implementation method name instead of the rpc
+            # interface representation from Protobuf. It's kept for compatibility.
+            attr_reader :legacy_grpc_method
+
+            # resource_name is used for the span resource name.
+            attr_reader :resource_name
+
+            def initialize(grpc_method_object)
+              @grpc_full_method = format_full_method(grpc_method_object)
+              @resource_name = format_resource_name(grpc_method_object)
+              @legacy_grpc_method = extract_legacy_grpc_method(grpc_method_object)
+              @legacy_grpc_service = extract_legacy_grpc_service(grpc_method_object)
+            end
+
+            private
+
+            def format_full_method(grpc_method_object)
+              service = extract_grpc_service(grpc_method_object)
+              method = extract_grpc_method(grpc_method_object)
+              "/#{service}/#{method}"
+            end
+
+            def extract_grpc_service(grpc_method_object)
+              owner = grpc_method_object.owner
+              return VALUE_UNKNOWN unless owner.instance_variable_defined?(:@service_name)
+
+              # Ruby protoc generated code includes this variable which directly contains the value from the original
+              # protobuf definition
+              owner.service_name.to_s
+            end
+
+            # extract_grpc_method attempts to find the original method name from the Protobuf file definition,
+            # since grpc gem forces the implementation method name to be in snake_case.
+            def extract_grpc_method(grpc_method_object)
+              owner = grpc_method_object.owner
+
+              return VALUE_UNKNOWN unless owner.instance_variable_defined?(:@rpc_descs)
+
+              method, = owner.rpc_descs.find do |k, _|
+                ::GRPC::GenericService.underscore(k.to_s) == grpc_method_object.name.to_s
+              end
+
+              return VALUE_UNKNOWN if method.nil?
+
+              method.to_s
+            end
+
+            def extract_legacy_grpc_service(grpc_method_object)
+              grpc_method_object.owner.to_s
+            end
+
+            def extract_legacy_grpc_method(grpc_method_object)
+              grpc_method_object.name
+            end
+
+            def format_resource_name(grpc_method_object)
+              grpc_method_object
+                .owner
+                .to_s
+                .downcase
+                .split('::')
+                .<<(grpc_method_object.name)
+                .join('.')
+            end
+          end
+
+          # A class to extract GRPC span attributes from the full method string.
+          class FullMethodStringFormatter
+            # grpc_full_method is a string containing all the rpc method information (from the Protobuf definition)
+            # in a single string with the following format: /$package.$service/$method
+            attr_reader :grpc_full_method
+
+            # resource_name is used for the span resource name.
+            attr_reader :resource_name
+
+            # rpc_service represents the $package.$service part of the grpc_full_method string.
+            attr_reader :rpc_service
+
+            def initialize(grpc_full_method)
+              @grpc_full_method = grpc_full_method
+              @resource_name = format_resource_name(grpc_full_method)
+              @rpc_service = extract_grpc_service(grpc_full_method)
+            end
+
+            private
+
+            def format_resource_name(grpc_full_method)
+              grpc_full_method
+                .downcase
+                .split('/')
+                .reject(&:empty?)
+                .join('.')
+            end
+
+            def extract_grpc_service(grpc_full_method)
+              parts = grpc_full_method.split('/')
+              if parts.length < 3
+                ''
+              else
+                parts[1]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+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? &&
+              # When using the Google "Calendar User Availability API"
+              # (https://developers.google.com/calendar/api/user-availability/reference/rest), though the gem
+              # `google-cloud-calendar-useravailability-v1alpha` (currently in private preview),
+              # it's possible to load `GRPC` without loading the rest of the `grpc` gem. See:
+              # https://github.com/googleapis/gapic-generator-ruby/blob/f1c2e73219453e497b6ec2dc807a907e939e1342/gapic-common/lib/gapic/common.rb#L15-L16
+              # When this happens, there are no gRPC components of interest to instrument.
+              !defined?(::GRPC::Interceptor).nil? && !defined?(::GRPC::InterceptionContext).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 @@
+# frozen_string_literal: 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,34 @@
+# frozen_string_literal: true
+
+require_relative 'ext'
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        # Patcher enables patching of 'grpc' module.
+        module Patcher
+          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