opentelemetry-instrumentation-aws_sdk 0.9.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d042cf96a48a860701f9dacde39e897805cbd5ae893f33825602c387a4d0fd6
-  data.tar.gz: '019efe3b866f2f2cef4351d296fb75f4b4fbb646cca5fb6d5ab37c19a7d9ad25'
+  metadata.gz: 2d8d6a60aa5e88f724d0603667942f03ae96a736baf3ab09c6e80e9184a8b966
+  data.tar.gz: 22d7c6114027fb52442485ce2ed69dcdec39b04bda7744af03036730533b923e
 SHA512:
-  metadata.gz: 77c2fcaa0ed74675bdb27f364218fdff5a723e40efefbfd8cc05f8aca1e2db7614b2d1c126d7b972c7c030b7d2800fd941a6a46401634d0fe66f103520063e6e
-  data.tar.gz: 8a1054b1214809bfbb6552ac08fe5cb438fa0e31e9ab48492bf5104e39f6416cffeef71edf9d5937e498233bacf33960e51019ee769068c31b43a8c2aebb6350
+  metadata.gz: 68443901421bc079239cf84756ff7270b0c04b64ffe11f11df701b5cab0e842b5060ba377e466cb68be1b40bff691a324c9122756b467717cd425a1846631914
+  data.tar.gz: 7341155bc2e033c56dd705e4d40cdaa811fb976b2aab23623739157d7215604b061c68c07fbd1a8b0acc6e7fef9bf3803f6bbc6989ad0dac85454a839077b5b7

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History: opentelemetry-instrumentation-aws_sdk
 
+### v0.11.0 / 2025-10-22
+
+* BREAKING CHANGE: Min Ruby Version 3.2
+
+* ADDED: Min Ruby Version 3.2
+
+### v0.10.0 / 2025-10-11
+
+* BREAKING CHANGE: Suppress internal spans by default
+
+* ADDED: Suppress internal spans by default
+
 ### v0.9.1 / 2025-09-30
 
 * FIXED: Min OTel Ruby API 1.7

data/README.md

@@ -20,7 +20,7 @@ To install the instrumentation, call `use` with the name of the instrumentation.
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::AwsSdk', {
     inject_messaging_context: true,
-    suppress_internal_instrumentation: true
+	enable_internal_instrumentation: true
   }
 end
 ```
@@ -36,8 +36,10 @@ end
 This instrumentation offers the following configuration options: 
 * `:inject_messaging_context` (default: `false`): When set to `true`, adds context key/value 
  to Message Attributes for SQS/SNS messages.
-* `suppress_internal_instrumentation` (default: `false`): When set to `true`, any spans with 
- span kind of `internal` are suppressed from traces.
+* `:enable_internal_instrumentation` (default: `false`): When set to `true`, any spans with 
+ span kind of `internal` are traced.
+* `:suppress_internal_instrumentation`: **Deprecated**. This configuration has been
+ deprecated in favor of `:enable_internal_instrumentation`
 
 ## Integration with SDK V3's Telemetry support
 AWS SDK for Ruby V3 added support for Observability which includes a new configuration, 

data/lib/opentelemetry/instrumentation/aws_sdk/handler.rb

@@ -23,7 +23,7 @@ module OpenTelemetry
           ) do |span|
             MessagingHelper.inject_context_if_supported(context, client_method, service_id)
 
-            if HandlerHelper.instrumentation_config[:suppress_internal_instrumentation]
+            if HandlerHelper.skip_internal_instrumentation?
               OpenTelemetry::Common::Utilities.untraced { super }
             else
               super
@@ -32,7 +32,6 @@ module OpenTelemetry
                 OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE,
                 context.http_response.status_code
               )
-
               if (err = response.error)
                 span.record_exception(err)
                 span.status = Trace::Status.error(err.to_s)

data/lib/opentelemetry/instrumentation/aws_sdk/handler_helper.rb

@@ -14,6 +14,10 @@ module OpenTelemetry
             AwsSdk::Instrumentation.instance.config
           end
 
+          def skip_internal_instrumentation?
+            instrumentation_config[:enable_internal_instrumentation] == false
+          end
+
           def client_method(service_id, context)
             "#{service_id}.#{context.operation.name}".delete(' ')
           end

data/lib/opentelemetry/instrumentation/aws_sdk/instrumentation.rb

@@ -19,24 +19,27 @@ module OpenTelemetry
       # - `false` **(default)** - Context key/value will not be added.
       # - `true` - Context key/value will be added.
       #
-      # ### `:suppress_internal_instrumentation`
+      # ### `:enable_internal_instrumentation`
+      # Enables tracing of spans of `internal` span kind.
       #
-      # Disables tracing of spans of `internal` span kind.
+      # - `false` **(default)** - Internal spans are not traced
+      # - `true` - Internal spans are traced.
       #
-      # - `false` **(default)** - Internal spans are traced.
-      # - `true` - Internal spans are not traced.
+      # ### `:suppress_internal_instrumentation` (deprecated)
+      # This configuration has been deprecated in favor of `:enable_internal_instrumentation`
       #
       # @example An explicit default configuration
       #   OpenTelemetry::SDK.configure do |c|
       #     c.use 'OpenTelemetry::Instrumentation::AwsSdk', {
       #       inject_messaging_context: false,
-      #       suppress_internal_instrumentation: false
+      #       enable_internal_instrumentation: false
       #     }
       #   end
       class Instrumentation < OpenTelemetry::Instrumentation::Base
         MINIMUM_VERSION = Gem::Version.new('2.0.0')
 
-        install do |_config|
+        install do |config|
+          resolve_config(config)
           require_dependencies
           patch_telemetry_plugin if telemetry_plugin?
           add_plugins(Seahorse::Client::Base, *loaded_service_clients)
@@ -52,6 +55,7 @@ module OpenTelemetry
 
         option :inject_messaging_context, default: false, validate: :boolean
         option :suppress_internal_instrumentation, default: false, validate: :boolean
+        option :enable_internal_instrumentation, default: false, validate: :boolean
 
         def gem_version
           if Gem.loaded_specs['aws-sdk']
@@ -65,6 +69,15 @@ module OpenTelemetry
 
         private
 
+        def resolve_config(config)
+          return unless config[:suppress_internal_instrumentation]
+
+          OpenTelemetry.logger.warn(
+            'Instrumentation AwsSdk configuration option suppress_internal_instrumentation has been deprecated,' \
+            'use enable_internal_instrumentation option instead'
+          )
+        end
+
         def require_dependencies
           require_relative 'handler'
           require_relative 'handler_helper'
@@ -92,7 +105,7 @@ module OpenTelemetry
 
         # Patches AWS SDK V3's telemetry plugin for integration
         # This patch supports configuration set by this gem and
-        # additional span attributes that was not provided by the plugin
+        # additional span attributes that were not provided by the plugin
         def patch_telemetry_plugin
           ::Aws::Plugins::Telemetry::Handler.prepend(Patches::Handler)
         end
@@ -112,7 +125,7 @@ module OpenTelemetry
 
         # This check does the following:
         # 1 - Checks if the service client is autoload or not
-        # 2 - Validates whether if is a service client
+        # 2 - Validates whether it is a service client
         # note that Seahorse::Client::Base is a superclass for V3 clients
         # but for V2, it is Aws::Client
         # rubocop:disable Style/MultipleComparison

data/lib/opentelemetry/instrumentation/aws_sdk/patches/telemetry.rb

@@ -26,7 +26,7 @@ module OpenTelemetry
             ) do |span|
               MessagingHelper.inject_context_if_supported(context, client_method, service_id)
 
-              if HandlerHelper.instrumentation_config[:suppress_internal_instrumentation]
+              if HandlerHelper.skip_internal_instrumentation?
                 OpenTelemetry::Common::Utilities.untraced { super }
               else
                 yield span

data/lib/opentelemetry/instrumentation/aws_sdk/version.rb

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.9.1'
+      VERSION = '0.11.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-aws_sdk
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.11.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-01 00:00:00.000000000 Z
+date: 2025-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-base
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.24'
+        version: '0.25'
 description: AWS SDK instrumentation for the OpenTelemetry framework
 email:
 - cncf-opentelemetry-contributors@lists.cncf.io
@@ -49,10 +49,10 @@ homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.9.1/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.11.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/aws_sdk
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.9.1
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.11.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -61,14 +61,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework