aspecto-opentelemetry-instrumentation-aws_sdk 0.1.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a86c4c6fbaab797ffa640c003796e15aa76ef4f3d89ceabe77c68ecda81d3f61
-  data.tar.gz: d083d4e406da3673a4b7e355c5bdb1f27a404f7e0cfdaf16c7997f66a93788cc
+  metadata.gz: 738e00b5912b370afbd292ec6b1e526fa36d0ef2cc9f4632a8a92a81152011ed
+  data.tar.gz: dd277f0de439f4a0dc74b255da0d9354920dceabfdd3de1882451a5c4fb1adff
 SHA512:
-  metadata.gz: abf2b797bdadaa5024b02424ceb15fab0b05bb64ddab85f26025cf2c9519873e910a2d1ef8bcabdcd051ee7f292c8afca0a2356ed84d054de2d71f067529b535
-  data.tar.gz: a318c1bc59465a3aafe5059746860f2effaa1404343ddf5955a3e0a5891e61f815a410e9d073afb016d2d0f0fa755cc6e167aa315468afd055cf3ed0ce415121
+  metadata.gz: ce269d02df853545d3e94cb896e1757f69fb1e530cebc0997cb6f1fc44cdc2f6347bdf93079ada68c95b8e758e0faa5ff1a0dc56417d3dada28f5c6b65ae7811
+  data.tar.gz: 016a76bd722014e1ac1b3bcca0e1c2b2fbea314ddfa7c33dbdca27e590c30483151c2e4c35fbdabc198ebf1f62fdbcd63d7e952723c0f98229a2d9ce36b3c6a0

data/CHANGELOG.md

@@ -1,4 +1,20 @@
-# Release History: opentelemetry-instrumentation-aws_sdk
+# Release History: opentelemetry-instrumentation-aws_sdk
+
+### 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

@@ -20,6 +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,
+    extract_messaging_context: true,
     suppress_internal_instrumentation: true
   }
 end

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]
+          service_name = service_name(context)
           operation = context.operation&.name
           client_method = "#{service_name}.#{operation}"
           attributes = {
@@ -30,17 +30,24 @@ 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 instrumentation_config[:extract_messaging_context] && client_method == SQS_RECEIVE_MESSAGE && response.respond_to?(:messages)
             end
           end
         end
@@ -55,8 +62,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
@@ -70,6 +85,13 @@ 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
@@ -84,9 +106,9 @@ module OpenTelemetry
         def span_name(context, client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
-            "#{MessagingHelper.queue_name(context)} send"
+            "#{MessagingHelper.destination_name(context)} send"
           when SQS_RECEIVE_MESSAGE
-            "#{MessagingHelper.queue_name(context)} receive"
+            "#{MessagingHelper.destination_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.1')
+        MINIMUM_VERSION = Gem::Version.new('2.0.0')
 
         install do |_config|
           require_dependencies
@@ -21,9 +21,10 @@ 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
 
@@ -32,6 +33,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, getter: MessageAttributeGetter)
+      #   OpenTelemetry.propagation.extract(message.message_attributes, 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 queue_name(context) # rubocop:disable Metrics/CyclomaticComplexity
+          def destination_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] = queue_name(context)
-            attributes[SemanticConventions::Trace::MESSAGING_URL] = context.params[:queue_url]
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = destination_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,7 +43,29 @@ module OpenTelemetry
             return unless client_method == 'SNS.Publish'
 
             attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
-            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)
+            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)] : []
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.1.7'
+      VERSION = '0.4.1'
     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.7
+  version: 0.4.1
 platform: ruby
 authors:
-- Aspecto Authors
-autorequire: 
+- OpenTelemetry Authors
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-13 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
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   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,15 +254,15 @@ 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-ruby
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.7/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.4.1/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.7
-post_install_message: 
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.4.1
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -256,15 +270,15 @@ 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
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework
 test_files: []