aspecto-opentelemetry-instrumentation-aws_sdk 0.1.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd22dbff8fc844572b0134bc017e7202b7b0a0b117b3eceab65249449493d57e
-  data.tar.gz: c9466be404ec13f25017f7db758819500ae4f109ad2826923d86907ce72ba13a
+  metadata.gz: d746413b032d66731e317195aa59ab210ca9b807bb77d09efa78fec35b2f4141
+  data.tar.gz: 0121c5f854af58616b3bb1cb3ea4e659c46ea4c915af155aae018c232ad1ad6a
 SHA512:
-  metadata.gz: 1337b7ad6217685438f65de8655865f2f699b3ac12c7cd17d78e292f8fade4afddbfe1e7ee35e974abd4645e042d6209b2fc52fdda4e1291b2ca61ae6d129eb4
-  data.tar.gz: 03fb4f63e6b7a485b6acd925e351d6d289ccdcc008b891f584662830d21c3a0900b03e41a7fc1575e436d003309a8bebdf1b548a499242e9e903ad3ea020f91e
+  metadata.gz: 22c5d870ce3ca131c05661428e4a53ab9a43feafa89265a3948b856437c2115fd6c8a493e2b52ff0104001595f59a176d5d9fbf04c78d25e688725b653284d98
+  data.tar.gz: 5b636bbdfad5fdb6ceb812d0ecd436f85ee4cc0c69c349cfd37482e930a3e306dd92133a646a44ea77d95f9bee225ace746067408268006d60b765112c7b03f3

data/CHANGELOG.md

@@ -1,4 +1,25 @@
-# Release History: opentelemetry-instrumentation-aws_sdk
+# Release History: opentelemetry-instrumentation-aws_sdk
+
+### v0.3.0 / 2022-06-09
+
+* Upgrading Base dependency version
+* FIXED: Broken test file requirements 
+
+### v0.2.3 / 2022-05-02
+
+* FIXED: RubyGems Fallback 
+
+### v0.2.2 / 2022-01-26
+
+* (No significant changes)
+
+### v0.2.1 / 2022-01-21
+
+* ADDED: attach HTTP status code to AWS spans
+
+### v0.2.0 / 2022-01-20
+
+* ADDED: SQS / SNS messaging attributes and context propagation
 
 ### v0.1.0 / 2021-12-01
 

data/README.md

@@ -19,7 +19,6 @@ To install the instrumentation, call `use` with the name of the instrumentation.
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::AwsSdk', {
-    extract_messaging_context: true,
     inject_messaging_context: true,
     suppress_internal_instrumentation: true
   }
@@ -59,8 +58,7 @@ Apache 2.0 license. See [LICENSE][license-github] for more information.
 [aws-sdk-home]: https://github.com/aws/aws-sdk-ruby
 [bundler-home]: https://bundler.io
 [repo-github]: https://github.com/open-telemetry/opentelemetry-ruby
-[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/blob/main/LICENSE
+[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
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
-

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

@@ -17,7 +17,7 @@ module OpenTelemetry
         def call(context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
           return super unless context
 
-          service_name = context.client.class.api.metadata['serviceId'] || context.client.class.to_s.split('::')[1] rescue context.client.class.to_s.split('::')[1] # rubocop:disable Style/RescueModifier
+          service_name = service_name(context)
           operation = context.operation&.name
           client_method = "#{service_name}.#{operation}"
           attributes = {
@@ -30,21 +30,20 @@ module OpenTelemetry
           MessagingHelper.apply_sqs_attributes(attributes, context, client_method) if service_name == 'SQS'
           MessagingHelper.apply_sns_attributes(attributes, context, client_method) if service_name == 'SNS'
 
-          prepare_extract_context(context, client_method)
           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)
+
               if (err = response.error)
                 span.record_exception(err)
                 span.status = Trace::Status.error(err.to_s)
               end
-
-              MessagingHelper.create_sqs_processing_spans(context, tracer, response.messages) if client_method == SQS_RECEIVE_MESSAGE && response.respond_to?(:messages)
             end
           end
         end
@@ -59,8 +58,16 @@ module OpenTelemetry
           AwsSdk::Instrumentation.instance.config
         end
 
+        def service_name(context) # rubocop:disable Metrics/AbcSize
+          # Support aws-sdk v2.0.x, which 'metadata' has a setter method only
+          return context.client.class.to_s.split('::')[1] if ::Seahorse::Model::Api.instance_method(:metadata).parameters.length.positive?
+
+          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 [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? 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
@@ -74,13 +81,6 @@ module OpenTelemetry
           end
         end
 
-        def prepare_extract_context(context, client_method)
-          return unless client_method == SQS_RECEIVE_MESSAGE
-          return unless instrumentation_config[:extract_messaging_context]
-
-          context.params[:message_attribute_names] = ['All']
-        end
-
         def span_kind(client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
@@ -95,9 +95,9 @@ module OpenTelemetry
         def span_name(context, client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
-            "#{MessagingHelper.destination_name(context)} send"
+            "#{MessagingHelper.queue_name(context)} send"
           when SQS_RECEIVE_MESSAGE
-            "#{MessagingHelper.destination_name(context)} receive"
+            "#{MessagingHelper.queue_name(context)} receive"
           else
             client_method
           end

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

@@ -9,7 +9,7 @@ module OpenTelemetry
     module AwsSdk
       # Instrumentation class that detects and installs the AwsSdk instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        MINIMUM_VERSION = Gem::Version.new('2.0')
+        MINIMUM_VERSION = Gem::Version.new('2.0.0')
 
         install do |_config|
           require_dependencies
@@ -21,10 +21,9 @@ module OpenTelemetry
         end
 
         compatible do
-          gem_version >= MINIMUM_VERSION
+          !gem_version.nil? && gem_version >= MINIMUM_VERSION
         end
 
-        option :extract_messaging_context, default: false, validate: :boolean
         option :inject_messaging_context, default: false, validate: :boolean
         option :suppress_internal_instrumentation, default: false, validate: :boolean
 
@@ -33,6 +32,8 @@ module OpenTelemetry
             Gem.loaded_specs['aws-sdk'].version
           elsif Gem.loaded_specs['aws-sdk-core']
             Gem.loaded_specs['aws-sdk-core'].version
+          elsif defined?(::Aws::CORE_GEM_VERSION)
+            Gem::Version.new(::Aws::CORE_GEM_VERSION)
           end
         end
 

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

@@ -26,10 +26,10 @@ module OpenTelemetry
       # The MessageAttributeGetter class provides methods for getting tracing information from SQS message.
       #
       # @example
-      #   OpenTelemetry.propagation.extract(message.message_attributes, getter: MessageAttributeGetter)
+      #   OpenTelemetry.propagation.extract(message, getter: MessageAttributeGetter)
       class MessageAttributeGetter
         def self.get(carrier, key)
-          return carrier&.[](key)&.[]('string_value') if carrier&.[](key)&.[]('data_type') == 'String'
+          return carrier[key][:string_value] if carrier[key][:data_type] == 'String'
         end
       end
     end

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

@@ -10,23 +10,19 @@ module OpenTelemetry
       # MessagingHelper class provides methods for calculating messaging span attributes
       class MessagingHelper
         class << self
-          def destination_name(context) # rubocop:disable Metrics/CyclomaticComplexity
+          def queue_name(context)
             topic_arn = context.params[:topic_arn]
             target_arn = context.params[:target_arn]
-            phone_number = context.params[:phone_number]
-            queue_url = context.params[:queue_url]
 
             if topic_arn || target_arn
               arn = topic_arn || target_arn
-              begin
-                return arn.split(':')[-1]
-              rescue StandardError
-                return arn
-              end
+              return arn.split(':')[-1]
             end
 
+            phone_number = context.params[:phone_number]
             return 'phone_number' if phone_number
 
+            queue_url = context.params[:queue_url]
             return queue_url.split('/')[-1] if queue_url
 
             'unknown'
@@ -35,8 +31,8 @@ module OpenTelemetry
           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] = destination_name(context)
-            attributes[SemanticConventions::Trace::MESSAGING_URL] = context.params[:queue_url]
+            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'
           end
@@ -47,29 +43,7 @@ module OpenTelemetry
             return unless client_method == 'SNS.Publish'
 
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
-            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = destination_name(context)
-          end
-
-          def create_sqs_processing_spans(context, tracer, messages)
-            queue_name = destination_name(context)
-            messages.each do |message|
-              attributes = {
-                SemanticConventions::Trace::MESSAGING_SYSTEM => 'aws.sqs',
-                SemanticConventions::Trace::MESSAGING_DESTINATION => queue_name,
-                SemanticConventions::Trace::MESSAGING_DESTINATION_KIND => 'queue',
-                SemanticConventions::Trace::MESSAGING_MESSAGE_ID => message.message_id,
-                SemanticConventions::Trace::MESSAGING_URL => context.params[:queue_url],
-                SemanticConventions::Trace::MESSAGING_OPERATION => 'process'
-              }
-              tracer.in_span("#{queue_name} process", attributes: attributes, links: extract_links(message), kind: :consumer) {}
-            end
-          end
-
-          def extract_links(sqs_message)
-            extracted_context = OpenTelemetry.propagation.extract(sqs_message.message_attributes, context: Context::ROOT, getter: MessageAttributeGetter)
-            span_context = OpenTelemetry::Trace.current_span(extracted_context).context
-
-            span_context.valid? ? [OpenTelemetry::Trace::Link.new(span_context)] : []
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.1.8'
+      VERSION = '0.3.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry-instrumentation-aws_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.3.0
 platform: ruby
 authors:
-- Aspecto Authors
+- OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: opentelemetry-test-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -222,7 +236,7 @@ dependencies:
         version: 0.1.6
 description: AWS SDK instrumentation for the OpenTelemetry framework
 email:
-- info@aspecto.io
+- cncf-opentelemetry-contributors@lists.cncf.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -240,14 +254,14 @@ files:
 - lib/opentelemetry/instrumentation/aws_sdk/messaging_helper.rb
 - lib/opentelemetry/instrumentation/aws_sdk/services.rb
 - lib/opentelemetry/instrumentation/aws_sdk/version.rb
-homepage: https://aspecto.io
+homepage: https://github.com/open-telemetry/opentelemetry-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.8/file.CHANGELOG.html
-  source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/instrumentation/aws_sdk
-  bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
-  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.8
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-aws_sdk/v0.3.0/file.CHANGELOG.html
+  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://open-telemetry.github.io/opentelemetry-ruby-contrib/opentelemetry-instrumentation-aws_sdk/v0.3.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -256,14 +270,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework