opentelemetry-instrumentation-aws_lambda 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aaeb5ccdef7fdcbffb476fb16c62fb5cbed347344baa912a6d2ea196a10bad6
-  data.tar.gz: 958208610a3e8d6afa1c4a7f6513508f8ccfb54d9e62e7ad9bd7fd709d59e0c0
+  metadata.gz: dc0776c77bfd96bef38c29a85b8e80ac9ab58edf35791e21c65f726637944155
+  data.tar.gz: 644962009b15fa624dc14ce58bad2ba61448a0a538d7d76be6b0900663ab8dac
 SHA512:
-  metadata.gz: 6a9a8e52b61b6594849e64e1f390fa91cb7736d04fc2cfab39665307336caf1e9bce6445586ba6ec5cf7e876cbe94fd478bd9688acfc8347d52e6ff8eb3ec91f
-  data.tar.gz: 04c2dac7e2c15bee49aaf262082dd9695b91cf69ea02e0c6d3496f01224f606ef3100e48924a8030bc22b235a4c1fa2016754a3a2d150db2317ebfa8344c0f67
+  metadata.gz: d3a6e698fa06ff9bb8af23f95ef1dc17d20f769c2826e2a134a280ebcb9e4958b264e9c4e0bc90b2bb8763df8305f40cb61a102fe1e563e9d85a77b0c29ca710
+  data.tar.gz: fab7d0e891d5d660af842cf76cff130093de8b90cd87c354954306ed6081ba6c77cca32b1e83d23fb655379bc69316c873908c48c3327547000a39171e75e7a4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History: opentelemetry-instrumentation-aws_lambda
 
+### v0.3.0 / 2025-02-04
+
+* ADDED: AWS Lambda programmatic wrap
+* FIXED: AWS Lambda test fix
+
 ### v0.2.0 / 2025-01-16
 
 * BREAKING CHANGE: Set minimum supported version to Ruby 3.1

data/README.md

@@ -28,6 +28,32 @@ def otel_wrapper(event:, context:)
 end
 ```
 
+### Alternative Usage
+
+If using a Lambda Layer is not an option for your given setup, you can programmatically instrument a handler by using the `OpenTelemetry::Instrumentation::AwsLambda::Wrap` module.
+
+```ruby
+require 'opentelemetry/sdk'
+require 'opentelemetry/instrumentation/aws_lambda'
+
+OpenTelemetry::SDK.configure do |c|
+  c.service_name = '<YOUR_SERVICE_NAME>'
+  c.use 'OpenTelemetry::Instrumentation::AwsLambda'
+end
+
+# Lambda Handler
+module Example
+  class Handler
+    extend OpenTelemetry::Instrumentation::AwsLambda::Wrap
+
+    def self.process(event:, context:)
+      puts event.inspect
+    end
+    instrument_handler :process
+  end
+end
+```
+
 ## Example
 
 To run the example:

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

@@ -7,10 +7,10 @@
 module OpenTelemetry
   module Instrumentation
     module AwsLambda
-      AWS_TRIGGERS = ['aws:sqs', 'aws:s3', 'aws:sns', 'aws:dynamodb'].freeze
-
       # Handler class that creates a span around the _HANDLER
       class Handler
+        extend OpenTelemetry::Instrumentation::AwsLambda::Wrap
+
         attr_reader :handler_method, :handler_class
 
         # anytime when the code in a Lambda function is updated or the functional configuration is changed,
@@ -28,47 +28,9 @@ module OpenTelemetry
         # Try to record and re-raise any exception from the wrapped function handler
         # Instrumentation should never raise its own exception
         def call_wrapped(event:, context:)
-          parent_context = extract_parent_context(event)
-
-          span_kind = if event['Records'] && AWS_TRIGGERS.include?(event['Records'].dig(0, 'eventSource'))
-                        :consumer
-                      else
-                        :server
-                      end
-
-          original_handler_error = nil
-          original_response = nil
-          OpenTelemetry::Context.with_current(parent_context) do
-            tracer.in_span(@original_handler, attributes: otel_attributes(event, context), kind: span_kind) do |span|
-              begin
-                response = call_original_handler(event: event, context: context)
-                status_code = response['statusCode'] || response[:statusCode] if response.is_a?(Hash)
-                span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, status_code) if status_code
-              rescue StandardError => e
-                original_handler_error = e
-              ensure
-                original_response = response
-              end
-              if original_handler_error
-                span.record_exception(original_handler_error)
-                span.status = OpenTelemetry::Trace::Status.error(original_handler_error.message)
-              end
-            end
+          self.class.wrap_lambda(event: event, context: context, handler: @original_handler, flush_timeout: @flush_timeout) do
+            call_original_handler(event: event, context: context)
           end
-
-          OpenTelemetry.tracer_provider.force_flush(timeout: @flush_timeout)
-
-          raise original_handler_error if original_handler_error
-
-          original_response
-        end
-
-        def instrumentation_config
-          AwsLambda::Instrumentation.instance.config
-        end
-
-        def tracer
-          AwsLambda::Instrumentation.instance.tracer
         end
 
         private
@@ -94,95 +56,6 @@ module OpenTelemetry
             __send__(@handler_method, event: event, context: context)
           end
         end
-
-        # Extract parent context from request headers
-        # Downcase Traceparent and Tracestate because TraceContext::TextMapPropagator's TRACEPARENT_KEY and TRACESTATE_KEY are all lowercase
-        # If any error occur, rescue and give empty context
-        def extract_parent_context(event)
-          headers = event['headers'] || {}
-          headers.transform_keys! do |key|
-            %w[Traceparent Tracestate].include?(key) ? key.downcase : key
-          end
-
-          OpenTelemetry.propagation.extract(
-            headers,
-            getter: OpenTelemetry::Context::Propagation.text_map_getter
-          )
-        rescue StandardError => e
-          OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while extracting the parent context: #{e.message}")
-          OpenTelemetry::Context.empty
-        end
-
-        # lambda event version 1.0 and version 2.0
-        # https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
-        def v1_proxy_attributes(event)
-          attributes = {
-            OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => event['httpMethod'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => event['resource'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => event['resource']
-          }
-          attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['queryStringParameters']}" if event['queryStringParameters']
-
-          headers = event['headers']
-          if headers
-            attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT] = headers['User-Agent']
-            attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME]     = headers['X-Forwarded-Proto']
-            attributes[OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME]   = headers['Host']
-          end
-          attributes
-        end
-
-        def v2_proxy_attributes(event)
-          request_context = event['requestContext']
-          attributes = {
-            OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME => request_context['domainName'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_context['http']['method'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT => request_context['http']['userAgent'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => request_context['http']['path'],
-            OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => request_context['http']['path']
-          }
-          attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['rawQueryString']}" if event['rawQueryString']
-          attributes
-        end
-
-        # fass.trigger set to http: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#api-gateway
-        # TODO: need to update Semantic Conventions for invocation_id, trigger and resource_id
-        def otel_attributes(event, context)
-          span_attributes = {}
-          span_attributes['faas.invocation_id'] = context.aws_request_id
-          span_attributes['cloud.resource_id'] = context.invoked_function_arn
-          span_attributes[OpenTelemetry::SemanticConventions::Trace::AWS_LAMBDA_INVOKED_ARN] = context.invoked_function_arn
-          span_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = context.invoked_function_arn.split(':')[4]
-
-          if event['requestContext']
-            request_attributes = event['version'] == '2.0' ? v2_proxy_attributes(event) : v1_proxy_attributes(event)
-            request_attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'http'
-            span_attributes.merge!(request_attributes)
-          end
-
-          if event['Records']
-            trigger_attributes = trigger_type_attributes(event)
-            span_attributes.merge!(trigger_attributes)
-          end
-
-          span_attributes
-        rescue StandardError => e
-          OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while preparing span attributes: #{e.message}")
-          {}
-        end
-
-        # sqs spec for lambda: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#sqs
-        # current there is no spec for 'aws:sns', 'aws:s3' and 'aws:dynamodb'
-        def trigger_type_attributes(event)
-          attributes = {}
-          case event['Records'].dig(0, 'eventSource')
-          when 'aws:sqs'
-            attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'pubsub'
-            attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION] = 'process'
-            attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM] = 'AmazonSQS'
-          end
-          attributes
-        end
       end
     end
   end

data/lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb

@@ -21,6 +21,7 @@ module OpenTelemetry
         private
 
         def require_dependencies
+          require_relative 'wrap'
           require_relative 'handler'
         end
       end

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

@@ -7,7 +7,7 @@
 module OpenTelemetry
   module Instrumentation
     module AwsLambda
-      VERSION = '0.2.0'
+      VERSION = '0.3.0'
     end
   end
 end

data/lib/opentelemetry/instrumentation/aws_lambda/wrap.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module OpenTelemetry
+  module Instrumentation
+    module AwsLambda
+      # Helper module that can be used to wrap a lambda handler method
+      module Wrap # rubocop:disable Metrics/ModuleLength
+        AWS_TRIGGERS = ['aws:sqs', 'aws:s3', 'aws:sns', 'aws:dynamodb'].freeze
+        DEFAULT_FLUSH_TIMEOUT = ENV.fetch('OTEL_INSTRUMENTATION_AWS_LAMBDA_FLUSH_TIMEOUT', '30000').to_i
+
+        def instrument_handler(method, flush_timeout: DEFAULT_FLUSH_TIMEOUT)
+          raise ArgumentError, "#{method} is not a method of #{name}" unless respond_to?(method)
+
+          uninstrumented_method = "#{method}_without_instrumentation"
+          singleton_class.alias_method uninstrumented_method, method
+
+          handler = "#{name}.#{method}"
+
+          define_singleton_method(method) do |event:, context:|
+            wrap_lambda(event: event, context: context, handler: handler, flush_timeout: flush_timeout) { public_send(uninstrumented_method, event: event, context: context) }
+          end
+        end
+
+        # Try to record and re-raise any exception from the wrapped function handler
+        # Instrumentation should never raise its own exception
+        def wrap_lambda(event:, context:, handler:, flush_timeout: DEFAULT_FLUSH_TIMEOUT)
+          parent_context = extract_parent_context(event)
+
+          span_kind = if event['Records'] && AWS_TRIGGERS.include?(event['Records'].dig(0, 'eventSource'))
+                        :consumer
+                      else
+                        :server
+                      end
+
+          original_handler_error = nil
+          original_response = nil
+          OpenTelemetry::Context.with_current(parent_context) do
+            tracer.in_span(handler, attributes: otel_attributes(event, context), kind: span_kind) do |span|
+              begin
+                response = yield
+
+                unless span.attributes.key?(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE)
+                  status_code = response['statusCode'] || response[:statusCode] if response.is_a?(Hash)
+                  span.set_attribute(OpenTelemetry::SemanticConventions::Trace::HTTP_STATUS_CODE, status_code) if status_code
+                end
+              rescue StandardError => e
+                original_handler_error = e
+              ensure
+                original_response = response
+              end
+              if original_handler_error
+                span.record_exception(original_handler_error)
+                span.status = OpenTelemetry::Trace::Status.error(original_handler_error.message)
+              end
+            end
+          end
+
+          OpenTelemetry.tracer_provider.force_flush(timeout: flush_timeout)
+          OpenTelemetry.meter_provider.force_flush(timeout: flush_timeout) if OpenTelemetry.respond_to?(:meter_provider)
+
+          raise original_handler_error if original_handler_error
+
+          original_response
+        end
+
+        def instrumentation_config
+          AwsLambda::Instrumentation.instance.config
+        end
+
+        def tracer
+          AwsLambda::Instrumentation.instance.tracer
+        end
+
+        private
+
+        # Extract parent context from request headers
+        # Downcase Traceparent and Tracestate because TraceContext::TextMapPropagator's TRACEPARENT_KEY and TRACESTATE_KEY are all lowercase
+        # If any error occur, rescue and give empty context
+        def extract_parent_context(event)
+          headers = event['headers'] || {}
+          headers.transform_keys! do |key|
+            %w[Traceparent Tracestate].include?(key) ? key.downcase : key
+          end
+
+          OpenTelemetry.propagation.extract(
+            headers,
+            getter: OpenTelemetry::Context::Propagation.text_map_getter
+          )
+        rescue StandardError => e
+          OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while extracting the parent context: #{e.message}")
+          OpenTelemetry::Context.empty
+        end
+
+        # lambda event version 1.0 and version 2.0
+        # https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
+        def v1_proxy_attributes(event)
+          attributes = {
+            OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => event['httpMethod'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => event['resource'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => event['resource']
+          }
+          attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['queryStringParameters']}" if event['queryStringParameters']
+
+          headers = event['headers']
+          if headers
+            attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT] = headers['User-Agent']
+            attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_SCHEME]     = headers['X-Forwarded-Proto']
+            attributes[OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME]   = headers['Host']
+          end
+          attributes
+        end
+
+        def v2_proxy_attributes(event)
+          request_context = event['requestContext']
+          attributes = {
+            OpenTelemetry::SemanticConventions::Trace::NET_HOST_NAME => request_context['domainName'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_METHOD => request_context['http']['method'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_USER_AGENT => request_context['http']['userAgent'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_ROUTE => request_context['http']['path'],
+            OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET => request_context['http']['path']
+          }
+          attributes[OpenTelemetry::SemanticConventions::Trace::HTTP_TARGET] += "?#{event['rawQueryString']}" if event['rawQueryString']
+          attributes
+        end
+
+        # fass.trigger set to http: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#api-gateway
+        # TODO: need to update Semantic Conventions for invocation_id, trigger and resource_id
+        def otel_attributes(event, context)
+          span_attributes = {}
+          span_attributes['faas.invocation_id'] = context.aws_request_id
+          span_attributes['cloud.resource_id'] = context.invoked_function_arn
+          span_attributes[OpenTelemetry::SemanticConventions::Trace::AWS_LAMBDA_INVOKED_ARN] = context.invoked_function_arn
+          span_attributes[OpenTelemetry::SemanticConventions::Resource::CLOUD_ACCOUNT_ID] = context.invoked_function_arn.split(':')[4]
+
+          if event['requestContext']
+            request_attributes = event['version'] == '2.0' ? v2_proxy_attributes(event) : v1_proxy_attributes(event)
+            request_attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'http'
+            span_attributes.merge!(request_attributes)
+          end
+
+          if event['Records']
+            trigger_attributes = trigger_type_attributes(event)
+            span_attributes.merge!(trigger_attributes)
+          end
+
+          span_attributes
+        rescue StandardError => e
+          OpenTelemetry.logger.error("aws-lambda instrumentation exception occurred while preparing span attributes: #{e.message}")
+          {}
+        end
+
+        # sqs spec for lambda: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/faas/aws-lambda.md#sqs
+        # current there is no spec for 'aws:sns', 'aws:s3' and 'aws:dynamodb'
+        def trigger_type_attributes(event)
+          attributes = {}
+          case event['Records'].dig(0, 'eventSource')
+          when 'aws:sqs'
+            attributes[OpenTelemetry::SemanticConventions::Trace::FAAS_TRIGGER] = 'pubsub'
+            attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_OPERATION] = 'process'
+            attributes[OpenTelemetry::SemanticConventions::Trace::MESSAGING_SYSTEM] = 'AmazonSQS'
+          end
+          attributes
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opentelemetry-instrumentation-aws_lambda
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenTelemetry Authors
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-api
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.69.1
+        version: 1.71.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.69.1
+        version: 1.71.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -237,14 +237,15 @@ files:
 - lib/opentelemetry/instrumentation/aws_lambda/handler.rb
 - lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb
 - lib/opentelemetry/instrumentation/aws_lambda/version.rb
+- lib/opentelemetry/instrumentation/aws_lambda/wrap.rb
 homepage: https://github.com/open-telemetry/opentelemetry-ruby-contrib
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.2.0/file/CHANGELOG.md
+  changelog_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.3.0/file/CHANGELOG.md
   source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/tree/main/instrumentation/aws_lambda
   bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby-contrib/issues
-  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.2.0
+  documentation_uri: https://rubydoc.info/gems/opentelemetry-instrumentation-aws_lambda/0.3.0
 post_install_message:
 rdoc_options: []
 require_paths: