aspecto-opentelemetry-instrumentation-aws_sdk 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb173a9b6f6b808809096ed8197c1613830a59f05141deb338f9b50f2385b62
-  data.tar.gz: abf40be87810f0f6143d08992e5d1f8df5a5e2c4305e1157f7d536bec0093d86
+  metadata.gz: 7d56c9d2bed4f998ebcdc3d8749099ede72c95ea8948bc39375b776ca4c60a19
+  data.tar.gz: bf5af54a01e30d3d699845a3c94af34bb5bfd230f7bfccc863c611594e34ea34
 SHA512:
-  metadata.gz: f7ee252047b645f04c863afe2f2a9b6dc7e1e8cb7636313e523cd1eb95277c8bf7044cf153c2f8da92e63da69243b581e29e62403940367efa023edb7b218987
-  data.tar.gz: d6c471fd137dba3f4fb05423c462b3d26fa0b3ee7a4e0dff223d244eee98cfb6768df2ee3b3d3ba5dbf2a42de4c4f2e80148bbca32816a5c02c096bd8bf41334
+  metadata.gz: e2a6c0fed13608fbc523f8d8eb6f86284b10b730ea9661559d269aabbab57f05f98822f848511b76cf1a942edac0812be17966c121350a72b61f08b949b1a5b1
+  data.tar.gz: 64a9433cf193b388212de556c614d2e62fda9a25e894b3d1fec578ef2fa9abdc0e9c0232fae60f150e290e7dcac5c95441e2dd7da58fbb31cec0ad2d861958aa

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.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)
+              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(service_name, 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,11 +10,11 @@ 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 = 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
@@ -32,37 +32,26 @@ 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'
+          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 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_sns_attributes(attributes, context, client_method)
+            attributes[SemanticConventions::Trace::MESSAGING_SYSTEM] = 'aws.sns'
 
-            sqs_attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if operation == 'ReceiveMessage'
+            return unless client_method == 'SNS.Publish'
 
-            sqs_attributes
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION_KIND] = 'topic'
+            attributes[SemanticConventions::Trace::MESSAGING_DESTINATION] = queue_name(context)
           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
+          def params(context, param)
+            defined?(context.metadata[:original_params][param]) ? context.metadata[:original_params][param] : context.params[param]
           end
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.1.2'
+      VERSION = '0.1.3'
     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.2
+  version: 0.1.3
 platform: ruby
 authors:
-- OpenTelemetry Authors
-autorequire:
+- Aspecto Authors
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2021-11-22 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,7 +234,6 @@ 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
@@ -245,11 +244,11 @@ 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.2/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.3/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.2
-post_install_message:
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.3
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -264,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: []

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