Merge branch 'main' into update-instrumentation-generator-gemspec

kaylareopelle · web-flow · commit 2920f3d97f1d · 2025-01-29T16:47:20.000-08:00
diff --git a/.github/actions/test_gem/action.yml b/.github/actions/test_gem/action.yml
@@ -84,7 +84,7 @@ runs:
     # ...but not for appraisals, sadly.
     - name: Install Ruby ${{ inputs.ruby }} with dependencies
       if: "${{ steps.setup.outputs.appraisals == 'false' }}"
-      uses: ruby/setup-ruby@v1.213.0
+      uses: ruby/setup-ruby@v1.214.0
       with:
         ruby-version: "${{ inputs.ruby }}"
         working-directory: "${{ steps.setup.outputs.gem_dir }}"
@@ -95,7 +95,7 @@ runs:
     # If we're using appraisals, do it all manually.
     - name: Install Ruby ${{ inputs.ruby }} without dependencies
       if: "${{ steps.setup.outputs.appraisals == 'true' }}"
-      uses: ruby/setup-ruby@v1.213.0
+      uses: ruby/setup-ruby@v1.214.0
       with:
         ruby-version: "${{ inputs.ruby }}"
         bundler:  "latest"
diff --git a/.github/workflows/ci-contrib.yml b/.github/workflows/ci-contrib.yml
@@ -54,7 +54,7 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem: "opentelemetry-helpers-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
 
   propagators:
     strategy:
@@ -93,7 +93,7 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem: "opentelemetry-propagator-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
 
   resource-detectors:
     strategy:
@@ -133,7 +133,7 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem: "opentelemetry-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
 
   processors:
     strategy:
@@ -171,4 +171,4 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem: "opentelemetry-processor-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
diff --git a/.github/workflows/ci-instrumentation-with-services.yml b/.github/workflows/ci-instrumentation-with-services.yml
@@ -52,7 +52,7 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem:  "opentelemetry-instrumentation-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
     services:
       memcached:
         image: memcached:alpine
diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml
@@ -109,4 +109,4 @@ jobs:
         uses: ./.github/actions/test_gem
         with:
           gem: "opentelemetry-instrumentation-${{ matrix.gem }}"
-          ruby: "jruby-9.4.9.0"
+          ruby: "jruby-9.4.10.0"
diff --git a/.github/workflows/installation-tests.yml b/.github/workflows/installation-tests.yml
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v4
         # ATTENTION: Dependabot does not know how to update shared actions file.
         # If you see it update setup-ruby here also update it as part of actions/test_gem/action.yml
-      - uses: ruby/setup-ruby@v1.213.0
+      - uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ matrix.ruby-version }}
       - name: "Install Latest Gem Versions on ${{ matrix.ruby-version }}"
diff --git a/.github/workflows/release-hook-on-closed.yml b/.github/workflows/release-hook-on-closed.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-hook-on-push.yml b/.github/workflows/release-hook-on-push.yml
@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-perform.yml b/.github/workflows/release-perform.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-please.yaml b/.github/workflows/release-please.yaml
@@ -50,7 +50,7 @@ jobs:
           chmod 0600 $HOME/.gem/credentials
           printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
 
-      - uses: ruby/setup-ruby@v1.213.0
+      - uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: "3.1"
           bundler: latest
diff --git a/.github/workflows/release-request-weekly.yml b/.github/workflows/release-request-weekly.yml
@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-request.yml b/.github/workflows/release-request.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/.github/workflows/release-retry.yml b/.github/workflows/release-retry.yml
@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Ruby ${{ env.ruby_version }}
-        uses: ruby/setup-ruby@v1.213.0
+        uses: ruby/setup-ruby@v1.214.0
         with:
           ruby-version: ${{ env.ruby_version }}
       - name: Checkout repo
diff --git a/instrumentation/aws_lambda/README.md b/instrumentation/aws_lambda/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:
diff --git a/instrumentation/aws_lambda/lib/opentelemetry/instrumentation/aws_lambda/handler.rb b/instrumentation/aws_lambda/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 @@ def initialize
         # 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 @@ def call_original_handler(event:, context:)
             __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
diff --git a/instrumentation/aws_lambda/lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb b/instrumentation/aws_lambda/lib/opentelemetry/instrumentation/aws_lambda/instrumentation.rb
@@ -21,6 +21,7 @@ class Instrumentation < OpenTelemetry::Instrumentation::Base
         private
 
         def require_dependencies
+          require_relative 'wrap'
           require_relative 'handler'
         end
       end
diff --git a/instrumentation/aws_lambda/lib/opentelemetry/instrumentation/aws_lambda/wrap.rb b/instrumentation/aws_lambda/lib/opentelemetry/instrumentation/aws_lambda/wrap.rb
diff --git a/instrumentation/aws_lambda/test/opentelemetry/instrumentation_test.rb b/instrumentation/aws_lambda/test/opentelemetry/instrumentation_test.rb
