aspecto-opentelemetry-instrumentation-aws_sdk 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d56c9d2bed4f998ebcdc3d8749099ede72c95ea8948bc39375b776ca4c60a19
-  data.tar.gz: bf5af54a01e30d3d699845a3c94af34bb5bfd230f7bfccc863c611594e34ea34
+  metadata.gz: a86c4c6fbaab797ffa640c003796e15aa76ef4f3d89ceabe77c68ecda81d3f61
+  data.tar.gz: d083d4e406da3673a4b7e355c5bdb1f27a404f7e0cfdaf16c7997f66a93788cc
 SHA512:
-  metadata.gz: e2a6c0fed13608fbc523f8d8eb6f86284b10b730ea9661559d269aabbab57f05f98822f848511b76cf1a942edac0812be17966c121350a72b61f08b949b1a5b1
-  data.tar.gz: 64a9433cf193b388212de556c614d2e62fda9a25e894b3d1fec578ef2fa9abdc0e9c0232fae60f150e290e7dcac5c95441e2dd7da58fbb31cec0ad2d861958aa
+  metadata.gz: abf2b797bdadaa5024b02424ceb15fab0b05bb64ddab85f26025cf2c9519873e910a2d1ef8bcabdcd051ee7f292c8afca0a2356ed84d054de2d71f067529b535
+  data.tar.gz: a318c1bc59465a3aafe5059746860f2effaa1404343ddf5955a3e0a5891e61f815a410e9d073afb016d2d0f0fa755cc6e167aa315468afd055cf3ed0ce415121

data/CHANGELOG.md

@@ -1 +1,5 @@
 # Release History: opentelemetry-instrumentation-aws_sdk
+
+### 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

@@ -30,7 +30,7 @@ module OpenTelemetry
           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|
+          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 }
@@ -39,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
@@ -57,6 +57,7 @@ module OpenTelemetry
 
         def inject_context(context, client_method)
           return unless [SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH].include? client_method
+          return unless instrumentation_config[:inject_messaging_context]
 
           if client_method == SQS_SEND_MESSAGE_BATCH
             context.params[:entries].each do |entry|
@@ -69,7 +70,7 @@ module OpenTelemetry
           end
         end
 
-        def span_kind(service_name, client_method)
+        def span_kind(client_method)
           case client_method
           when SQS_SEND_MESSAGE, SQS_SEND_MESSAGE_BATCH, SNS_PUBLISH
             OpenTelemetry::Trace::SpanKind::PRODUCER

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

@@ -9,7 +9,7 @@ module OpenTelemetry
     module AwsSdk
       # Instrumentation class that detects and installs the AwsSdk instrumentation
       class Instrumentation < OpenTelemetry::Instrumentation::Base
-        MINIMUM_VERSION = Gem::Version.new('2.0')
+        MINIMUM_VERSION = Gem::Version.new('2.1')
 
         install do |_config|
           require_dependencies
@@ -24,17 +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'
-          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
@@ -43,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_attribute_setter.rb → message_attributes.rb}

@@ -22,6 +22,16 @@ module OpenTelemetry
           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

@@ -11,10 +11,10 @@ module OpenTelemetry
       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)
+            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
@@ -25,7 +25,7 @@ module OpenTelemetry
               end
             end
 
-            return phone_number if phone_number
+            return 'phone_number' if phone_number
 
             return queue_url.split('/')[-1] if queue_url
 
@@ -36,7 +36,7 @@ module OpenTelemetry
             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_URL] = context.params[:queue_url]
 
             attributes[SemanticConventions::Trace::MESSAGING_OPERATION] = 'receive' if client_method == 'SQS.ReceiveMessage'
           end
@@ -49,10 +49,6 @@ module OpenTelemetry
             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

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsSdk
-      VERSION = '0.1.3'
+      VERSION = '0.1.7'
     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.3
+  version: 0.1.7
 platform: ruby
 authors:
 - Aspecto Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.3
+        version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.3
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -236,18 +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_attribute_setter.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
+homepage: https://aspecto.io
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.3/file.CHANGELOG.html
+  changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.7/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.3
+  documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-instrumentation-aws_sdk/v0.1.7
 post_install_message: 
 rdoc_options: []
 require_paths: