ddtrace 0.54.1 → 1.0.0.beta2

data/lib/datadog/tracing/contrib/faraday/middleware.rb

@@ -0,0 +1,93 @@
+# typed: ignore
+
+require 'faraday'
+
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/propagation/http'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/faraday/ext'
+require 'datadog/tracing/contrib/http_annotation_helper'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Middleware implements a faraday-middleware for ddtrace instrumentation
+        class Middleware < ::Faraday::Middleware
+          include Contrib::HttpAnnotationHelper
+
+          def initialize(app, options = {})
+            super(app)
+            @options = options
+          end
+
+          def call(env)
+            # Resolve configuration settings to use for this request.
+            # Do this once to reduce expensive regex calls.
+            request_options = build_request_options!(env)
+
+            Tracing.trace(Ext::SPAN_REQUEST) do |span, trace|
+              annotate!(span, env, request_options)
+              propagate!(trace, span, env) if request_options[:distributed_tracing] && Tracing.enabled?
+              app.call(env).on_complete { |resp| handle_response(span, resp, request_options) }
+            end
+          end
+
+          private
+
+          attr_reader :app
+
+          def annotate!(span, env, options)
+            span.resource = resource_name(env)
+            service_name(env[:url].host, options)
+            span.service = options[:split_by_domain] ? env[:url].host : options[:service_name]
+            span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+            span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_REQUEST)
+
+            # Tag as an external peer service
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_SERVICE, span.service)
+            span.set_tag(Tracing::Metadata::Ext::TAG_PEER_HOSTNAME, env[:url].host)
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(options[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, options[:analytics_sample_rate])
+            end
+
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, env[:url].path)
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, env[:method].to_s.upcase)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_HOST, env[:url].host)
+            span.set_tag(Tracing::Metadata::Ext::NET::TAG_TARGET_PORT, env[:url].port)
+          end
+
+          def handle_response(span, env, options)
+            span.set_error(["Error #{env[:status]}", env[:body]]) if options.fetch(:error_handler).call(env)
+
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, env[:status])
+          end
+
+          def propagate!(trace, span, env)
+            Tracing::Propagation::HTTP.inject!(trace, env[:request_headers])
+          end
+
+          def resource_name(env)
+            env[:method].to_s.upcase
+          end
+
+          def build_request_options!(env)
+            datadog_configuration
+              .options_hash # integration level settings
+              .merge(datadog_configuration(env[:url].host).options_hash) # per-host override
+              .merge(@options) # middleware instance override
+          end
+
+          def datadog_configuration(host = :default)
+            Datadog.configuration.tracing[:faraday, host]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# typed: false
+
+require 'datadog/tracing/contrib/faraday/connection'
+require 'datadog/tracing/contrib/faraday/ext'
+require 'datadog/tracing/contrib/faraday/integration'
+require 'datadog/tracing/contrib/faraday/rack_builder'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Patcher enables patching of 'faraday' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require 'datadog/tracing/contrib/faraday/middleware'
+
+            register_middleware!
+            add_default_middleware!
+          end
+
+          def register_middleware!
+            ::Faraday::Middleware.register_middleware(ddtrace: Middleware)
+          end
+
+          def add_default_middleware!
+            if target_version >= Gem::Version.new('1.0.0')
+              # Patch the default connection (e.g. +Faraday.get+)
+              ::Faraday.default_connection.use(:ddtrace)
+
+              # Patch new connection instances (e.g. +Faraday.new+)
+              ::Faraday::Connection.prepend(Connection)
+            else
+              # Patch the default connection (e.g. +Faraday.get+)
+              #
+              # We insert our middleware before the 'adapter', which is
+              # always the last handler.
+              idx = ::Faraday.default_connection.builder.handlers.size - 1
+              ::Faraday.default_connection.builder.insert(idx, Middleware)
+
+              # Patch new connection instances (e.g. +Faraday.new+)
+              ::Faraday::RackBuilder.prepend(RackBuilder)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/faraday/rack_builder.rb

@@ -0,0 +1,22 @@
+# typed: false
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Faraday
+        # Handles installation of our middleware if the user has *not*
+        # already explicitly configured it for this correction.
+        #
+        # RackBuilder class was introduced in faraday 0.9.0:
+        # https://github.com/lostisland/faraday/commit/77d7546d6d626b91086f427c56bc2cdd951353b3
+        module RackBuilder
+          def adapter(*args)
+            use(:ddtrace) unless @handlers.any? { |h| h.klass == Middleware }
+
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/grape/ext'
+require 'datadog/tracing/contrib/status_code_matcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        module Configuration
+          # Custom settings for the Grape 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, nil) }
+              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
+
+            option :error_statuses, default: nil do |o|
+              o.setter do |new_value, _old_value|
+                Contrib::StatusCodeMatcher.new(new_value) unless new_value.nil?
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/grape/endpoint.rb

@@ -0,0 +1,253 @@
+# typed: false
+
+require 'datadog/core'
+require 'datadog/tracing'
+require 'datadog/tracing/metadata/ext'
+require 'datadog/tracing/contrib/analytics'
+require 'datadog/tracing/contrib/rack/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        # rubocop:disable Metrics/ModuleLength
+        # Endpoint module includes a list of subscribers to create
+        # traces when a Grape endpoint is hit
+        module Endpoint
+          KEY_RUN = 'datadog_grape_endpoint_run'.freeze
+          KEY_RENDER = 'datadog_grape_endpoint_render'.freeze
+
+          class << self
+            def subscribe
+              # subscribe when a Grape endpoint is hit
+              ::ActiveSupport::Notifications.subscribe('endpoint_run.grape.start_process') do |*args|
+                endpoint_start_process(*args)
+              end
+              ::ActiveSupport::Notifications.subscribe('endpoint_run.grape') do |*args|
+                endpoint_run(*args)
+              end
+              ::ActiveSupport::Notifications.subscribe('endpoint_render.grape.start_render') do |*args|
+                endpoint_start_render(*args)
+              end
+              ::ActiveSupport::Notifications.subscribe('endpoint_render.grape') do |*args|
+                endpoint_render(*args)
+              end
+              ::ActiveSupport::Notifications.subscribe('endpoint_run_filters.grape') do |*args|
+                endpoint_run_filters(*args)
+              end
+            end
+
+            def endpoint_start_process(_name, _start, _finish, _id, payload)
+              return if Thread.current[KEY_RUN]
+              return unless enabled?
+
+              # collect endpoint details
+              endpoint = payload.fetch(:endpoint)
+              api_view = api_view(endpoint.options[:for])
+              request_method = endpoint.options.fetch(:method).first
+              path = endpoint_expand_path(endpoint)
+              resource = "#{api_view} #{request_method} #{path}"
+
+              # Store the beginning of a trace
+              span = Tracing.trace(
+                Ext::SPAN_ENDPOINT_RUN,
+                service: service_name,
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
+                resource: resource
+              )
+              trace = Tracing.active_trace
+
+              # Set the trace resource
+              trace.resource = span.resource
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENDPOINT_RUN)
+
+              Thread.current[KEY_RUN] = true
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def endpoint_run(name, start, finish, id, payload)
+              return unless Thread.current[KEY_RUN]
+
+              Thread.current[KEY_RUN] = false
+
+              return unless enabled?
+
+              trace = Tracing.active_trace
+              span = Tracing.active_span
+              return unless trace && span
+
+              begin
+                # collect endpoint details
+                endpoint = payload.fetch(:endpoint)
+                api_view = api_view(endpoint.options[:for])
+                request_method = endpoint.options.fetch(:method).first
+                path = endpoint_expand_path(endpoint)
+
+                trace.resource = span.resource
+
+                # Set analytics sample rate
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+                # Measure service stats
+                Contrib::Analytics.set_measured(span)
+
+                # catch thrown exceptions
+
+                span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
+
+                # override the current span with this notification values
+                span.set_tag(Ext::TAG_ROUTE_ENDPOINT, api_view) unless api_view.nil?
+                span.set_tag(Ext::TAG_ROUTE_PATH, path)
+                span.set_tag(Ext::TAG_ROUTE_METHOD, request_method)
+
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, request_method)
+                span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_URL, path)
+              ensure
+                span.start(start)
+                span.finish(finish)
+              end
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def endpoint_start_render(*)
+              return if Thread.current[KEY_RENDER]
+              return unless enabled?
+
+              # Store the beginning of a trace
+              span = Tracing.trace(
+                Ext::SPAN_ENDPOINT_RENDER,
+                service: service_name,
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_TEMPLATE
+              )
+
+              span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+              span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENDPOINT_RENDER)
+
+              Thread.current[KEY_RENDER] = true
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def endpoint_render(name, start, finish, id, payload)
+              return unless Thread.current[KEY_RENDER]
+
+              Thread.current[KEY_RENDER] = false
+
+              return unless enabled?
+
+              span = Tracing.active_span
+              return unless span
+
+              # catch thrown exceptions
+              begin
+                # Measure service stats
+                Contrib::Analytics.set_measured(span)
+
+                span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
+              ensure
+                span.start(start)
+                span.finish(finish)
+              end
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            def endpoint_run_filters(name, start, finish, id, payload)
+              return unless enabled?
+
+              # safe-guard to prevent submitting empty filters
+              zero_length = (finish - start).zero?
+              filters = payload[:filters]
+              type = payload[:type]
+              return if (!filters || filters.empty?) || !type || zero_length
+
+              span = Tracing.trace(
+                Ext::SPAN_ENDPOINT_RUN_FILTERS,
+                service: service_name,
+                span_type: Tracing::Metadata::Ext::HTTP::TYPE_INBOUND,
+                start_time: start
+              )
+
+              begin
+                span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+                span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENDPOINT_RUN_FILTERS)
+
+                # Set analytics sample rate
+                Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
+
+                # Measure service stats
+                Contrib::Analytics.set_measured(span)
+
+                # catch thrown exceptions
+                span.set_error(payload[:exception_object]) if exception_is_error?(payload[:exception_object])
+
+                span.set_tag(Ext::TAG_FILTER_TYPE, type.to_s)
+              ensure
+                span.start(start)
+                span.finish(finish)
+              end
+            rescue StandardError => e
+              Datadog.logger.error(e.message)
+            end
+
+            private
+
+            def api_view(api)
+              # If the API inherits from Grape::API in version >= 1.2.0
+              # then the API will be an instance and the name must be derived from the base.
+              # See https://github.com/ruby-grape/grape/issues/1825
+              if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance
+                api.base.to_s
+              else
+                api.to_s
+              end
+            end
+
+            def endpoint_expand_path(endpoint)
+              route_path = endpoint.options[:path]
+              namespace = endpoint.routes.first && endpoint.routes.first.namespace || ''
+
+              parts = (namespace.split('/') + route_path).reject { |p| p.blank? || p.eql?('/') }
+              parts.join('/').prepend('/')
+            end
+
+            def 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 exception_is_error?(exception)
+              matcher = datadog_configuration[:error_statuses]
+              return false unless exception
+              return true unless matcher
+              return true unless exception.respond_to?('status')
+
+              matcher.include?(exception.status)
+            end
+
+            def enabled?
+              Datadog.configuration.tracing.enabled && \
+                datadog_configuration[:enabled] == true
+            end
+
+            def datadog_configuration
+              Datadog.configuration.tracing[:grape]
+            end
+          end
+        end
+        # rubocop:enable Metrics/ModuleLength
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        # Grape integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          ENV_ENABLED = 'DD_TRACE_GRAPE_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'.freeze
+          SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'.freeze
+          SPAN_ENDPOINT_RUN = 'grape.endpoint_run'.freeze
+          SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'.freeze
+          TAG_COMPONENT = 'grape'.freeze
+          TAG_FILTER_TYPE = 'grape.filter.type'.freeze
+          TAG_OPERATION_ENDPOINT_RENDER = 'endpoint_render'.freeze
+          TAG_OPERATION_ENDPOINT_RUN = 'endpoint_run'.freeze
+          TAG_OPERATION_ENDPOINT_RUN_FILTERS = 'endpoint_run_filters'.freeze
+          TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'.freeze
+          TAG_ROUTE_PATH = 'grape.route.path'.freeze
+          TAG_ROUTE_METHOD = 'grape.route.method'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/grape/instrumentation.rb

@@ -0,0 +1,37 @@
+# typed: false
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        # Instrumentation for Grape::Endpoint
+        module Instrumentation
+          def self.included(base)
+            base.singleton_class.prepend(ClassMethods)
+            base.prepend(InstanceMethods)
+          end
+
+          # ClassMethods - implementing instrumentation
+          module ClassMethods
+            def generate_api_method(*params, &block)
+              method_api = super
+
+              proc do |*args|
+                ::ActiveSupport::Notifications.instrument('endpoint_render.grape.start_render')
+                method_api.call(*args)
+              end
+            end
+          end
+
+          # InstanceMethods - implementing instrumentation
+          module InstanceMethods
+            def run(*args)
+              ::ActiveSupport::Notifications.instrument('endpoint_run.grape.start_process', endpoint: self, env: env)
+              super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,34 @@
+# typed: true
+
+require 'datadog/tracing/contrib/grape/endpoint'
+require 'datadog/tracing/contrib/grape/ext'
+require 'datadog/tracing/contrib/grape/instrumentation'
+require 'datadog/tracing/contrib/grape/integration'
+require 'datadog/tracing/contrib/patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Grape
+        # Patcher enables patching of 'grape' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            # Patch endpoints
+            ::Grape::Endpoint.include(Instrumentation)
+
+            # Subscribe to ActiveSupport events
+            Endpoint.subscribe
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# typed: false
+
+require 'datadog/tracing/contrib/configuration/settings'
+require 'datadog/tracing/contrib/graphql/ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GraphQL
+        module Configuration
+          # Custom settings for the GraphQL 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, nil) }
+              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 :schemas
+            option :service_nam
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GraphQL
+        # GraphQL integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          APP = 'ruby-graphql'.freeze
+          ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'.freeze
+          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'.freeze
+          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'.freeze
+          SERVICE_NAME = 'ruby-graphql'.freeze
+        end
+      end
+    end
+  end
+end