aspecto-opentelemetry-instrumentation-aws_sdk 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c0d66d31a0f6bc5f4fce712eac7a89dd9496bb184e94ef3d8f020d34da908c6
-  data.tar.gz: 9684ac5b863abddf558f0aa13e4b5f06a66ae84c81eb99362fd99e3906a016b9
+  metadata.gz: 8dac418df022dc543ee882cea6830b87325ba92d2adc1be9e5e2d2221ab4e8ee
+  data.tar.gz: 6eaebb7d974533635d7215e53244b9865cc6c5d56a44e811d6de1ff9b6d0f608
 SHA512:
-  metadata.gz: 01e7d9fdc6def5ba52d4fd6859fe35f1002988d621dd19174cc49e035db0b2e312fef0bb03982f02e850d9dbdb3d14d841a5eda4cf97a7681da2b7a5e2b61f69
-  data.tar.gz: fcb4db3a7b95b559e9b5afe82962a67e1c50a8b85efa58582d0c6da44698afa5cc95be01c69930983f56b309c3981efba2656497f64b4ba19b797dd7d06b5341
+  metadata.gz: b25f6c3b3dc0bfac3a808a2080a2a8ca5024d1c87b04944decac672fac176574da1b4e7ce7f3275708bb43e238fcb497e42ed82d7ec6ad6dec4a18f77ac5ed72
+  data.tar.gz: d9e3dab08de91b76ec74909ff3a83096f114d48c03acbb4e493e069528565878e7c2ba5535fe8c97d983d8b87832323635238d2b9f22ba985dc9c6be1fcef764

data/CHANGELOG.md

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

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

@@ -14,60 +14,62 @@ module OpenTelemetry
         SQS_RECEIVE_MESSAGE = 'SQS.ReceiveMessage'
         SNS_PUBLISH = 'SNS.Publish'
 
-        def call(context)
-          span_name = get_span_name(context)
-          attributes = get_span_attributes(context)
+        def call(context) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+          return super unless context
 
-          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)
-                  span.status = Trace::Status.error(err)
-                end
-              end
-            }
+          service_name = 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(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 inject_context(context)
-          client_method = get_client_method(context)
-          return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
+        private
 
-          context.params[:message_attributes] ||= {}
-          OpenTelemetry.propagation.inject(context.params[:message_attributes], setter: MessageAttributeSetter)
+        def tracer
+          AwsSdk::Instrumentation.instance.tracer
         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)
-          }
-
-          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(messaging_attributes).merge(db_attributes)
+        def instrumentation_config
+          AwsSdk::Instrumentation.instance.config
         end
 
-        def get_service_name(context)
-          context&.client.class.api.metadata['serviceId'] || context&.client.class.to_s.split('::')[1]
-        end
+        def inject_context(context, client_method)
+          return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
 
-        def get_operation(context)
-          context&.operation&.name
+          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 get_span_kind(context)
-          client_method = get_client_method(context)
+        def span_kind(client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
             OpenTelemetry::Trace::SpanKind::PRODUCER
@@ -78,29 +80,16 @@ module OpenTelemetry
           end
         end
 
-        def get_span_name(context)
-          client_method = get_client_method(context)
+        def span_name(context, client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
-            "#{MessagingHelper.get_queue_name(context)} send"
+            "#{MessagingHelper.queue_name(context)} send"
           when SQS_RECEIVE_MESSAGE
-            "#{MessagingHelper.get_queue_name(context)} receive"
+            "#{MessagingHelper.queue_name(context)} receive"
           else
             client_method
           end
         end
-
-        def get_client_method(context)
-          "#{get_service_name(context)}.#{get_operation(context)}"
-        end
-
-        def tracer
-          AwsSdk::Instrumentation.instance.tracer
-        end
-
-        def instrumentation_config
-          AwsSdk::Instrumentation.instance.config
-        end
       end
 
       # A Seahorse::Client::Plugin that enables instrumentation for all AWS services

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

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

@@ -10,18 +10,18 @@ module OpenTelemetry
       # 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]
+          def queue_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
               begin
-                arn.split(':')[-1]
+                return arn.split(':')[-1]
               rescue StandardError
-                arn
+                return arn
               end
             end
 
@@ -32,36 +32,22 @@ module OpenTelemetry
             '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]
-            }
+          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]
 
-            sqs_attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if operation == 'ReceiveMessage'
-
-            sqs_attributes
+            attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if client_method == 'SQS.ReceiveMessage'
           end
 
-          def get_sns_attributes(context, operation)
-            sns_attributes = {
-              SemanticConventions::Trace::MESSAGING_SYSTEM => 'aws.sns'
-            }
+          def apply_sns_attributes(attributes, context, client_method)
+            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
+            return unless client_method == 'SNS.Publish'
 
-            sns_attributes
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(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.1'
+      VERSION = '0.1.5'
     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.1
+  version: 0.1.5
 platform: ruby
 authors:
-- OpenTelemetry Authors
+- Aspecto Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-24 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,21 +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.1/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.5/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.1
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.5
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -264,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: AWS SDK instrumentation for the OpenTelemetry framework

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