aspecto-opentelemetry-instrumentation-aws_sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ec3341f2b96c740a02d140ed58196b6cf592592129a599b70813a5b2589e764
-  data.tar.gz: 2b29e56274e254fcddad2fe4166541efae62a176e93c1e0a27fc4e81d7fa6334
+  metadata.gz: 0c0d66d31a0f6bc5f4fce712eac7a89dd9496bb184e94ef3d8f020d34da908c6
+  data.tar.gz: 9684ac5b863abddf558f0aa13e4b5f06a66ae84c81eb99362fd99e3906a016b9
 SHA512:
-  metadata.gz: abf572bbad78da60fe057d3650cdbb1c37cc85ea6902533da363ea730f40f139b61ab7f19fa34360769fb376f0a17767f8be8917aace1e398308920e54e71314
-  data.tar.gz: d45d7ef1ec899412d0ff33225e45a8cd3c506629d65ac3aa0d76b358d3cfc7ecb7ea4c362d0cd610a14b2ed89b416bc66771015f6309251bfb0f81cd4885aef0
+  metadata.gz: 01e7d9fdc6def5ba52d4fd6859fe35f1002988d621dd19174cc49e035db0b2e312fef0bb03982f02e850d9dbdb3d14d841a5eda4cf97a7681da2b7a5e2b61f69
+  data.tar.gz: fcb4db3a7b95b559e9b5afe82962a67e1c50a8b85efa58582d0c6da44698afa5cc95be01c69930983f56b309c3981efba2656497f64b4ba19b797dd7d06b5341

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

@@ -9,12 +9,18 @@ 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)
           span_name = get_span_name(context)
           attributes = get_span_attributes(context)
 
-          tracer.in_span(span_name, kind: OpenTelemetry::Trace::SpanKind::CLIENT, attributes: attributes) do |span|
+          tracer.in_span(span_name, kind: get_span_kind(context), attributes: attributes) do |span|
             execute = proc {
+              inject_context(context)
               super(context).tap do |response|
                 if (err = response.error)
                   span.record_exception(err)
@@ -31,6 +37,14 @@ module OpenTelemetry
           end
         end
 
+        def inject_context(context)
+          client_method = get_client_method(context)
+          return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
+
+          context.params[:message_attributes] ||= {}
+          OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+        end
+
         def get_span_attributes(context)
           span_attributes = {
             'aws.region' => context.config.region,
@@ -39,8 +53,9 @@ module OpenTelemetry
             OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => get_service_name(context)
           }
 
+          messaging_attributes = MessagingHelper.get_messaging_attributes(context, get_service_name(context), get_operation(context))
           db_attributes = DbHelper.get_db_attributes(context, get_service_name(context), get_operation(context))
-          span_attributes.merge(db_attributes)
+          span_attributes.merge(messaging_attributes).merge(db_attributes)
         end
 
         def get_service_name(context)
@@ -51,7 +66,31 @@ module OpenTelemetry
           context&.operation&.name
         end
 
+        def get_span_kind(context)
+          client_method = get_client_method(context)
+          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 get_span_name(context)
+          client_method = get_client_method(context)
+          case client_method
+          when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
+            "#{MessagingHelper.get_queue_name(context)} send"
+          when SQS_RECEIVE_MESSAGE
+            "#{MessagingHelper.get_queue_name(context)} receive"
+          else
+            client_method
+          end
+        end
+
+        def get_client_method(context)
           "#{get_service_name(context)}.#{get_operation(context)}"
         end
 

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

@@ -14,6 +14,8 @@ module OpenTelemetry
         install do |_config|
           require_relative 'handler'
           require_relative 'services'
+          require_relative 'message_attribute_setter'
+          require_relative 'messaging_helper'
           require_relative 'db_helper'
 
           add_plugin(Seahorse::Client::Base, *loaded_constants)

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module AwsSdk
+      # The MessageAttributeSetter class provides methods for writing tracing information to
+      # SNS / SQS messages.
+      #
+      # @example
+      #   OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+      class MessageAttributeSetter
+        def self.set(carrier, key, value)
+          # https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html
+          if carrier.length < 10
+            carrier[key] = { string_value: value, data_type: 'String' }
+          else
+            OpenTelemetry.logger.warn('aws-sdk instrumentation: cannot set context propagation on SQS/SNS message due to maximum amount of MessageAttributes')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module AwsSdk
+      # MessagingHelper class provides methods for calculating messaging span attributes
+      class MessagingHelper
+        class << self
+          def get_queue_name(context)
+            topic_arn = context.metadata[:original_params][:topic_arn]
+            target_arn = context.metadata[:original_params][:target_arn]
+            phone_number = context.metadata[:original_params][:phone_number]
+            queue_url = context.metadata[:original_params][:queue_url]
+
+            if topic_arn || target_arn
+              arn = topic_arn || target_arn
+              begin
+                arn.split(':')[-1]
+              rescue StandardError
+                arn
+              end
+            end
+
+            return phone_number if phone_number
+
+            return queue_url.split('/')[-1] if queue_url
+
+            'unknown'
+          end
+
+          def get_messaging_attributes(context, service_name, operation)
+            return get_sns_attributes(context, operation) if service_name == 'SNS'
+            return get_sqs_attributes(context, operation) if service_name == 'SQS'
+            {}
+          end
+
+          def get_sqs_attributes(context, operation)
+            sqs_attributes = {
+              SemanticConventions::Trace::MESSAGING_SYSTEM => 'aws.sqs',
+              SemanticConventions::Trace::MESSAGING_DESTINATION_KIND => 'queue',
+              SemanticConventions::Trace::MESSAGING_DESTINATION => get_queue_name(context),
+              SemanticConventions::Trace::MESSAGING_URL => context.metadata[:original_params][:queue_url]
+            }
+
+            sqs_attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if operation == 'ReceiveMessage'
+
+            sqs_attributes
+          end
+
+          def get_sns_attributes(context, operation)
+            sns_attributes = {
+              SemanticConventions::Trace::MESSAGING_SYSTEM => 'aws.sns'
+            }
+
+            if operation == 'Publish'
+              sns_attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
+              sns_attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = get_queue_name(context)
+            end
+
+            sns_attributes
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.1.0'
+      VERSION = '0.1.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspecto-opentelemetry-instrumentation-aws_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - OpenTelemetry Authors
@@ -237,16 +237,18 @@ files:
 - lib/opentelemetry/instrumentation/aws_sdk/db_helper.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/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
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.0/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.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.0
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.1
 post_install_message:
 rdoc_options: []
 require_paths: