opentelemetry-instrumentation-aws_sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6b7ce8bb3f8c316bd797fc08f9255cebe9ba3f0d642844124112c170104ee06
-  data.tar.gz: 5edcf80454e00bab286aea2c6b65f00970ab786feeed56c452de37c08cb1c239
+  metadata.gz: 25ec693b3e795860dc934fdfd53cc6e8811edfeb02a1d0e6e00befdfffaa868c
+  data.tar.gz: d6844163d29157d36b34a6fe845d0cab60e40d020004269d5ccb78f2f8f33f75
 SHA512:
-  metadata.gz: 9fe79f219f6e3d98c33b658fe59a364f5bf1a2e1d51cf2f173239d817f55932af6c4465a02f898ced656294eb08ee5960f4e7ad2c378ee002a870ded65d28a41
-  data.tar.gz: d24a17ecd61802eaaecc1d07f076986c267ac1879ce1c7f57a84b0f93c26f53a905efc97406ab6037268507d84d90275fd4c89227d545c7512f80ae4004b7361
+  metadata.gz: e43e05fd3994b51649acf47392b14bda90384727c44791fb5e638a67dbe9ac4f67dae91b46180b0cf4354aee0fbcd4eff74118fff3b32151419eb915fa18c1c8
+  data.tar.gz: 69db39398bc60c76390a4a56054768e294aadaa7b5aa17ffbd257217488a134df452df795f988da03a5e3073f125b8fffd03a7952ed3e9b64590d4a6849bfb9c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release History: opentelemetry-instrumentation-aws_sdk
 
+### v0.2.0 / 2022-01-20
+
+* ADDED: SQS / SNS messaging attributes and context propagation 
+
 ### v0.1.0 / 2021-12-01
 
 * Initial release.

data/README.md

@@ -19,6 +19,7 @@ To install the instrumentation, call `use` with the name of the instrumentation.
 ```ruby
 OpenTelemetry::SDK.configure do |c|
   c.use 'OpenTelemetry::Instrumentation::AwsSdk', {
+    inject_messaging_context: true,
     suppress_internal_instrumentation: true
   }
 end

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

@@ -9,11 +9,17 @@ module OpenTelemetry
     module AwsSdk
       # Generates Spans for all interactions with AwsSdk
       class Handler < Seahorse::Client::Handler
-        def call(context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        SQS_SEND_MESSAGE = 'SQS.SendMessage'
+        SQS_SEND_MESSAGE_BATCH = 'SQS.SendMessageBatch'
+        SQS_RECEIVE_MESSAGE = 'SQS.ReceiveMessage'
+        SNS_PUBLISH = 'SNS.Publish'
+
+        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 = {
             'aws.region' => context.config.region,
             OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'aws-api',
@@ -21,8 +27,11 @@ module OpenTelemetry
             OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => service_name
           }
           attributes[SemanticConventions::Trace::DB_SYSTEM] = 'dynamodb' if service_name == 'DynamoDB'
+          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("#{service_name}.#{operation}", attributes: attributes, kind: OpenTelemetry::Trace::SpanKind::CLIENT) do |span|
+          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
@@ -30,7 +39,7 @@ module OpenTelemetry
             end.tap do |response|
               if (err = response.error)
                 span.record_exception(err)
-                span.status = Trace::Status.error(err)
+                span.status = Trace::Status.error(err.to_s)
               end
             end
           end
@@ -45,6 +54,51 @@ module OpenTelemetry
         def instrumentation_config
           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 SEND_MESSAGE_CLIENT_METHODS.include? client_method
+          return unless instrumentation_config[:inject_messaging_context]
+
+          if client_method == SQS_SEND_MESSAGE_BATCH
+            context.params[:entries].each do |entry|
+              entry[:message_attributes] ||= {}
+              OpenTelemetry.propagation.inject(entry[:message_attributes], setter: MessageAttributeSetter)
+            end
+          else
+            context.params[:message_attributes] ||= {}
+            OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+          end
+        end
+
+        def span_kind(client_method)
+          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 span_name(context, client_method)
+          case client_method
+          when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
+            "#{MessagingHelper.queue_name(context)} send"
+          when SQS_RECEIVE_MESSAGE
+            "#{MessagingHelper.queue_name(context)} receive"
+          else
+            client_method
+          end
+        end
       end
 
       # A Seahorse::Client::Plugin that enables instrumentation for all AWS services

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

@@ -24,15 +24,9 @@ module OpenTelemetry
           gem_version >= MINIMUM_VERSION
         end
 
+        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'
-        end
-
         def gem_version
           if Gem.loaded_specs['aws-sdk']
             Gem.loaded_specs['aws-sdk'].version
@@ -41,6 +35,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_attributes.rb

@@ -0,0 +1,37 @@
+# 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
+
+      # The MessageAttributeGetter class provides methods for getting tracing information from SQS message.
+      #
+      # @example
+      #   OpenTelemetry.propagation.extract(message, 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

@@ -0,0 +1,52 @@
+# 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 queue_name(context)
+            topic_arn = context.params[:topic_arn]
+            target_arn = context.params[:target_arn]
+
+            if topic_arn || target_arn
+              arn = topic_arn || target_arn
+              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'
+          end
+
+          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_OPERATION] = 'receive' if client_method == 'SQS.ReceiveMessage'
+          end
+
+          def apply_sns_attributes(attributes, context, client_method)
+            attributes[SemanticConventions::Trace::MESSAGING_SYSTEM] = 'aws.sns'
+
+            return unless client_method == 'SNS.Publish'
+
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)
+          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.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-aws_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -236,16 +236,18 @@ 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_attributes.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.2.0/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.2.0
 post_install_message: 
 rdoc_options: []
 require_paths: