aspecto-opentelemetry-instrumentation-aws_sdk 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d746413b032d66731e317195aa59ab210ca9b807bb77d09efa78fec35b2f4141
-  data.tar.gz: 0121c5f854af58616b3bb1cb3ea4e659c46ea4c915af155aae018c232ad1ad6a
+  metadata.gz: 95d4d75e7aadcb23fd58ef5019af051a4fdba63841745df7ff5add0a85bd3890
+  data.tar.gz: 67aa5a0bdc91a9233d2479d3660adbf757044507d74399018d3bed626969d389
 SHA512:
-  metadata.gz: 22c5d870ce3ca131c05661428e4a53ab9a43feafa89265a3948b856437c2115fd6c8a493e2b52ff0104001595f59a176d5d9fbf04c78d25e688725b653284d98
-  data.tar.gz: 5b636bbdfad5fdb6ceb812d0ecd436f85ee4cc0c69c349cfd37482e930a3e306dd92133a646a44ea77d95f9bee225ace746067408268006d60b765112c7b03f3
+  metadata.gz: 3df69697176d3e77a6d46c31e0b90541962adad99750732df99a145656abea32c53432a027e9bda69d8c981f0525c6ce7f85a6158987d02ea064ab6134cc6318
+  data.tar.gz: 72925545d9cea814ba2f6270404f6aacfe1a9773521b4391bb0ac58a909f3e81ec7a589301b8dc23800065ff1ed4f135e8ac41d57bc3c8e2d4fa0dd2ddea171a

data/CHANGELOG.md

@@ -1,10 +1,5 @@
 # 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 

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
@@ -58,7 +59,8 @@ 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-contrib/blob/main/LICENSE
+[license-github]: https://github.com/open-telemetry/opentelemetry-ruby/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

@@ -30,8 +30,10 @@ 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
@@ -44,6 +46,8 @@ module OpenTelemetry
                 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
@@ -81,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
@@ -95,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

@@ -24,6 +24,7 @@ module OpenTelemetry
           !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
 

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,7 +10,7 @@ module OpenTelemetry
       # MessagingHelper class provides methods for calculating messaging span attributes
       class MessagingHelper
         class << self
-          def queue_name(context)
+          def destination_name(context)
             topic_arn = context.params[:topic_arn]
             target_arn = context.params[:target_arn]
 
@@ -31,7 +31,7 @@ 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_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'
@@ -43,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.3.0'
+      VERSION = '0.4.3'
     end
   end
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry-instrumentation-aws_sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - OpenTelemetry Authors
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2022-07-17 00:00:00.000000000 Z
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -254,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://github.com/open-telemetry/opentelemetry-contrib
+homepage: https://github.com/open-telemetry/opentelemetry-ruby
 licenses:
 - Apache-2.0
 metadata:
-  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: 
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.4.3/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.4.3
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,15 +270,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework
 test_files: []