ddtrace 0.54.2 → 1.8.0

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

@@ -0,0 +1,96 @@
+# typed: ignore
+
+require_relative '../../metadata/ext'
+require_relative '../analytics'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Aws
+        # A Seahorse::Client::Plugin that enables instrumentation for all AWS services
+        class Instrumentation < Seahorse::Client::Plugin
+          def add_handlers(handlers, _)
+            handlers.add(Handler, step: :validate)
+          end
+        end
+
+        # Generates Spans for all interactions with AWS
+        class Handler < Seahorse::Client::Handler
+          def call(context)
+            Tracing.trace(Ext::SPAN_COMMAND) do |span|
+              @handler.call(context).tap do
+                annotate!(span, ParsedContext.new(context))
+              end
+            end
+          end
+
+          private
+
+          def annotate!(span, context)
+            span.service = configuration[:service_name]
+            span.span_type = Tracing::Metadata::Ext::HTTP::TYPE_OUTBOUND
+            span.name = Ext::SPAN_COMMAND
+            span.resource = context.safely(:resource)
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_KIND, Tracing::Metadata::Ext::SpanKind::TAG_CLIENT)
+
+            span.set_tag(Tracing::Metadata::Ext::TAG_COMPONENT, Ext::TAG_COMPONENT)
+            span.set_tag(Tracing::Metadata::Ext::TAG_OPERATION, Ext::TAG_OPERATION_COMMAND)
+
+            # 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, context.safely(:host))
+
+            # Set analytics sample rate
+            if Contrib::Analytics.enabled?(configuration[:analytics_enabled])
+              Contrib::Analytics.set_sample_rate(span, configuration[:analytics_sample_rate])
+            end
+            Contrib::Analytics.set_measured(span)
+
+            span.set_tag(Ext::TAG_AGENT, Ext::TAG_DEFAULT_AGENT)
+            span.set_tag(Ext::TAG_OPERATION, context.safely(:operation))
+            span.set_tag(Ext::TAG_REGION, context.safely(:region))
+            span.set_tag(Ext::TAG_PATH, context.safely(:path))
+            span.set_tag(Ext::TAG_HOST, context.safely(:host))
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_METHOD, context.safely(:http_method))
+            span.set_tag(Tracing::Metadata::Ext::HTTP::TAG_STATUS_CODE, context.safely(:status_code))
+          end
+
+          def configuration
+            Datadog.configuration.tracing[:aws]
+          end
+        end
+
+        # Removes API request instrumentation from S3 Presign URL creation.
+        #
+        # This is necessary because the S3 SDK invokes the same handler
+        # stack for presigning as it does for sending a real requests.
+        # But presigning does not perform a network request.
+        # There's not information available for our Handler plugin to differentiate
+        # these two types of requests.
+        #
+        # DEV: Since aws-sdk-s3 1.94.1, we only need to check if
+        # `context[:presigned_url] == true` in Datadog::Tracing::Contrib::Aws::Handler#call
+        # and skip the request if that condition is true. Since there's
+        # no strong reason for us not to support older versions of `aws-sdk-s3`,
+        # this {S3Presigner} monkey-patching is still required.
+        module S3Presigner
+          # Exclude our Handler from the current request's handler stack.
+          #
+          # This is the same approach that the AWS SDK takes to prevent
+          # some of its plugins form interfering with the presigning process:
+          # https://github.com/aws/aws-sdk-ruby/blob/a82c8981c95a8296ffb6269c3c06a4f551d87f7d/gems/aws-sdk-s3/lib/aws-sdk-s3/presigner.rb#L194-L196
+          def sign_but_dont_send(*args, &block)
+            if (request = args[0]).is_a?(::Seahorse::Client::Request)
+              request.handlers.remove(Handler)
+            end
+
+            super(*args, &block)
+          end
+          ruby2_keywords :sign_but_dont_send if respond_to?(:ruby2_keywords, true)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Aws
+        # Description of AWS integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('2.0')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :aws, auto_patch: true
+
+          def self.version
+            if Gem.loaded_specs['aws-sdk']
+              Gem.loaded_specs['aws-sdk'].version
+            elsif Gem.loaded_specs['aws-sdk-core']
+              Gem.loaded_specs['aws-sdk-core'].version
+            end
+          end
+
+          def self.loaded?
+            !defined?(::Seahorse::Client::Base).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/aws/parsed_context.rb

@@ -0,0 +1,60 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Aws
+        # A wrapper around Seahorse::Client::RequestContext
+        class ParsedContext
+          def initialize(context)
+            @context = context
+          end
+
+          def safely(attr, fallback = nil)
+            public_send(attr) rescue fallback
+          end
+
+          def resource
+            "#{service}.#{operation}"
+          end
+
+          def operation
+            context.operation_name
+          end
+
+          def status_code
+            context.http_response.status_code
+          end
+
+          def http_method
+            context.http_request.http_method
+          end
+
+          def region
+            context.client.config.region
+          end
+
+          def retry_attempts
+            context.retries
+          end
+
+          def path
+            context.http_request.endpoint.path
+          end
+
+          def host
+            context.http_request.endpoint.host
+          end
+
+          private
+
+          attr_reader :context
+
+          def service
+            context.client.class.to_s.split('::')[1].downcase
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# typed: false
+
+require_relative '../patcher'
+require_relative 'ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Aws
+        # Patcher enables patching of 'aws' module.
+        module Patcher
+          include Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            require_relative 'parsed_context'
+            require_relative 'instrumentation'
+            require_relative 'services'
+
+            add_plugin(Seahorse::Client::Base, *loaded_constants)
+
+            # Special handling for S3 URL Presigning.
+            # @see Datadog::Tracing::Contrib::Aws::S3Presigner
+            ::Aws::S3::Presigner.prepend(S3Presigner) if defined?(::Aws::S3::Presigner)
+          end
+
+          def add_plugin(*targets)
+            targets.each { |klass| klass.add_plugin(Instrumentation) }
+          end
+
+          def loaded_constants
+            # Cross-check services against loaded AWS constants
+            # Module#const_get can return a constant from ancestors when there's a miss.
+            # If this conincidentally matches another constant, it will attempt to patch
+            # the wrong constant, resulting in patch failure.
+            available_services = ::Aws.constants & SERVICES.map(&:to_sym)
+
+            available_services.each_with_object([]) do |service, constants|
+              next if ::Aws.autoload?(service)
+
+              constants << ::Aws.const_get(service, false).const_get(:Client, false) rescue next
+            end
+          end
+
+          def get_option(option)
+            Datadog.configuration.tracing[:aws].get_option(option)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/aws/services.rb

@@ -0,0 +1,121 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module Aws
+        SERVICES = %w[
+          ACM
+          APIGateway
+          AppStream
+          ApplicationAutoScaling
+          ApplicationDiscoveryService
+          Athena
+          AutoScaling
+          Batch
+          Budgets
+          CloudDirectory
+          CloudFormation
+          CloudFront
+          CloudHSM
+          CloudHSMV2
+          CloudSearch
+          CloudSearchDomain
+          CloudTrail
+          CloudWatch
+          CloudWatchEvents
+          CloudWatchLogs
+          CodeBuild
+          CodeCommit
+          CodeDeploy
+          CodePipeline
+          CodeStar
+          CognitoIdentity
+          CognitoIdentityProvider
+          CognitoSync
+          ConfigService
+          CostandUsageReportService
+          DAX
+          DataPipeline
+          DatabaseMigrationService
+          DeviceFarm
+          DirectConnect
+          DirectoryService
+          DynamoDB
+          DynamoDBStreams
+          EC2
+          ECR
+          ECS
+          EFS
+          EMR
+          ElastiCache
+          ElasticBeanstalk
+          ElasticLoadBalancing
+          ElasticLoadBalancingV2
+          ElasticTranscoder
+          ElasticsearchService
+          EventBridge
+          Firehose
+          GameLift
+          Glacier
+          Glue
+          Greengrass
+          Health
+          IAM
+          ImportExport
+          Inspector
+          IoT
+          IoTDataPlane
+          KMS
+          Kinesis
+          KinesisAnalytics
+          Lambda
+          LambdaPreview
+          Lex
+          LexModelBuildingService
+          Lightsail
+          MTurk
+          MachineLearning
+          MarketplaceCommerceAnalytics
+          MarketplaceEntitlementService
+          MarketplaceMetering
+          MigrationHub
+          Mobile
+          OpsWorks
+          OpsWorksCM
+          Organizations
+          Pinpoint
+          Polly
+          RDS
+          Redshift
+          Rekognition
+          ResourceGroupsTaggingAPI
+          Route53
+          Route53Domains
+          S3
+          SES
+          SMS
+          SNS
+          SQS
+          SSM
+          STS
+          SWF
+          ServiceCatalog
+          Schemas
+          Shield
+          SimpleDB
+          Snowball
+          States
+          StorageGateway
+          Support
+          Textract
+          WAF
+          WAFRegional
+          WorkDocs
+          WorkSpaces
+          XRay
+        ].freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# typed: false
+
+require_relative '../../configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        module Configuration
+          # Custom settings for the ConcurrentRuby integration
+          # @public_api
+          class Settings < Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
+              o.lazy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/concurrent_ruby/context_composite_executor_service.rb

@@ -0,0 +1,53 @@
+# typed: true
+
+require 'concurrent/executor/executor_service'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # wraps existing executor to carry over trace context
+        class ContextCompositeExecutorService
+          include Concurrent::ExecutorService
+
+          attr_accessor :composited_executor
+
+          def initialize(composited_executor)
+            @composited_executor = composited_executor
+          end
+
+          # post method runs the task within composited executor - in a different thread
+          def post(*args, &task)
+            tracer = Tracing.send(:tracer)
+            parent_context = tracer.provider.context
+
+            @composited_executor.post(*args) do
+              begin
+                original_context = tracer.provider.context
+                tracer.provider.context = parent_context
+                yield
+              ensure
+                # Restore context in case the current thread gets reused
+                tracer.provider.context = original_context
+              end
+            end
+          end
+
+          # Respect the {Concurrent::ExecutorService} interface
+          def can_overflow?
+            @composited_executor.can_overflow?
+          end
+
+          # Respect the {Concurrent::ExecutorService} interface
+          def serialized?
+            @composited_executor.serialized?
+          end
+
+          def datadog_configuration
+            Datadog.configuration.tracing[:concurrent_ruby]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# typed: true
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # ConcurrentRuby integration constants
+        # @public_api Changing resource names, tag names, or environment variables creates breaking changes.
+        module Ext
+          APP = 'concurrent-ruby'.freeze
+          ENV_ENABLED = 'DD_TRACE_CONCURRENT_RUBY_ENABLED'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/concurrent_ruby/future_patch.rb

@@ -0,0 +1,27 @@
+# typed: false
+
+require_relative 'context_composite_executor_service'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # This patches the Future - to wrap executor service using ContextCompositeExecutorService
+        module FuturePatch
+          def self.included(base)
+            base.class_eval do
+              alias_method :ns_initialize_without_datadog, :ns_initialize
+              remove_method(:ns_initialize)
+
+              def ns_initialize(value, opts)
+                ns_initialize_without_datadog(value, opts)
+
+                @executor = ContextCompositeExecutorService.new(@executor)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: false
+
+require_relative '../integration'
+require_relative 'patcher'
+require_relative 'configuration/settings'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # Describes the ConcurrentRuby integration
+        class Integration
+          include Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('0.9')
+
+          # @public_api Changing the integration name or integration options can cause breaking changes
+          register_as :concurrent_ruby
+
+          def self.version
+            Gem.loaded_specs['concurrent-ruby'] && Gem.loaded_specs['concurrent-ruby'].version
+          end
+
+          def self.loaded?
+            !defined?(::Concurrent::Future).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/concurrent_ruby/patcher.rb

@@ -0,0 +1,33 @@
+# typed: true
+
+require_relative '../patcher'
+
+module Datadog
+  module Tracing
+    module Contrib
+      module ConcurrentRuby
+        # Patcher enables patching of 'Future' class.
+        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_relative 'future_patch'
+            patch_future
+          end
+
+          # Propagate tracing context in Concurrent::Future
+          def patch_future
+            ::Concurrent::Future.include(FuturePatch)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/tracing/contrib/configurable.rb

@@ -0,0 +1,102 @@
+# typed: true
+
+require_relative 'configuration/resolver'
+require_relative 'configuration/settings'
+
+module Datadog
+  module Tracing
+    module Contrib
+      # Defines configurable behavior for integrations.
+      #
+      # This module is responsible for coordination between
+      # the configuration resolver and default configuration
+      # fallback.
+      module Configurable
+        def self.included(base)
+          base.include(InstanceMethods)
+        end
+
+        # Configurable instance behavior for integrations
+        module InstanceMethods
+          # Get matching configuration by matcher.
+          # If no match, returns the default configuration instance.
+          def configuration(matcher = :default)
+            return default_configuration if matcher == :default
+
+            resolver.get(matcher) || default_configuration
+          end
+
+          # Resolves the matching configuration for integration-specific value.
+          # If no match, returns the default configuration instance.
+          def resolve(value)
+            return default_configuration if value == :default
+
+            resolver.resolve(value) || default_configuration
+          end
+
+          # Returns all registered matchers and their respective configurations.
+          def configurations
+            resolver.configurations.merge(default: default_configuration)
+          end
+
+          # Create or update configuration associated with `matcher` with
+          # the provided `options` and `&block`.
+          def configure(matcher = :default, options = {}, &block)
+            config = if matcher == :default
+                       default_configuration
+                     else
+                       # Get or add the configuration
+                       resolver.get(matcher) || resolver.add(matcher, new_configuration)
+                     end
+
+            # Apply the settings
+            config.configure(options, &block)
+            config
+          end
+
+          # Resets all configuration options
+          def reset_configuration!
+            @resolver = nil
+            @default_configuration = nil
+          end
+
+          # Returns the integration-specific configuration object.
+          #
+          # If one does not exist, invoke {.new_configuration} a memoize
+          # its value.
+          #
+          # @return [Datadog::Tracing::Contrib::Configuration::Settings] the memoized integration-specific settings object
+          def default_configuration
+            @default_configuration ||= new_configuration
+          end
+
+          protected
+
+          # Returns a new configuration object for this integration.
+          #
+          # This method normally needs to be overridden for each integration
+          # as their settings, defaults and environment variables are
+          # specific for each integration.
+          #
+          # @return [Datadog::Tracing::Contrib::Configuration::Settings] a new, integration-specific settings object
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          # Overridable configuration resolver.
+          #
+          # This resolver is responsible for performing the matching
+          # of `#configure(matcher)` `matcher`s with `value`s provided
+          # in subsequent calls to `#resolve(value)`.
+          #
+          # By default, the `value` in `#resolve(value)` must be equal
+          # to the `matcher` object provided in `#configure(matcher)`
+          # to retrieve the associated configuration.
+          def resolver
+            @resolver ||= Configuration::Resolver.new
+          end
+        end
+      end
+    end
+  end
+end