aspecto-opentelemetry-instrumentation-aws_sdk 0.1.4 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07cea588556e47fdc18637f2eaafbfc925a54fa10b1a5f0e90e3252028512c52
-  data.tar.gz: 0b77c9ae3b96d84bdc2065fbce499c371d4d03b49789ab862b823cad9907b87b
+  metadata.gz: fd22dbff8fc844572b0134bc017e7202b7b0a0b117b3eceab65249449493d57e
+  data.tar.gz: c9466be404ec13f25017f7db758819500ae4f109ad2826923d86907ce72ba13a
 SHA512:
-  metadata.gz: fd02cdfca52ecec95c992481bc42cb05e4b9568294fe05b279ea3015bbc39b80312be002590cdc68ccbb9f5125c8c80d14240df0b40ad01a847f76268a633ce1
-  data.tar.gz: 1691f847d0914cb362440813a9f8584d3811303b007cec058ca2b278618d3060ce38fbd32edfd7d30936f654e0090ec8f1d23fc41efd4993ad2827784431adf0
+  metadata.gz: 1337b7ad6217685438f65de8655865f2f699b3ac12c7cd17d78e292f8fade4afddbfe1e7ee35e974abd4645e042d6209b2fc52fdda4e1291b2ca61ae6d129eb4
+  data.tar.gz: 03fb4f63e6b7a485b6acd925e351d6d289ccdcc008b891f584662830d21c3a0900b03e41a7fc1575e436d003309a8bebdf1b548a499242e9e903ad3ea020f91e

data/CHANGELOG.md

@@ -1 +1,5 @@
 # Release History: opentelemetry-instrumentation-aws_sdk
+
+### v0.1.0 / 2021-12-01
+
+* Initial release.

data/README.md

@@ -19,6 +19,8 @@ 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
   }
 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 = 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
           operation = context.operation&.name
           client_method = "#{service_name}.#{operation}"
           attributes = {
@@ -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'
 
-          tracer.in_span(span_name(context, client_method), attributes: attributes, kind: span_kind(service_name, operation)) do |span|
+          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
@@ -41,6 +43,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 client_method == SQS_RECEIVE_MESSAGE && response.respond_to?(:messages)
             end
           end
         end
@@ -57,6 +61,7 @@ module OpenTelemetry
 
         def inject_context(context, client_method)
           return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
+          return unless instrumentation_config[:inject_messaging_context]
 
           if client_method == SQS_SEND_MESSAGE_BATCH
             context.params[:entries].each do |entry|
@@ -69,7 +74,14 @@ module OpenTelemetry
           end
         end
 
-        def span_kind(service_name, client_method)
+        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
             OpenTelemetry::Trace::SpanKind::PRODUCER
@@ -83,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.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,17 +24,10 @@ module OpenTelemetry
           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
 
-        private
-
-        def require_dependencies
-          require_relative 'handler'
-          require_relative 'services'
-          require_relative 'message_attribute_setter'
-          require_relative 'messaging_helper'
-        end
-
         def gem_version
           if Gem.loaded_specs['aws-sdk']
             Gem.loaded_specs['aws-sdk'].version
@@ -43,6 +36,15 @@ module OpenTelemetry
           end
         end
 
+        private
+
+        def require_dependencies
+          require_relative 'handler'
+          require_relative 'services'
+          require_relative 'message_attributes'
+          require_relative 'messaging_helper'
+        end
+
         def add_plugin(*targets)
           targets.each { |klass| klass.add_plugin(AwsSdk::Plugin) }
         end

data/lib/opentelemetry/instrumentation/aws_sdk/{message_attribute_setter.rb → message_attributes.rb}

@@ -22,6 +22,16 @@ module OpenTelemetry
           end
         end
       end
+
+      # The MessageAttributeGetter class provides methods for getting tracing information from SQS message.
+      #
+      # @example
+      #   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'
+        end
+      end
     end
   end
 end

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

@@ -10,11 +10,11 @@ module OpenTelemetry
       # MessagingHelper class provides methods for calculating messaging span attributes
       class MessagingHelper
         class << self
-          def queue_name(context) # rubocop:disable Metrics/CyclomaticComplexity
-            topic_arn = params(context, :topic_arn)
-            target_arn = params(context, :target_arn)
-            phone_number = params(context, :phone_number)
-            queue_url = params(context, :queue_url)
+          def destination_name(context) # rubocop:disable Metrics/CyclomaticComplexity
+            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
@@ -25,7 +25,7 @@ module OpenTelemetry
               end
             end
 
-            return phone_number if phone_number
+            return 'phone_number' if phone_number
 
             return queue_url.split('/')[-1] if queue_url
 
@@ -35,8 +35,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] = params(context, :queue_url)
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = destination_name(context)
+            attributes[SemanticConventions::Trace::MESSAGING_URL] = context.params[:queue_url]
 
             attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if client_method == 'SQS.ReceiveMessage'
           end
@@ -47,11 +47,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 params(context, param)
-            defined?(context.metadata[:original_params][param]) ? context.metadata[:original_params][param] : context.params[param]
+          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.4'
+      VERSION = '0.1.8'
     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.4
+  version: 0.1.8
 platform: ruby
 authors:
 - Aspecto Authors
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-23 00:00:00.000000000 Z
+date: 2021-12-21 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.18.3
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.3
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -236,7 +236,7 @@ files:
 - lib/opentelemetry/instrumentation/aws_sdk.rb
 - lib/opentelemetry/instrumentation/aws_sdk/handler.rb
 - lib/opentelemetry/instrumentation/aws_sdk/instrumentation.rb
-- lib/opentelemetry/instrumentation/aws_sdk/message_attribute_setter.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
@@ -244,11 +244,11 @@ homepage: https://aspecto.io
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.4/file.CHANGELOG.html
+  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.4
-post_install_message:
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.8
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -263,8 +263,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework
 test_files: []