aws-sdk-core 3.202.2 → 3.209.1

data/lib/aws-sdk-core/stubbing.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Aws
+  # setup autoloading for Stubbing module
+  module Stubbing
+    autoload :EmptyStub, 'aws-sdk-core/stubbing/empty_stub'
+    autoload :DataApplicator, 'aws-sdk-core/stubbing/data_applicator'
+    autoload :StubData, 'aws-sdk-core/stubbing/stub_data'
+    autoload :XmlError, 'aws-sdk-core/stubbing/xml_error'
+
+    module Protocols
+      autoload :Json, 'aws-sdk-core/stubbing/protocols/json'
+      autoload :Rest, 'aws-sdk-core/stubbing/protocols/rest'
+      autoload :RestJson, 'aws-sdk-core/stubbing/protocols/rest_json'
+      autoload :RestXml, 'aws-sdk-core/stubbing/protocols/rest_xml'
+      autoload :Query, 'aws-sdk-core/stubbing/protocols/query'
+      autoload :EC2, 'aws-sdk-core/stubbing/protocols/ec2'
+      autoload :RpcV2, 'aws-sdk-core/stubbing/protocols/rpc_v2'
+      autoload :ApiGateway, 'aws-sdk-core/stubbing/protocols/api_gateway'
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry/base.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module Aws
+  module Telemetry
+    # Base for `TelemetryProvider` classes.
+    # They are used to emit telemetry data. It needs the
+    # following class implementations to function:
+    # * {TracerProviderBase} - A provider that returns a tracer
+    #   instance. Then, a tracer will create spans and those
+    #   spans will contain information in that given moment.
+    # * {ContextManagerBase} - Manages context and used to
+    #   return the current context within a trace.
+    class TelemetryProviderBase
+      # @param [Aws::Telemetry::TracerBase] tracer_provider A provider
+      #  that returns a tracer instance.
+      # @param [Aws::Telemetry::ContextManagerBase] context_manager Manages
+      #  context and used to return the current context.
+      def initialize(tracer_provider: nil, context_manager: nil)
+        @tracer_provider = tracer_provider
+        @context_manager = context_manager
+      end
+
+      # @return [Aws::Telemetry::TracerProviderBase]
+      attr_reader :tracer_provider
+
+      # @return [Aws::Telemetry::ContextManagerBase]
+      attr_reader :context_manager
+    end
+
+    # Base for `TracerProvider` classes.
+    class TracerProviderBase
+      # Returns a Tracer instance.
+      #
+      # @param [String] name Tracer name
+      # @return [Aws::Telemetry::TracerBase]
+      def tracer(name = nil)
+        raise NotImplementedError
+      end
+    end
+
+    # Base for `Tracer` classes.
+    class TracerBase
+      # Used when a caller wants to manage the activation/deactivation and
+      # lifecycle of the Span and its parent manually.
+      #
+      # @param [String] name Span name
+      # @param [Object] with_parent Parent Context
+      # @param [Hash] attributes Attributes to attach to the span
+      # @param [Aws::Telemetry::SpanKind] kind Type of Span
+      # @return [Aws::Telemetry::SpanBase]
+      def start_span(name, with_parent: nil, attributes: nil, kind: nil)
+        raise NotImplementedError
+      end
+
+      # A helper for the default use-case of extending the current trace
+      # with a span.
+      # On exit, the Span that was active before calling this method will
+      # be reactivated. If an exception occurs during the execution of the
+      # provided block, it will be recorded on the span and re-raised.
+      #
+      # @param [String] name Span name
+      # @param [Hash] attributes Attributes to attach to the span
+      # @param [Aws::Telemetry::SpanKind] kind Type of Span
+      # @return [Aws::Telemetry::SpanBase]
+      def in_span(name, attributes: nil, kind: nil)
+        raise NotImplementedError
+      end
+
+      # Returns the current active span.
+      #
+      # @return [Aws::Telemetry::SpanBase]
+      def current_span
+        raise NotImplementedError
+      end
+    end
+
+    # Base for `Span` classes.
+    class SpanBase
+      # Set attribute.
+      #
+      # @param [String] key
+      # @param [String, Boolean, Numeric, Array<String, Numeric, Boolean>] value
+      #   Value must be non-nil and (array of) string, boolean or numeric type.
+      #   Array values must not contain nil elements and all elements must be of
+      #   the same basic type (string, numeric, boolean)
+      # @return [self] returns itself
+      def set_attribute(key, value)
+        raise NotImplementedError
+      end
+      alias []= set_attribute
+
+      # Add attributes.
+      #
+      # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric,
+      #   Boolean>}] attributes Values must be non-nil and (array of) string,
+      #   boolean or numeric type. Array values must not contain nil elements
+      #   and all elements must be of the same basic type (string, numeric,
+      #   boolean)
+      # @return [self] returns itself
+      def add_attributes(attributes)
+        raise NotImplementedError
+      end
+
+      # Add event to a Span.
+      #
+      # @param [String] name Name of the event
+      # @param [Hash{String => String, Numeric, Boolean, Array<String,
+      #   Numeric, Boolean>}] attributes Values must be non-nil and (array of)
+      #   string, boolean or numeric type. Array values must not contain nil
+      #   elements and all elements must be of the same basic type (string,
+      #   numeric, boolean)
+      # @return [self] returns itself
+      def add_event(name, attributes: nil)
+        raise NotImplementedError
+      end
+
+      # Sets the Span status.
+      #
+      # @param [Aws::Telemetry::SpanStatus] status The new status, which
+      #   overrides the default Span status, which is `OK`
+      # @return [void]
+      def status=(status)
+        raise NotImplementedError
+      end
+
+      # Finishes the Span.
+      #
+      # @param [Time] end_timestamp End timestamp for the span.
+      # @return [self] returns itself
+      def finish(end_timestamp: nil)
+        raise NotImplementedError
+      end
+
+      # Record an exception during the execution of this span. Multiple
+      # exceptions can be recorded on a span.
+      #
+      # @param [Exception] exception The exception to be recorded
+      # @param [Hash{String => String, Numeric, Boolean, Array<String,
+      #   Numeric, Boolean>}] attributes One or more key:value pairs, where the
+      #   keys must be strings and the values may be (array of) string, boolean
+      #   or numeric type.
+      # @return [void]
+      def record_exception(exception, attributes: nil)
+        raise NotImplementedError
+      end
+    end
+
+    # Base for all `ContextManager` classes.
+    class ContextManagerBase
+      # Returns current context.
+      #
+      # @return [Context]
+      def current
+        raise NotImplementedError
+      end
+
+      # Associates a Context with the caller’s current execution unit.
+      # Returns a token to be used with the matching call to detach.
+      #
+      # @param [Object] context The new context
+      # @return [Object] token A token to be used when detaching
+      def attach(context)
+        raise NotImplementedError
+      end
+
+      # Restore the previous Context associated with the current
+      # execution unit to the value it had before attaching a
+      # specified Context.
+      #
+      # @param [Object] token The token provided by matching the call to attach
+      # @return [Boolean] `True` if the calls matched, `False` otherwise
+      def detach(token)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry/no_op.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Aws
+  module Telemetry
+    # No-op implementation for {TelemetryProviderBase}.
+    class NoOpTelemetryProvider < TelemetryProviderBase
+      def initialize
+        super(
+          tracer_provider: NoOpTracerProvider.new,
+          context_manager: NoOpContextManager.new
+        )
+      end
+    end
+
+    # No-op implementation for {TracerProviderBase}.
+    class NoOpTracerProvider < TracerProviderBase
+      def tracer(name = nil)
+        @tracer ||= NoOpTracer.new
+      end
+    end
+
+    # No-op implementation for {TracerBase}.
+    class NoOpTracer < TracerBase
+      def start_span(name, with_parent: nil, attributes: nil, kind: nil)
+        NoOpSpan.new
+      end
+
+      def in_span(name, attributes: nil, kind: nil)
+        yield NoOpSpan.new
+      end
+
+      def current_span
+        NoOpSpan.new
+      end
+    end
+
+    # No-op implementation for {SpanBase}.
+    class NoOpSpan < SpanBase
+      def set_attribute(key, value)
+        self
+      end
+      alias []= set_attribute
+
+      def add_attributes(attributes)
+        self
+      end
+
+      def add_event(name, attributes: nil)
+        self
+      end
+
+      def status=(status); end
+
+      def finish(end_timestamp: nil)
+        self
+      end
+
+      def record_exception(exception, attributes: nil); end
+    end
+
+    # No-op implementation for {ContextManagerBase}.
+    class NoOpContextManager < ContextManagerBase
+      def current; end
+
+      def attach(context); end
+
+      def detach(token); end
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry/otel.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Aws
+  module Telemetry
+    # OTelProvider allows to emit telemetry data based on OpenTelemetry.
+    #
+    # To use this provider, require the `opentelemetry-sdk` gem and then,
+    # pass in an instance of a `Aws::Telemetry::OTelProvider` as the
+    # telemetry provider in the client config.
+    #
+    # @example Configuration
+    #     require 'opentelemetry-sdk'
+    #
+    #     # sets up the OpenTelemetry SDK with their config defaults
+    #     OpenTelemetry::SDK.configure
+    #
+    #     otel_provider = Aws::Telemetry::OTelProvider.new
+    #     client = Aws::S3::Client.new(telemetry_provider: otel_provider)
+    #
+    # OpenTelemetry supports many ways to export your telemetry data.
+    # See {https://opentelemetry.io/docs/languages/ruby/exporters here} for
+    # more information.
+    #
+    # @example Exporting via console
+    #     require 'opentelemetry-sdk'
+    #
+    #     ENV['OTEL_TRACES_EXPORTER'] ||= 'console'
+    #
+    #     # configures the OpenTelemetry SDK with defaults
+    #     OpenTelemetry::SDK.configure
+    #
+    #     otel_provider = Aws::Telemetry::OTelProvider.new
+    #     client = Aws::S3::Client.new(telemetry_provider: otel_provider)
+    class OTelProvider < TelemetryProviderBase
+      def initialize
+        unless otel_loaded?
+          raise ArgumentError,
+                'Requires the `opentelemetry-sdk` gem to use OTel Provider.'
+        end
+        super(
+          tracer_provider: OTelTracerProvider.new,
+          context_manager: OTelContextManager.new
+        )
+      end
+
+      private
+
+      def otel_loaded?
+        if @use_otel.nil?
+          @use_otel =
+            begin
+              require 'opentelemetry-sdk'
+              true
+            rescue LoadError, NameError
+              false
+            end
+        end
+        @use_otel
+      end
+    end
+
+    # OpenTelemetry-based {TracerProviderBase}, an entry point for
+    # creating Tracer instances.
+    class OTelTracerProvider < TracerProviderBase
+      def initialize
+        super
+        @tracer_provider = OpenTelemetry.tracer_provider
+      end
+
+      # Returns a Tracer instance.
+      #
+      # @param [optional String] name Tracer name
+      # @return [Aws::Telemetry::OTelTracer]
+      def tracer(name = nil)
+        OTelTracer.new(@tracer_provider.tracer(name))
+      end
+    end
+
+    # OpenTelemetry-based {TracerBase}, responsible for creating spans.
+    class OTelTracer < TracerBase
+      def initialize(tracer)
+        super()
+        @tracer = tracer
+      end
+
+      # Used when a caller wants to manage the activation/deactivation and
+      # lifecycle of the Span and its parent manually.
+      #
+      # @param [String] name Span name
+      # @param [Object] with_parent Parent Context
+      # @param [Hash] attributes Attributes to attach to the span
+      # @param [Aws::Telemetry::SpanKind] kind Type of Span
+      # @return [Aws::Telemetry::OTelSpan]
+      def start_span(name, with_parent: nil, attributes: nil, kind: nil)
+        span = @tracer.start_span(
+          name,
+          with_parent: with_parent,
+          attributes: attributes,
+          kind: kind
+        )
+        OTelSpan.new(span)
+      end
+
+      # A helper for the default use-case of extending the current trace
+      # with a span.
+      # On exit, the Span that was active before calling this method will
+      # be reactivated. If an exception occurs during the execution of the
+      # provided block, it will be recorded on the span and re-raised.
+      #
+      # @param [String] name Span name
+      # @param [Hash] attributes Attributes to attach to the span
+      # @param [Aws::Telemetry::SpanKind] kind Type of Span
+      # @return [Aws::Telemetry::OTelSpan]
+      def in_span(name, attributes: nil, kind: nil, &block)
+        @tracer.in_span(name, attributes: attributes, kind: kind) do |span|
+          block.call(OTelSpan.new(span))
+        end
+      end
+
+      # Returns the current active span.
+      #
+      # @return [Aws::Telemetry::OTelSpan]
+      def current_span
+        OTelSpan.new(OpenTelemetry::Trace.current_span)
+      end
+    end
+
+    # OpenTelemetry-based {SpanBase}, represents a single operation
+    # within a trace.
+    class OTelSpan < SpanBase
+      def initialize(span)
+        super()
+        @span = span
+      end
+
+      # Set attribute.
+      #
+      # @param [String] key
+      # @param [String, Boolean, Numeric, Array<String, Numeric, Boolean>] value
+      #   Value must be non-nil and (array of) string, boolean or numeric type.
+      #   Array values must not contain nil elements and all elements must be of
+      #   the same basic type (string, numeric, boolean)
+      # @return [self] returns itself
+      def set_attribute(key, value)
+        @span.set_attribute(key, value)
+      end
+      alias []= set_attribute
+
+      # Add attributes.
+      #
+      # @param [Hash{String => String, Numeric, Boolean, Array<String, Numeric,
+      #   Boolean>}] attributes Values must be non-nil and (array of) string,
+      #   boolean or numeric type. Array values must not contain nil elements
+      #   and all elements must be of the same basic type (string, numeric,
+      #   boolean)
+      # @return [self] returns itself
+      def add_attributes(attributes)
+        @span.add_attributes(attributes)
+      end
+
+      # Add event to a Span.
+      #
+      # @param [String] name Name of the event
+      # @param [Hash{String => String, Numeric, Boolean, Array<String,
+      #   Numeric, Boolean>}] attributes Values must be non-nil and (array of)
+      #   string, boolean or numeric type. Array values must not contain nil
+      #   elements and all elements must be of the same basic type (string,
+      #   numeric, boolean)
+      # @return [self] returns itself
+      def add_event(name, attributes: nil)
+        @span.add_event(name, attributes: attributes)
+      end
+
+      # Sets the Span status.
+      #
+      # @param [Aws::Telemetry::Status] status The new status, which
+      #   overrides the default Span status, which is `OK`
+      # @return [void]
+      def status=(status)
+        @span.status = status
+      end
+
+      # Finishes the Span.
+      #
+      # @param [Time] end_timestamp End timestamp for the span
+      # @return [self] returns itself
+      def finish(end_timestamp: nil)
+        @span.finish(end_timestamp: end_timestamp)
+      end
+
+      # Record an exception during the execution of this span. Multiple
+      # exceptions can be recorded on a span.
+      #
+      # @param [Exception] exception The exception to be recorded
+      # @param [Hash{String => String, Numeric, Boolean, Array<String,
+      #   Numeric, Boolean>}] attributes One or more key:value pairs, where the
+      #   keys must be strings and the values may be (array of) string, boolean
+      #   or numeric type
+      # @return [void]
+      def record_exception(exception, attributes: nil)
+        @span.record_exception(exception, attributes: attributes)
+      end
+    end
+
+    # OpenTelemetry-based {ContextManagerBase}, manages context and
+    # used to return the current context within a trace.
+    class OTelContextManager < ContextManagerBase
+      # Returns current context.
+      #
+      # @return [Context]
+      def current
+        OpenTelemetry::Context.current
+      end
+
+      # Associates a Context with the caller’s current execution unit.
+      # Returns a token to be used with the matching call to detach.
+      #
+      # @param [Context] context The new context
+      # @return [Object] token A token to be used when detaching
+      def attach(context)
+        OpenTelemetry::Context.attach(context)
+      end
+
+      # Restore the previous Context associated with the current
+      # execution unit to the value it had before attaching a
+      # specified Context.
+      #
+      # @param [Object] token The token provided by matching the call to attach
+      # @return [Boolean] `True` if the calls matched, `False` otherwise
+      def detach(token)
+        OpenTelemetry::Context.detach(token)
+      end
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry/span_kind.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Aws
+  module Telemetry
+    module SpanKind
+      # Default. Represents an internal operation within an application.
+      INTERNAL = :internal
+
+      # Represents handling synchronous network requests.
+      SERVER = :server
+
+      # Represents a request to some remote service.
+      CLIENT = :client
+
+      # Represents a child of an asynchronous `PRODUCER` request.
+      CONSUMER = :consumer
+
+      # Represents an asynchronous request.
+      PRODUCER = :producer
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry/span_status.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Aws
+  module Telemetry
+    # Represents the status of a finished span.
+    class SpanStatus
+      class << self
+        private :new
+
+        # Returns a newly created {SpanStatus} with code, `UNSET`
+        # and an optional description.
+        #
+        # @param [optional String] description
+        # @return [SpanStatus]
+        def unset(description = '')
+          new(UNSET, description: description)
+        end
+
+        # Returns a newly created {SpanStatus} with code, `OK`
+        # and an optional description.
+        #
+        # @param [optional String] description
+        # @return [SpanStatus]
+        def ok(description = '')
+          new(OK, description: description)
+        end
+
+        # Returns a newly created {SpanStatus} with code, `ERROR`
+        # and an optional description.
+        #
+        # @param [optional String] description
+        # @return [SpanStatus]
+        def error(description = '')
+          new(ERROR, description: description)
+        end
+      end
+
+      def initialize(code, description: '')
+        @code = code
+        @description = description
+      end
+
+      # @return [Integer] code
+      attr_reader :code
+
+      # @return [String] description
+      attr_reader :description
+
+      # The operation completed successfully.
+      OK = 0
+
+      # The default status.
+      UNSET = 1
+
+      # An error.
+      ERROR = 2
+    end
+  end
+end

data/lib/aws-sdk-core/telemetry.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'telemetry/base'
+require_relative 'telemetry/no_op'
+require_relative 'telemetry/otel'
+require_relative 'telemetry/span_kind'
+require_relative 'telemetry/span_status'
+
+module Aws
+  # Observability is the extent to which a system's current state can be
+  # inferred from the data it emits. The data emitted is commonly referred
+  # as Telemetry. The AWS SDK for Ruby currently supports traces as
+  # a telemetry signal.
+  #
+  # A telemetry provider is used to emit telemetry data. By default, the
+  # {NoOpTelemetryProvider} will not record or emit any telemetry data.
+  # The SDK currently supports OpenTelemetry (OTel) as a provider. See
+  # {OTelProvider} for more information.
+  #
+  # If a provider isn't supported, you can implement your own provider by
+  # inheriting the following base classes and implementing the interfaces
+  # defined:
+  # * {TelemetryProviderBase}
+  # * {ContextManagerBase}
+  # * {TracerProviderBase}
+  # * {TracerBase}
+  # * {SpanBase}
+  module Telemetry
+    class << self
+      # @api private
+      def module_to_tracer_name(module_name)
+        "#{module_name.gsub('::', '.')}.client".downcase
+      end
+
+      # @api private
+      def http_request_attrs(context)
+        {
+          'http.method' => context.http_request.http_method,
+          'net.protocol.name' => 'http'
+        }.tap do |h|
+          h['net.protocol.version'] =
+            if context.client.is_a? Seahorse::Client::AsyncBase
+              '2'
+            else
+              Net::HTTP::HTTPVersion
+            end
+
+          unless context.config.stub_responses
+            h['net.peer.name'] = context.http_request.endpoint.host
+            h['net.peer.port'] = context.http_request.endpoint.port.to_s
+          end
+
+          if context.http_request.headers.key?('Content-Length')
+            h['http.request_content_length'] =
+              context.http_request.headers['Content-Length']
+          end
+        end
+      end
+
+      # @api private
+      def http_response_attrs(context)
+        {
+          'http.status_code' => context.http_response.status_code.to_s
+        }.tap do |h|
+          if context.http_response.headers.key?('Content-Length')
+            h['http.response_content_length'] =
+              context.http_response.headers['Content-Length']
+          end
+
+          if context.http_response.headers.key?('x-amz-request-id')
+            h['aws.request_id'] =
+              context.http_response.headers['x-amz-request-id']
+          end
+        end
+      end
+    end
+  end
+end