aspecto-opentelemetry-instrumentation-aws_sdk 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ec3341f2b96c740a02d140ed58196b6cf592592129a599b70813a5b2589e764
-  data.tar.gz: 2b29e56274e254fcddad2fe4166541efae62a176e93c1e0a27fc4e81d7fa6334
+  metadata.gz: 07cea588556e47fdc18637f2eaafbfc925a54fa10b1a5f0e90e3252028512c52
+  data.tar.gz: 0b77c9ae3b96d84bdc2065fbce499c371d4d03b49789ab862b823cad9907b87b
 SHA512:
-  metadata.gz: abf572bbad78da60fe057d3650cdbb1c37cc85ea6902533da363ea730f40f139b61ab7f19fa34360769fb376f0a17767f8be8917aace1e398308920e54e71314
-  data.tar.gz: d45d7ef1ec899412d0ff33225e45a8cd3c506629d65ac3aa0d76b358d3cfc7ecb7ea4c362d0cd610a14b2ed89b416bc66771015f6309251bfb0f81cd4885aef0
+  metadata.gz: fd02cdfca52ecec95c992481bc42cb05e4b9568294fe05b279ea3015bbc39b80312be002590cdc68ccbb9f5125c8c80d14240df0b40ad01a847f76268a633ce1
+  data.tar.gz: 1691f847d0914cb362440813a9f8584d3811303b007cec058ca2b278618d3060ce38fbd32edfd7d30936f654e0090ec8f1d23fc41efd4993ad2827784431adf0

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Release History: opentelemetry-instrumentation-aws_sdk

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

@@ -9,58 +9,86 @@ module OpenTelemetry
     module AwsSdk
       # Generates Spans for all interactions with AwsSdk
       class Handler < Seahorse::Client::Handler
-        def call(context)
-          span_name = get_span_name(context)
-          attributes = get_span_attributes(context)
+        SQS_SEND_MESSAGE = 'SQS.SendMessage'
+        SQS_SEND_MESSAGE_BATCH = 'SQS.SendMessageBatch'
+        SQS_RECEIVE_MESSAGE = 'SQS.ReceiveMessage'
+        SNS_PUBLISH = 'SNS.Publish'
 
-          tracer.in_span(span_name, kind: OpenTelemetry::Trace::SpanKind::CLIENT, attributes: attributes) do |span|
-            execute = proc {
-              super(context).tap do |response|
-                if (err = response.error)
-                  span.record_exception(err)
-                  span.status = Trace::Status.error(err)
-                end
-              end
-            }
+        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]
+          operation = context.operation&.name
+          client_method = "#{service_name}.#{operation}"
+          attributes = {
+            'aws.region' => context.config.region,
+            OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'aws-api',
+            OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => operation,
+            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(span_name(context, client_method), attributes: attributes, kind: span_kind(service_name, operation)) do |span|
+            inject_context(context, client_method)
             if instrumentation_config[:suppress_internal_instrumentation]
-              OpenTelemetry::Common::Utilities.untraced(&execute)
+              OpenTelemetry::Common::Utilities.untraced { super }
             else
-              execute.call
+              super
+            end.tap do |response|
+              if (err = response.error)
+                span.record_exception(err)
+                span.status = Trace::Status.error(err.to_s)
+              end
             end
           end
         end
 
-        def get_span_attributes(context)
-          span_attributes = {
-            'aws.region' => context.config.region,
-            OpenTelemetry::SemanticConventions::Trace::RPC_SYSTEM => 'aws-api',
-            OpenTelemetry::SemanticConventions::Trace::RPC_METHOD => get_operation(context),
-            OpenTelemetry::SemanticConventions::Trace::RPC_SERVICE => get_service_name(context)
-          }
+        private
 
-          db_attributes = DbHelper.get_db_attributes(context, get_service_name(context), get_operation(context))
-          span_attributes.merge(db_attributes)
+        def tracer
+          AwsSdk::Instrumentation.instance.tracer
         end
 
-        def get_service_name(context)
-          context&.client.class.api.metadata['serviceId'] || context&.client.class.to_s.split('::')[1]
+        def instrumentation_config
+          AwsSdk::Instrumentation.instance.config
         end
 
-        def get_operation(context)
-          context&.operation&.name
-        end
+        def inject_context(context, client_method)
+          return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
 
-        def get_span_name(context)
-          "#{get_service_name(context)}.#{get_operation(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 tracer
-          AwsSdk::Instrumentation.instance.tracer
+        def span_kind(service_name, 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 instrumentation_config
-          AwsSdk::Instrumentation.instance.config
+        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
 

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

@@ -12,10 +12,7 @@ module OpenTelemetry
         MINIMUM_VERSION = Gem::Version.new('2.0')
 
         install do |_config|
-          require_relative 'handler'
-          require_relative 'services'
-          require_relative 'db_helper'
-
+          require_dependencies
           add_plugin(Seahorse::Client::Base, *loaded_constants)
         end
 
@@ -29,6 +26,15 @@ module OpenTelemetry
 
         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

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,60 @@
+# 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) # 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)
+
+            if topic_arn || target_arn
+              arn = topic_arn || target_arn
+              begin
+                return arn.split(':')[-1]
+              rescue StandardError
+                return arn
+              end
+            end
+
+            return phone_number if phone_number
+
+            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] = params(context, :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
+
+          def params(context, param)
+            defined?(context.metadata[:original_params][param]) ? context.metadata[:original_params][param] : context.params[param]
+          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.4'
     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.0
+  version: 0.1.4
 platform: ruby
 authors:
-- OpenTelemetry Authors
+- Aspecto Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -222,7 +222,7 @@ dependencies:
         version: 0.1.6
 description: AWS SDK instrumentation for the OpenTelemetry framework
 email:
-- cncf-opentelemetry-contributors@lists.cncf.io
+- info@aspecto.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -234,19 +234,20 @@ files:
 - lib/opentelemetry-instrumentation-aws_sdk.rb
 - lib/opentelemetry/instrumentation.rb
 - lib/opentelemetry/instrumentation/aws_sdk.rb
-- 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
+homepage: https://aspecto.io
 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.4/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.4
 post_install_message:
 rdoc_options: []
 require_paths:

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

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# Copyright The OpenTelemetry Authors
-#
-# SPDX-License-Identifier: Apache-2.0
-
-module OpenTelemetry
-  module Instrumentation
-    module AwsSdk
-      # DbHelper class provides methods for calculating aws db span attributes
-      class DbHelper
-        class << self
-          def get_db_attributes(context, service_name, operation)
-            return get_dynamodb_attributes(context, operation) if service_name == 'DynamoDB'
-
-            {}
-          end
-
-          def get_dynamodb_attributes(context, operation)
-            {
-              SemanticConventions::Trace::DB_SYSTEM => 'dynamodb'
-            }
-          end
-        end
-      end
-    end
-  end
-end