ls-trace 0.1.1

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

@@ -0,0 +1,73 @@
+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::Tracer.log.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?
+          rescue StandardError => e
+            Datadog::Tracer.log.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,36 @@
+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
+
+        register_as :grpc, auto_patch: true
+
+        def self.version
+          Gem.loaded_specs['grpc'] && Gem.loaded_specs['grpc'].version
+        end
+
+        def self.present?
+          super && defined?(::GRPC)
+        end
+
+        def self.compatible?
+          super && version >= Gem::Version.new('0.10.0')
+        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,78 @@
+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 patched?
+          done?(:grpc)
+        end
+
+        def patch
+          do_once(:grpc) do
+            begin
+              require 'ddtrace/propagation/grpc_propagator'
+              require 'ddtrace/contrib/grpc/datadog_interceptor'
+              require 'ddtrace/contrib/grpc/intercept_with_datadog'
+
+              add_pin!
+
+              prepend_interceptor
+            rescue StandardError => e
+              Datadog::Tracer.log.error("Unable to apply gRPC integration: #{e}")
+            end
+          end
+        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 tracer=(tracer)
+            Datadog.configuration[:grpc][:tracer] = tracer
+          end
+
+          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::Tracer.log.warn("#{method_name}:#{DEPRECATION_WARNING}")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/http/circuit_breaker.rb

@@ -0,0 +1,63 @@
+module Datadog
+  module Contrib
+    module HTTP
+      # HTTP integration circuit breaker behavior
+      # For avoiding recursive traces.
+      module CircuitBreaker
+        def should_skip_tracing?(req, address, port, tracer)
+          return true if datadog_http_request?(req, address, port, tracer)
+
+          # we don't want a "shotgun" effect with two nested traces for one
+          # logical get, and request is likely to call itself recursively
+          active = tracer.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 coupling with the transport.
+        #       Remove this when transport implements its own "skip tracing" mechanism.
+        def datadog_http_request?(req, address, port, tracer)
+          transport = tracer.writer.transport
+
+          transport_hostname = nil
+          transport_port = nil
+
+          # Get settings from transport, if available.
+          case transport
+          when Datadog::Transport::HTTP::Client
+            adapter = transport.current_api.adapter
+            if adapter.is_a?(Datadog::Transport::HTTP::Adapters::Net)
+              transport_hostname = adapter.hostname.to_s
+              transport_port = adapter.port.to_i
+            end
+          end
+
+          # When we know the host & port (from the URI) we use it, else (most-likely
+          # called with a block) rely on the URL at the end.
+          if req.respond_to?(:uri) && req.uri
+            if req.uri.host.to_s == transport_hostname &&
+               req.uri.port.to_i == transport_port
+              return true
+            end
+          elsif address && port &&
+                address.to_s == transport_hostname &&
+                port.to_i == transport_port
+            return true
+          end
+
+          false
+        end
+
+        def should_skip_distributed_tracing?(pin)
+          if pin.config && pin.config.key?(:distributed_tracing)
+            return !pin.config[:distributed_tracing]
+          end
+
+          !Datadog.configuration[:http][:distributed_tracing]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'ddtrace/contrib/http/ext'
+
+module Datadog
+  module Contrib
+    module HTTP
+      module Configuration
+        # Custom settings for the HTTP 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 :distributed_tracing, default: true
+          option :service_name, default: Ext::SERVICE_NAME
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Datadog
+  module Contrib
+    module HTTP
+      # HTTP integration constants
+      module Ext
+        APP = 'net/http'.freeze
+        ENV_ANALYTICS_ENABLED = 'DD_HTTP_ANALYTICS_ENABLED'.freeze
+        ENV_ANALYTICS_SAMPLE_RATE = 'DD_HTTP_ANALYTICS_SAMPLE_RATE'.freeze
+        SERVICE_NAME = 'net/http'.freeze
+        SPAN_REQUEST = 'http.request'.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/contrib/http/instrumentation.rb

@@ -0,0 +1,114 @@
+require 'uri'
+require 'ddtrace/pin'
+require 'ddtrace/ext/app_types'
+require 'ddtrace/ext/http'
+require 'ddtrace/ext/net'
+require 'ddtrace/ext/distributed'
+require 'ddtrace/contrib/analytics'
+
+module Datadog
+  module Contrib
+    module HTTP
+      # Instrumentation for Net::HTTP
+      module Instrumentation
+        def self.included(base)
+          base.send(:prepend, InstanceMethods)
+        end
+
+        # Span hook invoked after request is completed.
+        def self.after_request(&block)
+          if block_given?
+            # Set hook
+            @after_request = block
+          else
+            # Get hook
+            @after_request ||= nil
+          end
+        end
+
+        # InstanceMethods - implementing instrumentation
+        module InstanceMethods
+          def request(req, body = nil, &block) # :yield: +response+
+            pin = datadog_pin
+            return super(req, body, &block) unless pin && pin.tracer
+
+            if Datadog::Contrib::HTTP.should_skip_tracing?(req, @address, @port, pin.tracer)
+              return super(req, body, &block)
+            end
+
+            pin.tracer.trace(Ext::SPAN_REQUEST) do |span|
+              begin
+                span.service = pin.service
+                span.span_type = Datadog::Ext::HTTP::TYPE_OUTBOUND
+                span.resource = req.method
+
+                if pin.tracer.enabled && !Datadog::Contrib::HTTP.should_skip_distributed_tracing?(pin)
+                  Datadog::HTTPPropagator.inject!(span.context, req)
+                end
+              rescue StandardError => e
+                Datadog::Tracer.log.error("error preparing span for http request: #{e}")
+              ensure
+                response = super(req, body, &block)
+              end
+
+              # Add additional tags to the span.
+              annotate_span!(span, req, response)
+
+              # 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!(span, request, response)
+            span.set_tag(Datadog::Ext::HTTP::URL, request.path)
+            span.set_tag(Datadog::Ext::HTTP::METHOD, request.method)
+            span.set_tag(Datadog::Ext::HTTP::STATUS_CODE, response.code)
+
+            if request.respond_to?(:uri) && request.uri
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, request.uri.host)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, request.uri.port.to_s)
+            else
+              span.set_tag(Datadog::Ext::NET::TARGET_HOST, @address)
+              span.set_tag(Datadog::Ext::NET::TARGET_PORT, @port.to_s)
+            end
+
+            # Set analytics sample rate
+            Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+            case response.code.to_i
+            when 400...599
+              span.set_error(response)
+            end
+          end
+
+          def datadog_pin
+            @datadog_pin ||= begin
+              service = Datadog.configuration[:http][:service_name]
+              tracer = Datadog.configuration[:http][:tracer]
+
+              Datadog::Pin.new(service, app: Ext::APP, app_type: Datadog::Ext::AppTypes::WEB, tracer: tracer)
+            end
+          end
+
+          private
+
+          def datadog_configuration
+            Datadog.configuration[:http]
+          end
+
+          def analytics_enabled?
+            Contrib::Analytics.enabled?(datadog_configuration[:analytics_enabled])
+          end
+
+          def analytics_sample_rate
+            datadog_configuration[:analytics_sample_rate]
+          end
+        end
+      end
+    end
+  end
+end