ddtrace 0.54.0 → 1.0.0

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

@@ -0,0 +1,44 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/graphql/configuration/settings'
+require 'datadog/tracing/contrib/graphql/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GraphQL
+        # Description of GraphQL integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('1.7.9')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :graphql, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version
+          end
+
+          def self.loaded?
+            !defined?(::GraphQL).nil? \
+              && !defined?(::GraphQL::Tracing::DataDogTracing).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/graphql/patcher.rb

@@ -0,0 +1,92 @@
+# typed: false
+
+require 'datadog/tracing'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/graphql/integration'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GraphQL
+        # Provides instrumentation for `graphql` through the GraphQL tracing framework
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            if (schemas = get_option(:schemas))
+              schemas.each { |s| patch_schema!(s) }
+            end
+
+            patch_legacy_gem!
+          end
+
+          def patch_schema!(schema)
+            service_name = get_option(:service_name)
+            analytics_enabled = Contrib::Analytics.enabled?(get_option(:analytics_enabled))
+            analytics_sample_rate = get_option(:analytics_sample_rate)
+
+            if schema.respond_to?(:use)
+              schema.use(
+                ::GraphQL::Tracing::DataDogTracing,
+                # By default, Tracing::DataDogTracing holds a reference to a tracer.
+                # If we provide a tracer argument here it will be eagerly cached,
+                # and Tracing::DataDogTracing will send traces to a stale tracer instance.
+                service: service_name,
+                analytics_enabled: analytics_enabled,
+                analytics_sample_rate: analytics_sample_rate
+              )
+            else
+              schema.define do
+                use(
+                  ::GraphQL::Tracing::DataDogTracing,
+                  # By default, Tracing::DataDogTracing holds a reference to a tracer.
+                  # If we provide a tracer argument here it will be eagerly cached,
+                  # and Tracing::DataDogTracing will send traces to a stale tracer instance.
+                  service: service_name,
+                  analytics_enabled: analytics_enabled,
+                  analytics_sample_rate: analytics_sample_rate
+                )
+              end
+            end
+          end
+
+          # Before https://github.com/rmosolgo/graphql-ruby/pull/4038 was introduced,
+          # we were left with incompatibilities between ddtrace 1.0 and older graphql gem versions.
+          def patch_legacy_gem!
+            return unless Gem::Version.new(::GraphQL::VERSION) <= Gem::Version.new('2.0.6')
+
+            ::GraphQL::Tracing::DataDogTracing.prepend(PatchLegacyGem)
+          end
+
+          def get_option(option)
+            Datadog.configuration.tracing[:graphql].get_option(option)
+          end
+
+          # Patches the graphql gem to support ddtrace 1.0.
+          # This is not necessary in versions containing https://github.com/rmosolgo/graphql-ruby/pull/4038.
+          module PatchLegacyGem
+            # Ensure invocation to #trace method targets the new namespaced public API object,
+            # instead of the old global Datadog.trace.
+            # This is fixed in graphql > 2.0.3.
+            def tracer
+              options.fetch(:tracer, Datadog::Tracing) # GraphQL will invoke #trace on the returned object
+            end
+
+            # Ensure resource name is not left as `nil`.
+            # This is fixed in graphql > 2.0.6.
+            def fallback_transaction_name(context)
+              context[:tracing_fallback_transaction_name] || 'execute.graphql'
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# typed: false
+
+require 'datadog/tracing/span_operation'
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/grpc/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GRPC
+        module Configuration
+          # Custom settings for the gRPC 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 :service_name, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :error_handler, default: Tracing::SpanOperation::Events::DEFAULT_ON_ERROR
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# typed: ignore
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/grpc/ext'
+
+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)
+              keywords[:metadata] ||= {}
+
+              options = {
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND,
+                service: service_name, # Maintain client-side service name configuration
+                resource: format_resource(keywords[:method])
+              }
+
+              Tracing.trace(Ext::SPAN_CLIENT, **options) do |span, trace|
+                annotate!(trace, span, keywords[:metadata], keywords[:call])
+
+                yield
+              end
+            end
+
+            private
+
+            def annotate!(trace, span, metadata, call)
+              span.set_tags(metadata)
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_CLIENT)
+
+              # Tag as an external peer service
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+              host, _port = find_host_port(call)
+              span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, host) if host
+
+              # Set analytics sample rate
+              Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+              Tracing::Propagation::GRPC.inject!(trace, metadata)
+            rescue StandardError => e
+              Datadog.logger.debug("GRPC client trace failed: #{e}")
+            end
+
+            def format_resource(proto_method)
+              proto_method
+                .downcase
+                .split('/')
+                .reject(&:empty?)
+                .join('.')
+            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
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+# 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'
+
+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)
+              options = {
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
+                service: service_name, # TODO: Remove server-side service name configuration
+                resource: format_resource(keywords[:method]),
+                on_error: error_handler
+              }
+              metadata = keywords[:call].metadata
+
+              set_distributed_context!(metadata)
+
+              Tracing.trace(Ext::SPAN_SERVICE, **options) do |span|
+                annotate!(span, metadata)
+
+                yield
+              end
+            end
+
+            private
+
+            def set_distributed_context!(metadata)
+              Tracing.continue_trace!(Tracing::Propagation::GRPC.extract(metadata))
+            rescue StandardError => e
+              Datadog.logger.debug(
+                "unable to propagate GRPC metadata to context: #{e}"
+              )
+            end
+
+            def annotate!(span, metadata)
+              metadata.each do |header, value|
+                next if reserved_headers.include?(header)
+
+                span.set_tag(header, value)
+              end
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_SERVICE)
+
+              # 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 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
+                .to_s
+                .downcase
+                .split('::')
+                .<<(proto_method.name)
+                .join('.')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# typed: ignore
+
+require 'datadog/tracing'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/grpc/ext'
+require 'datadog/tracing/contrib/grpc/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 analytics_sample_rate
+              datadog_configuration[:analytics_sample_rate]
+            end
+
+            def error_handler
+              datadog_configuration[:error_handler]
+            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/ext.rb

@@ -0,0 +1,23 @@
+# 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_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_COMPONENT = 'grpc'.freeze
+          TAG_OPERATION_CLIENT = 'client'.freeze
+          TAG_OPERATION_SERVICE = 'service'.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require 'datadog/tracing/contrib/integration'
+require 'datadog/tracing/contrib/grpc/configuration/settings'
+require 'datadog/tracing/contrib/grpc/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,38 @@
+# typed: true
+
+require 'datadog/tracing/contrib/grpc/ext'
+require 'datadog/tracing/contrib/grpc/integration'
+require 'datadog/tracing/contrib/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 'datadog/tracing/propagation/grpc'
+            require 'datadog/tracing/contrib/grpc/datadog_interceptor'
+            require 'datadog/tracing/contrib/grpc/intercept_with_datadog'
+
+            prepend_interceptor
+          end
+
+          def prepend_interceptor
+            ::GRPC::InterceptionContext
+              .prepend(InterceptWithDatadog)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# typed: true
+
+require 'datadog/tracing'
+require '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,37 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/http/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, default: Ext::DEFAULT_PEER_SERVICE_NAME
+            option :split_by_domain, default: false
+          end
+        end
+      end
+    end
+  end
+end