ddtrace 0.38.0

data/lib/ddtrace/contrib/graphql/patcher.rb

@@ -0,0 +1,60 @@
+require 'ddtrace/contrib/patcher'
+
+module Datadog
+  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
+          return if get_option(:schemas).nil?
+
+          require 'ddtrace/ext/app_types'
+          require 'ddtrace/ext/http'
+          get_option(:schemas).each { |s| patch_schema!(s) }
+        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 indirectly delegates the tracer instance
+              # to +Datadog.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 indirectly delegates the tracer instance
+                # to +Datadog.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
+
+        def get_option(option)
+          Datadog.configuration[:graphql].get_option(option)
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/configuration/settings.rb

@@ -0,0 +1,25 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      module Configuration
+        # Custom settings for the gRPC integration
+        class Settings < Contrib::Configuration::Settings
+          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::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor.rb

@@ -0,0 +1,74 @@
+require 'ddtrace/ext/app_types'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      # :nodoc:
+      module DatadogInterceptor
+        # :nodoc:
+        class Base < ::GRPC::Interceptor
+          attr_accessor :datadog_pin
+
+          def initialize(options = {})
+            add_datadog_pin! { |c| yield(c) if block_given? }
+          end
+
+          def request_response(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def client_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def server_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          def bidi_streamer(**keywords)
+            trace(keywords) { yield }
+          end
+
+          private
+
+          def add_datadog_pin!
+            Pin.new(
+              service_name,
+              app: Ext::APP,
+              app_type: Datadog::Ext::AppTypes::WEB,
+              tracer: -> { datadog_configuration[:tracer] }
+            ).tap do |pin|
+              yield(pin) if block_given?
+              pin.onto(self)
+            end
+          end
+
+          def datadog_configuration
+            Datadog.configuration[:grpc]
+          end
+
+          def tracer
+            (datadog_pin && datadog_pin.tracer) || datadog_configuration[:tracer]
+          end
+
+          def service_name
+            (datadog_pin && datadog_pin.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
+        end
+
+        require_relative 'datadog_interceptor/client'
+        require_relative 'datadog_interceptor/server'
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor/client.rb

@@ -0,0 +1,54 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  module Contrib
+    module GRPC
+      module DatadogInterceptor
+        # The DatadogInterceptor::Client implements the tracing strategy
+        # for gRPC client-side endpoitns. This middleware compoent 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: Datadog::Ext::HTTP::TYPE_OUTBOUND,
+              service: service_name,
+              resource: format_resource(keywords[:method])
+            }
+
+            tracer.trace(Ext::SPAN_CLIENT, options) do |span|
+              annotate!(span, keywords[:metadata])
+
+              yield
+            end
+          end
+
+          private
+
+          def annotate!(span, metadata)
+            span.set_tags(metadata)
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            Datadog::GRPCPropagator
+              .inject!(span.context, 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
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/datadog_interceptor/server.rb

@@ -0,0 +1,76 @@
+require 'ddtrace/ext/http'
+require 'ddtrace/contrib/analytics'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  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: Datadog::Ext::HTTP::TYPE_INBOUND,
+              service: service_name,
+              resource: format_resource(keywords[:method])
+            }
+            metadata = keywords[:call].metadata
+
+            set_distributed_context!(tracer, metadata)
+
+            tracer.trace(Ext::SPAN_SERVICE, options) do |span|
+              annotate!(span, metadata)
+
+              yield
+            end
+          end
+
+          private
+
+          def set_distributed_context!(tracer, metadata)
+            tracer.provider.context = Datadog::GRPCPropagator
+                                      .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
+
+            # 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
+            [Datadog::Ext::DistributedTracing::GRPC_METADATA_TRACE_ID,
+             Datadog::Ext::DistributedTracing::GRPC_METADATA_PARENT_ID,
+             Datadog::Ext::DistributedTracing::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

data/lib/ddtrace/contrib/grpc/ext.rb

@@ -0,0 +1,15 @@
+module Datadog
+  module Contrib
+    module GRPC
+      # gRPC integration constants
+      module Ext
+        APP = 'grpc'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_GRPC_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_GRPC_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'grpc'.freeze
+        SPAN_CLIENT = 'grpc.client'.freeze
+        SPAN_SERVICE = 'grpc.service'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/integration.rb

@@ -0,0 +1,38 @@
+require 'ddtrace/contrib/integration'
+require 'ddtrace/contrib/grpc/configuration/settings'
+require 'ddtrace/contrib/grpc/patcher'
+
+module Datadog
+  module Contrib
+    module GRPC
+      # Description of gRPC integration
+      class Integration
+        include Contrib::Integration
+
+        MINIMUM_VERSION = Gem::Version.new('1.7.0')
+
+        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 default_configuration
+          Configuration::Settings.new
+        end
+
+        def patcher
+          Patcher
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/intercept_with_datadog.rb

@@ -0,0 +1,49 @@
+require_relative 'datadog_interceptor'
+
+module Datadog
+  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::Contrib::GRPC::DatadogInterceptor::Base)
+          end
+        end
+
+        def choose_datadog_interceptor(args)
+          if args.key?(:metadata)
+            Datadog::Contrib::GRPC::DatadogInterceptor::Client
+          elsif args.key?(:call)
+            Datadog::Contrib::GRPC::DatadogInterceptor::Server
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/grpc/patcher.rb

@@ -0,0 +1,68 @@
+require 'ddtrace/contrib/patcher'
+require 'ddtrace/contrib/grpc/ext'
+
+module Datadog
+  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 'ddtrace/propagation/grpc_propagator'
+          require 'ddtrace/contrib/grpc/datadog_interceptor'
+          require 'ddtrace/contrib/grpc/intercept_with_datadog'
+
+          add_pin!
+
+          prepend_interceptor
+        end
+
+        def add_pin!
+          DeprecatedPin.new(
+            get_option(:service_name),
+            app: Ext::APP,
+            app_type: Datadog::Ext::AppTypes::WEB,
+            tracer: -> { get_option(:tracer) }
+          ).onto(::GRPC)
+        end
+
+        def prepend_interceptor
+          ::GRPC::InterceptionContext
+            .send(:prepend, Datadog::Contrib::GRPC::InterceptWithDatadog)
+        end
+
+        def get_option(option)
+          Datadog.configuration[:grpc].get_option(option)
+        end
+
+        # Implementation of deprecated Pin, which raises warnings when accessed.
+        # To be removed when support for Datadog::Pin with GRPC is removed.
+        class DeprecatedPin < Datadog::Pin
+          include Datadog::DeprecatedPin
+
+          DEPRECATION_WARNING = %(
+            Use of Datadog::Pin with GRPC is DEPRECATED.
+            Upgrade to the configuration API using the migration guide here:
+            https://github.com/DataDog/dd-trace-rb/releases/tag/v0.11.0).freeze
+
+          def service_name=(service_name)
+            Datadog.configuration[:grpc][:service_name] = service_name
+          end
+
+          def log_deprecation_warning(method_name)
+            do_once(method_name) do
+              Datadog.logger.warn("#{method_name}:#{DEPRECATION_WARNING}")
+            end
+          end
+        end
+      end
+    end
+  end
+end