datadog 2.4.0 → 2.44.0

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../../../core'
-require_relative '../../../core/telemetry/logger'
-require_relative '../../metadata/ext'
-require_relative '../analytics'
-require_relative '../rack/ext'
+require_relative "../../../core"
+require_relative "../../../core/telemetry/logger"
+require_relative "../../metadata/ext"
+require_relative "../analytics"
+require_relative "../rack/ext"
 
 module Datadog
   module Tracing
@@ -13,25 +13,26 @@ module Datadog
         # Endpoint module includes a list of subscribers to create
         # traces when a Grape endpoint is hit
         module Endpoint
-          KEY_RUN = 'datadog_grape_endpoint_run'
-          KEY_RENDER = 'datadog_grape_endpoint_render'
+          KEY_RUN = "datadog_grape_endpoint_run"
+          KEY_RENDER = "datadog_grape_endpoint_render"
+          FORMAT_SEGMENT = /\(\.:?\w+\)\z/
 
           class << self
             def subscribe
               # subscribe when a Grape endpoint is hit
-              ::ActiveSupport::Notifications.subscribe('endpoint_run.grape.start_process') do |*args|
+              ::ActiveSupport::Notifications.subscribe("endpoint_run.grape.start_process") do |*args|
                 endpoint_start_process(*args)
               end
-              ::ActiveSupport::Notifications.subscribe('endpoint_run.grape') do |*args|
+              ::ActiveSupport::Notifications.subscribe("endpoint_run.grape") do |*args|
                 endpoint_run(*args)
               end
-              ::ActiveSupport::Notifications.subscribe('endpoint_render.grape.start_render') do |*args|
+              ::ActiveSupport::Notifications.subscribe("endpoint_render.grape.start_render") do |*args|
                 endpoint_start_render(*args)
               end
-              ::ActiveSupport::Notifications.subscribe('endpoint_render.grape') do |*args|
+              ::ActiveSupport::Notifications.subscribe("endpoint_render.grape") do |*args|
                 endpoint_render(*args)
               end
-              ::ActiveSupport::Notifications.subscribe('endpoint_run_filters.grape') do |*args|
+              ::ActiveSupport::Notifications.subscribe("endpoint_run_filters.grape") do |*args|
                 endpoint_run_filters(*args)
               end
             end
@@ -43,8 +44,8 @@ module Datadog
               # collect endpoint details
               endpoint = payload.fetch(:endpoint)
               env = payload.fetch(:env)
-              api_view = api_view(endpoint.options[:for])
-              request_method = endpoint.options.fetch(:method).first
+              api_view = api_view(endpoint_api(endpoint))
+              request_method = endpoint_request_method(endpoint)
               path = endpoint_expand_path(endpoint)
               resource = "#{api_view} #{request_method} #{path}"
 
@@ -62,22 +63,27 @@ module Datadog
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENDPOINT_RUN)
+              span.set_tag(Tracing::Metadata::Ext::TAG_SVC_SRC, Ext::TAG_COMPONENT)
 
-              if (grape_route = env['grape.routing_args']) && grape_route[:route_info]
+              if (grape_route = env["grape.routing_args"]) && grape_route[:route_info]
+                route_info = grape_route[:route_info]
+                # Grape 2.3 through 3.0 return nil from GreedyRoute#path; the
+                # path lives at pattern.path in those versions.
+                route_path = route_info.path || route_info.pattern&.path
                 trace.set_tag(
                   Tracing::Metadata::Ext::HTTP::TAG_ROUTE,
                   # here we are removing the format from the path:
                   # e.g. /path/to/resource(.json) => /path/to/resource
                   # e.g. /path/to/resource(.:format) => /path/to/resource
-                  grape_route[:route_info].path&.gsub(/\(\.:?\w+\)\z/, '')
+                  route_path&.gsub(FORMAT_SEGMENT, "")
                 )
 
-                trace.set_tag(Tracing::Metadata::Ext::HTTP::TAG_ROUTE_PATH, env['SCRIPT_NAME'])
+                trace.set_tag(Tracing::Metadata::Ext::HTTP::TAG_ROUTE_PATH, env["SCRIPT_NAME"])
               end
 
               Thread.current[KEY_RUN] = true
-            rescue StandardError => e
-              Datadog.logger.error(e.message)
+            rescue => e
+              Datadog.logger.error("#{e.class}: #{e.message}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 
@@ -95,8 +101,8 @@ module Datadog
               begin
                 # collect endpoint details
                 endpoint = payload.fetch(:endpoint)
-                api_view = api_view(endpoint.options[:for])
-                request_method = endpoint.options.fetch(:method).first
+                api_view = api_view(endpoint_api(endpoint))
+                request_method = endpoint_request_method(endpoint)
                 path = endpoint_expand_path(endpoint)
 
                 trace.resource = span.resource
@@ -120,8 +126,8 @@ module Datadog
                 span.start(start)
                 span.finish(finish)
               end
-            rescue StandardError => e
-              Datadog.logger.error(e.message)
+            rescue => e
+              Datadog.logger.error("#{e.class}: #{e.message}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 
@@ -162,10 +168,11 @@ module Datadog
 
               span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
               span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_ENDPOINT_RENDER)
+              span.set_tag(Tracing::Metadata::Ext::TAG_SVC_SRC, Ext::TAG_COMPONENT)
 
               Thread.current[KEY_RENDER] = true
-            rescue StandardError => e
-              Datadog.logger.error(e.message)
+            rescue => e
+              Datadog.logger.error("#{e.class}: #{e.message}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 
@@ -189,8 +196,8 @@ module Datadog
                 span.start(start)
                 span.finish(finish)
               end
-            rescue StandardError => e
-              Datadog.logger.error(e.message)
+            rescue => e
+              Datadog.logger.error("#{e.class}: #{e.message}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 
@@ -213,6 +220,7 @@ module Datadog
               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)
+                span.set_tag(Tracing::Metadata::Ext::TAG_SVC_SRC, Ext::TAG_COMPONENT)
 
                 # Set analytics sample rate
                 Contrib::Analytics.set_sample_rate(span, analytics_sample_rate) if analytics_enabled?
@@ -228,8 +236,8 @@ module Datadog
                 span.start(start)
                 span.finish(finish)
               end
-            rescue StandardError => e
-              Datadog.logger.error(e.message)
+            rescue => e
+              Datadog.logger.error("#{e.class}: #{e.message}")
               Datadog::Core::Telemetry::Logger.report(e)
             end
 
@@ -253,22 +261,47 @@ module Datadog
             end
 
             def api_view(api)
-              # If the API inherits from Grape::API in version >= 1.2.0
+              # If the API inherits from Grape::API in version >= 1.2.0 and version <= 2.3.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
+              if defined?(::Grape::API::Instance) && api <= ::Grape::API::Instance && api.respond_to?(:base)
                 api.base.to_s
               else
                 api.to_s
               end
             end
 
+            # Grape 4 moved three values off the endpoint's public options Hash: the
+            # API class became the #api reader (ruby-grape/grape#2778), and the verb
+            # and path are read off the route (#2775, #2776). Each reader prefers the
+            # options Hash, so Grape 1.x through 3.x resolve as they did before.
+            def endpoint_api(endpoint)
+              endpoint.options.fetch(:for) { endpoint.api }
+            end
+
+            def endpoint_request_method(endpoint)
+              request_methods = endpoint.options[:method]
+              return request_methods.first if request_methods
+
+              endpoint.routes.first&.request_method
+            end
+
             def endpoint_expand_path(endpoint)
               route_path = endpoint.options[:path]
-              namespace = endpoint.routes.first && endpoint.routes.first.namespace || ''
+              return endpoint_route_path(endpoint) if route_path.nil? || route_path.empty?
+
+              namespace = endpoint.routes.first&.namespace || ""
+
+              path = (namespace.split("/") + route_path)
+                .reject { |p| p.blank? || p.eql?("/") }
+                .join("/")
+              path.prepend("/") if path[0] != "/"
+              path
+            end
 
-              parts = (namespace.split('/') + route_path).reject { |p| p.blank? || p.eql?('/') }
-              parts.join('/').prepend('/')
+            # A compiled path already carries the namespace, so it is used whole.
+            def endpoint_route_path(endpoint)
+              endpoint.routes.first&.path&.sub(FORMAT_SEGMENT, "") || "/"
             end
 
             def service_name
@@ -294,11 +327,11 @@ module Datadog
               matcher = datadog_configuration[:error_statuses]
               return true unless matcher
 
-              matcher.include?(status) if matcher
+              matcher&.include?(status)
             end
 
             def enabled?
-              Datadog.configuration.tracing.enabled && \
+              Datadog.configuration.tracing.enabled &&
                 datadog_configuration[:enabled] == true
             end
 

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

@@ -7,22 +7,22 @@ module Datadog
         # Grape integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_GRAPE_ENABLED'
+          ENV_ENABLED = "DD_TRACE_GRAPE_ENABLED"
           # @!visibility private
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPE_ANALYTICS_ENABLED'
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE'
-          ENV_ERROR_STATUS_CODES = 'DD_TRACE_GRAPE_ERROR_STATUS_CODES'
-          SPAN_ENDPOINT_RENDER = 'grape.endpoint_render'
-          SPAN_ENDPOINT_RUN = 'grape.endpoint_run'
-          SPAN_ENDPOINT_RUN_FILTERS = 'grape.endpoint_run_filters'
-          TAG_COMPONENT = 'grape'
-          TAG_FILTER_TYPE = 'grape.filter.type'
-          TAG_OPERATION_ENDPOINT_RENDER = 'endpoint_render'
-          TAG_OPERATION_ENDPOINT_RUN = 'endpoint_run'
-          TAG_OPERATION_ENDPOINT_RUN_FILTERS = 'endpoint_run_filters'
-          TAG_ROUTE_ENDPOINT = 'grape.route.endpoint'
-          TAG_ROUTE_PATH = 'grape.route.path'
-          TAG_ROUTE_METHOD = 'grape.route.method'
+          ENV_ANALYTICS_ENABLED = "DD_TRACE_GRAPE_ANALYTICS_ENABLED"
+          ENV_ANALYTICS_SAMPLE_RATE = "DD_TRACE_GRAPE_ANALYTICS_SAMPLE_RATE"
+          ENV_ERROR_STATUS_CODES = "DD_TRACE_GRAPE_ERROR_STATUS_CODES"
+          SPAN_ENDPOINT_RENDER = "grape.endpoint_render"
+          SPAN_ENDPOINT_RUN = "grape.endpoint_run"
+          SPAN_ENDPOINT_RUN_FILTERS = "grape.endpoint_run_filters"
+          TAG_COMPONENT = "grape"
+          TAG_FILTER_TYPE = "grape.filter.type"
+          TAG_OPERATION_ENDPOINT_RENDER = "endpoint_render"
+          TAG_OPERATION_ENDPOINT_RUN = "endpoint_run"
+          TAG_OPERATION_ENDPOINT_RUN_FILTERS = "endpoint_run_filters"
+          TAG_ROUTE_ENDPOINT = "grape.route.endpoint"
+          TAG_ROUTE_PATH = "grape.route.path"
+          TAG_ROUTE_METHOD = "grape.route.method"
         end
       end
     end

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

@@ -6,27 +6,32 @@ module Datadog
       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
+          # GenerateApiMethodPatch - class method instrumentation for endpoint render (Grape < 3.0.0)
+          module GenerateApiMethodPatch
             def generate_api_method(*params, &block)
               method_api = super
 
               proc do |*args|
-                ::ActiveSupport::Notifications.instrument('endpoint_render.grape.start_render')
+                ::ActiveSupport::Notifications.instrument("endpoint_render.grape.start_render")
                 method_api.call(*args)
               end
             end
           end
 
-          # InstanceMethods - implementing instrumentation
+          # ExecutePatch - instance method instrumentation for endpoint render (Grape >= 3.0.0)
+          module ExecutePatch
+            def execute(*args)
+              return unless @source
+
+              ::ActiveSupport::Notifications.instrument("endpoint_render.grape.start_render")
+              super
+            end
+          end
+
+          # InstanceMethods - instance method instrumentation for endpoint run
           module InstanceMethods
             def run(*args)
-              ::ActiveSupport::Notifications.instrument('endpoint_run.grape.start_process', endpoint: self, env: env)
+              ::ActiveSupport::Notifications.instrument("endpoint_run.grape.start_process", endpoint: self, env: env)
               super
             end
           end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../integration'
-require_relative 'configuration/settings'
-require_relative 'patcher'
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
 
 module Datadog
   module Tracing
@@ -12,13 +12,13 @@ module Datadog
         class Integration
           include Contrib::Integration
 
-          MINIMUM_VERSION = Gem::Version.new('1.0')
+          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
+            Gem.loaded_specs["grape"]&.version
           end
 
           def self.loaded?

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'endpoint'
-require_relative 'ext'
-require_relative 'instrumentation'
-require_relative '../patcher'
+require_relative "endpoint"
+require_relative "ext"
+require_relative "instrumentation"
+require_relative "../patcher"
 
 module Datadog
   module Tracing
@@ -21,7 +21,12 @@ module Datadog
 
           def patch
             # Patch endpoints
-            ::Grape::Endpoint.include(Instrumentation)
+            ::Grape::Endpoint.prepend(Instrumentation::InstanceMethods)
+            if target_version < Gem::Version.new("3.0.0")
+              ::Grape::Endpoint.singleton_class.prepend(Instrumentation::GenerateApiMethodPatch)
+            else
+              ::Grape::Endpoint.prepend(Instrumentation::ExecutePatch)
+            end
 
             # Subscribe to ActiveSupport events
             Endpoint.subscribe

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module GraphQL
+        module Configuration
+          # Parses the environment variable `DD_TRACE_GRAPHQL_ERROR_EXTENSIONS` for error extension names declaration.
+          class ErrorExtensionEnvParser
+            # Parses the environment variable `DD_TRACE_GRAPHQL_ERROR_EXTENSIONS` into an array of error extension names.
+            def self.call(values)
+              # Split by comma, remove leading and trailing whitespaces,
+              # remove empty values, and remove repeated values.
+              values.split(",").each(&:strip!).reject(&:empty?).uniq
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../../configuration/settings'
-require_relative '../ext'
+require_relative "../../configuration/settings"
+require_relative "../ext"
+require_relative "error_extension_env_parser"
 
 module Datadog
   module Tracing
@@ -44,6 +45,23 @@ module Datadog
             end
 
             option :with_unified_tracer do |o|
+              o.env Ext::ENV_WITH_UNIFIED_TRACER
+              o.type :bool
+              o.default false
+            end
+
+            # Capture error extensions provided by the user in their GraphQL error responses.
+            # The extensions can be anything, so the user is responsible for ensuring they are safe to capture.
+            option :error_extensions do |o|
+              o.env Ext::ENV_ERROR_EXTENSIONS
+              o.type :array, nilable: false
+              o.default []
+              o.env_parser { |v| ErrorExtensionEnvParser.call(v) }
+            end
+
+            # Surface GraphQL errors in Error Tracking.
+            option :error_tracking do |o|
+              o.env Ext::ENV_ERROR_TRACKING
               o.type :bool
               o.default false
             end

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

@@ -7,12 +7,18 @@ module Datadog
         # GraphQL integration constants
         # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
         module Ext
-          ENV_ENABLED = 'DD_TRACE_GRAPHQL_ENABLED'
+          ENV_ENABLED = "DD_TRACE_GRAPHQL_ENABLED"
           # @!visibility private
-          ENV_ANALYTICS_ENABLED = 'DD_TRACE_GRAPHQL_ANALYTICS_ENABLED'
-          ENV_ANALYTICS_SAMPLE_RATE = 'DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE'
-          SERVICE_NAME = 'graphql'
-          TAG_COMPONENT = 'graphql'
+          ENV_ANALYTICS_ENABLED = "DD_TRACE_GRAPHQL_ANALYTICS_ENABLED"
+          ENV_ANALYTICS_SAMPLE_RATE = "DD_TRACE_GRAPHQL_ANALYTICS_SAMPLE_RATE"
+          ENV_WITH_UNIFIED_TRACER = "DD_TRACE_GRAPHQL_WITH_UNIFIED_TRACER"
+          ENV_ERROR_EXTENSIONS = "DD_TRACE_GRAPHQL_ERROR_EXTENSIONS"
+          ENV_ERROR_TRACKING = "DD_TRACE_GRAPHQL_ERROR_TRACKING"
+          SERVICE_NAME = "graphql"
+          TAG_COMPONENT = "graphql"
+
+          # Span event name for query-level errors
+          EVENT_QUERY_ERROR = "dd.graphql.query.error"
         end
       end
     end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative '../integration'
-require_relative 'configuration/settings'
-require_relative 'patcher'
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
 
 module Datadog
   module Tracing
@@ -16,7 +16,7 @@ module Datadog
           register_as :graphql, auto_patch: true
 
           def self.version
-            Gem.loaded_specs['graphql'] && Gem.loaded_specs['graphql'].version
+            Gem.loaded_specs["graphql"]&.version
           end
 
           def self.loaded?
@@ -31,15 +31,15 @@ module Datadog
           #
           def self.compatible?
             super && (
-              (version >= Gem::Version.new('1.13.21') && version < Gem::Version.new('2.0')) ||
-              (version >= Gem::Version.new('2.0.28') && version < Gem::Version.new('2.1')) ||
-              (version >= Gem::Version.new('2.1.11') && version < Gem::Version.new('2.2')) ||
-              (version >= Gem::Version.new('2.2.6'))
+              (version >= Gem::Version.new("1.13.21") && version < Gem::Version.new("2.0")) ||
+              (version >= Gem::Version.new("2.0.28") && version < Gem::Version.new("2.1")) ||
+              (version >= Gem::Version.new("2.1.11") && version < Gem::Version.new("2.2")) ||
+              (version >= Gem::Version.new("2.2.6"))
             )
           end
 
           def self.trace_supported?
-            version >= Gem::Version.new('2.0.19')
+            version >= Gem::Version.new("2.0.19")
           end
 
           def new_configuration

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative '../analytics'
-require_relative '../patcher'
-require_relative 'tracing_patcher'
-require_relative 'trace_patcher'
-require_relative 'unified_trace_patcher'
+require_relative "../analytics"
+require_relative "../patcher"
+require_relative "tracing_patcher"
+require_relative "trace_patcher"
+require_relative "unified_trace_patcher"
 
 module Datadog
   module Tracing
@@ -36,9 +36,9 @@ module Datadog
               end
             else
               Datadog.logger.warn(
-                "GraphQL version (#{target_version}) does not support GraphQL::Tracing::DataDogTrace"\
-                'or Datadog::Tracing::Contrib::GraphQL::UnifiedTrace.'\
-                'Falling back to GraphQL::Tracing::DataDogTracing.'
+                "GraphQL version (#{target_version}) does not support GraphQL::Tracing::DataDogTrace" \
+                "or Datadog::Tracing::Contrib::GraphQL::UnifiedTrace." \
+                "Falling back to GraphQL::Tracing::DataDogTracing."
               )
               TracingPatcher.patch!(schemas)
             end