opentelemetry-instrumentation-aws_sdk 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85fcbab6e35379902d9ff9d2bcb50f9676ea0a1cffbc861c507a36fefa83e1cc
-  data.tar.gz: b922cfc56f13ddf9876c7168158199ebf9cd07b64e8717fa5309f6cf3f525145
+  metadata.gz: 05256cef329eccec85d4d6732b402aa9c1be08fa39da455cee3ed43d4b0ed9c7
+  data.tar.gz: d4f05d032386bdbabfb064e051757a02fc27b75947594bb89211b311abb54446
 SHA512:
-  metadata.gz: 262b4f67c08bf114d01c39e572ad28cf54f518c5147133cdb78bb26c6de71c63feeb649a516aa5e847d7d85e3dea39f50c80b323051591a38c28001df6d0e215
-  data.tar.gz: 6084a2f559ab16135b7aadbccc267b353e6cab1f9db5106b23913d4763ae29ba95cf5ec1acb951248e906fc5868d6cf7abc5b13ca6361367cb9e4efef7e1b23f
+  metadata.gz: 7dada29094deea482504658785d9b13ce16d2e8d4198d0c08b64c378618cda70d30744ece8a0b59a12df3a39f18a23ca9f93c1b3186ea51e53e4a6c03e887127
+  data.tar.gz: 379d073b4f1d46dce866fdd15a85677cc7f436b82c608a40731f4a716222fda9b3774fecf0264679046f79b1cf71179398a7c555c7815f8f35e5ce461784eb73

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release History: opentelemetry-instrumentation-aws_sdk
 
+### v0.6.0 / 2024-09-19
+
+* ADDED: All AWS services emit traces
+
+### v0.5.4 / 2024-07-23
+
+* DOCS: Add cspell to CI
+
 ### v0.5.3 / 2024-07-02
 
 * DOCS: Fix CHANGELOGs to reflect a past breaking change
@@ -10,7 +18,7 @@
 
 ### v0.5.1 / 2024-02-08
 
-* FIXED: Return nil for non-existant key in AwsSdk::MessageAttributeGetter
+* FIXED: Return nil for non-existent key in AwsSdk::MessageAttributeGetter
 
 ### v0.5.0 / 2023-09-07
 

data/README.md

@@ -6,7 +6,7 @@ The OpenTelemetry `aws-sdk` gem is a community maintained instrumentation for [a
 
 Install the gem using:
 
-```
+```console
 gem install opentelemetry-instrumentation-aws_sdk
 ```
 
@@ -49,7 +49,7 @@ This will run SNS publish command, printing OpenTelemetry traces to the console
 
 The `opentelemetry-instrumentation-aws_sdk` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
 
-The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
+The OpenTelemetry Ruby gems are maintained by the OpenTelemetry Ruby special interest group (SIG). You can get involved by joining us on our [GitHub Discussions][discussions-url], [Slack Channel][slack-channel] or attending our weekly meeting. See the [meeting calendar][community-meetings] for dates and times. For more information on this and other language SIGs, see the OpenTelemetry [community page][ruby-sig].
 
 ## License
 
@@ -61,4 +61,5 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [license-github]: https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/LICENSE
 [ruby-sig]: https://github.com/open-telemetry/community#ruby-sig
 [community-meetings]: https://github.com/open-telemetry/community#community-meetings
+[slack-channel]: https://cloud-native.slack.com/archives/C01NWKKMKMY
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions

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

@@ -9,36 +9,32 @@ module OpenTelemetry
     module AwsSdk
       # Generates Spans for all interactions with AwsSdk
       class Handler < Seahorse::Client::Handler
-        SQS_SEND_MESSAGE = 'SQS.SendMessage'
-        SQS_SEND_MESSAGE_BATCH = 'SQS.SendMessageBatch'
-        SQS_RECEIVE_MESSAGE = 'SQS.ReceiveMessage'
-        SNS_PUBLISH = 'SNS.Publish'
-
         def call(context)
           return super unless context
 
-          service_name = service_name(context)
+          service_id = service_name(context)
           operation = context.operation&.name
-          client_method = "#{service_name}.#{operation}"
-          attributes = {
-            'aws.region' => context.config.region,
-            OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'aws-api',
-            OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => operation,
-            OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service_name
-          }
-          attributes[SemanticConventions::Trace::DB_SYSTEM] = 'dynamodb' if service_name == 'DynamoDB'
-          MessagingHelper.apply_sqs_attributes(attributes, context, client_method) if service_name == 'SQS'
-          MessagingHelper.apply_sns_attributes(attributes, context, client_method) if service_name == 'SNS'
+          client_method = "#{service_id}.#{operation}"
+
+          tracer.in_span(
+            span_name(context, client_method, service_id),
+            attributes: attributes(context, client_method, service_id, operation),
+            kind: span_kind(client_method, service_id)
+          ) do |span|
+            if instrumentation_config[:inject_messaging_context] &&
+               %w[SQS SNS].include?(service_id)
+              MessagingHelper.inject_context(context, client_method)
+            end
 
-          tracer.in_span(span_name(context, client_method), attributes: attributes, kind: span_kind(client_method)) do |span|
-            inject_context(context, client_method)
             if instrumentation_config[:suppress_internal_instrumentation]
               OpenTelemetry::Common::Utilities.untraced { super }
             else
               super
             end.tap do |response|
-              span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE,
-                                 context.http_response.status_code)
+              span.set_attribute(
+                OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE,
+                context.http_response.status_code
+              )
 
               if (err = response.error)
                 span.record_exception(err)
@@ -65,48 +61,40 @@ module OpenTelemetry
           context.client.class.api.metadata['serviceId'] || context.client.class.to_s.split('::')[1]
         end
 
-        SEND_MESSAGE_CLIENT_METHODS = [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].freeze
-        def inject_context(context, client_method)
-          return unless SEND_MESSAGE_CLIENT_METHODS.include? client_method
-          return unless instrumentation_config[:inject_messaging_context]
-
-          if client_method == SQS_SEND_MESSAGE_BATCH
-            context.params[:entries].each do |entry|
-              entry[:message_attributes] ||= {}
-              OpenTelemetry.propagation.inject(entry[:message_attributes], setter: MessageAttributeSetter)
-            end
+        def span_kind(client_method, service_id)
+          case service_id
+          when 'SQS', 'SNS'
+            MessagingHelper.span_kind(client_method)
           else
-            context.params[:message_attributes] ||= {}
-            OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+            OpenTelemetry::Trace::SpanKind::CLIENT
           end
         end
 
-        def span_kind(client_method)
-          case client_method
-          when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
-            OpenTelemetry::Trace::SpanKind::PRODUCER
-          when SQS_RECEIVE_MESSAGE
-            OpenTelemetry::Trace::SpanKind::CONSUMER
+        def span_name(context, client_method, service_id)
+          case service_id
+          when 'SQS', 'SNS'
+            MessagingHelper.legacy_span_name(context, client_method)
           else
-            OpenTelemetry::Trace::SpanKind::CLIENT
+            client_method
           end
         end
 
-        def span_name(context, client_method)
-          case client_method
-          when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
-            "#{MessagingHelper.queue_name(context)} publish"
-          when SQS_RECEIVE_MESSAGE
-            "#{MessagingHelper.queue_name(context)} receive"
-          else
-            client_method
+        def attributes(context, client_method, service_id, operation)
+          {
+            'aws.region' => context.config.region,
+            OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'aws-api',
+            OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => operation,
+            OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service_id
+          }.tap do |attrs|
+            attrs[SemanticConventions::Trace::DB_SYSTEM] = 'dynamodb' if service_id == 'DynamoDB'
+            MessagingHelper.apply_span_attributes(context, attrs, client_method, service_id) if %w[SQS SNS].include?(service_id)
           end
         end
       end
 
       # A Seahorse::Client::Plugin that enables instrumentation for all AWS services
       class Plugin < Seahorse::Client::Plugin
-        def add_handlers(handlers, config)
+        def add_handlers(handlers, _config)
           # run before Seahorse::Client::Plugin::ParamValidator (priority 50)
           handlers.add Handler, step: :validate, priority: 49
         end

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

@@ -13,7 +13,7 @@ module OpenTelemetry
 
         install do |_config|
           require_dependencies
-          add_plugin(Seahorse::Client::Base, *loaded_constants)
+          add_plugins(Seahorse::Client::Base, *loaded_service_clients)
         end
 
         present do
@@ -41,31 +41,39 @@ module OpenTelemetry
 
         def require_dependencies
           require_relative 'handler'
-          require_relative 'services'
           require_relative 'message_attributes'
           require_relative 'messaging_helper'
         end
 
-        def add_plugin(*targets)
+        def add_plugins(*targets)
           targets.each { |klass| klass.add_plugin(AwsSdk::Plugin) }
         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)
+        def loaded_service_clients
+          ::Aws.constants.each_with_object([]) do |c, constants|
+            m = ::Aws.const_get(c)
+            next unless loaded_service?(c, m)
 
             begin
-              constants << ::Aws.const_get(service, false).const_get(:Client, false)
+              constants << m.const_get(:Client)
             rescue StandardError => e
               OpenTelemetry.logger.warn("Constant could not be loaded: #{e}")
             end
           end
         end
+
+        # This check does the following:
+        # 1 - Checks if the service client is autoload or not
+        # 2 - Validates whether if is a service client
+        # note that Seahorse::Client::Base is a superclass for V3 clients
+        # but for V2, it is Aws::Client
+        def loaded_service?(constant, service_module)
+          !::Aws.autoload?(constant) &&
+            service_module.is_a?(Module) &&
+            service_module.const_defined?(:Client) &&
+            (service_module.const_get(:Client).superclass == Seahorse::Client::Base ||
+              service_module.const_get(:Client).superclass == Aws::Client)
+        end
       end
     end
   end

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

@@ -7,9 +7,15 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      # MessagingHelper class provides methods for calculating messaging span attributes
+      # An utility class to help SQS/SNS-related span attributes/context injection
       class MessagingHelper
         class << self
+          SQS_SEND_MESSAGE = 'SQS.SendMessage'
+          SQS_SEND_MESSAGE_BATCH = 'SQS.SendMessageBatch'
+          SQS_RECEIVE_MESSAGE = 'SQS.ReceiveMessage'
+          SNS_PUBLISH = 'SNS.Publish'
+          SEND_MESSAGE_CLIENT_METHODS = [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].freeze
+
           def queue_name(context)
             topic_arn = context.params[:topic_arn]
             target_arn = context.params[:target_arn]
@@ -28,19 +34,64 @@ module OpenTelemetry
             'unknown'
           end
 
+          def legacy_span_name(context, client_method)
+            case client_method
+            when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
+              "#{MessagingHelper.queue_name(context)} publish"
+            when SQS_RECEIVE_MESSAGE
+              "#{MessagingHelper.queue_name(context)} receive"
+            else
+              client_method
+            end
+          end
+
+          def apply_span_attributes(context, attrs, client_method, service_id)
+            case service_id
+            when 'SQS'
+              apply_sqs_attributes(attrs, context, client_method)
+            when 'SNS'
+              apply_sns_attributes(attrs, context, client_method)
+            end
+          end
+
+          def span_kind(client_method)
+            case client_method
+            when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
+              OpenTelemetry::Trace::SpanKind::PRODUCER
+            when SQS_RECEIVE_MESSAGE
+              OpenTelemetry::Trace::SpanKind::CONSUMER
+            else
+              OpenTelemetry::Trace::SpanKind::CLIENT
+            end
+          end
+
+          def inject_context(context, client_method)
+            return unless SEND_MESSAGE_CLIENT_METHODS.include?(client_method)
+
+            if client_method == SQS_SEND_MESSAGE_BATCH
+              context.params[:entries].each do |entry|
+                entry[:message_attributes] ||= {}
+                OpenTelemetry.propagation.inject(entry[:message_attributes], setter: MessageAttributeSetter)
+              end
+            else
+              context.params[:message_attributes] ||= {}
+              OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+            end
+          end
+
+          private
+
           def apply_sqs_attributes(attributes, context, client_method)
             attributes[SemanticConventions::Trace::MESSAGING_SYSTEM] = 'aws.sqs'
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'queue'
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)
             attributes[SemanticConventions::Trace::MESSAGING_URL] = context.params[:queue_url] if context.params[:queue_url]
-
-            attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if client_method == 'SQS.ReceiveMessage'
+            attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if client_method == SQS_RECEIVE_MESSAGE
           end
 
           def apply_sns_attributes(attributes, context, client_method)
             attributes[SemanticConventions::Trace::MESSAGING_SYSTEM] = 'aws.sns'
-
-            return unless client_method == 'SNS.Publish'
+            return unless client_method == SNS_PUBLISH
 
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.5.3'
+      VERSION = '0.6.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.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.66.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.64.0
+        version: 1.66.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -238,16 +238,15 @@ files:
 - lib/opentelemetry/instrumentation/aws_sdk/instrumentation.rb
 - lib/opentelemetry/instrumentation/aws_sdk/message_attributes.rb
 - lib/opentelemetry/instrumentation/aws_sdk/messaging_helper.rb
-- lib/opentelemetry/instrumentation/aws_sdk/services.rb
 - lib/opentelemetry/instrumentation/aws_sdk/version.rb
 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.5.3/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.6.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.5.3
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_sdk/0.6.0
 post_install_message: 
 rdoc_options: []
 require_paths:

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

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-module OpenTelemetry
-  module Instrumentation
-    # rubocop:disable Metrics/ModuleLength:
-    module AwsSdk
-      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
-    # rubocop:enable Metrics/ModuleLength:
-  end
-end