Skip to content

README.md

Latest commit

 

History

History
104 lines (78 loc) · 3.77 KB

README.md

File metadata and controls

104 lines (78 loc) · 3.77 KB

OpenTelemetry Lambda Ruby

Scripts and files used to build AWS Lambda Layers for running OpenTelemetry on AWS Lambda for Ruby.

Requirement

Building Lambda Ruby Layer With OpenTelemetry Ruby Dependencies

  1. Run build script
./build.sh

Layer is stored in src/build folder

Default GEM_PATH

The default GEM_PATH for aws lambda ruby is /opt/ruby/gems/<ruby_vesion> after lambda function loads this layer.

Define AWS_LAMBDA_EXEC_WRAPPER

Point AWS_LAMBDA_EXEC_WRAPPER to /opt/otel-handler to take advantage of layer wrapper that load all opentelemetry ruby components e.g.

AWS_LAMBDA_EXEC_WRAPPER: /opt/otel-handler

There are two ways to define the AWS_LAMBDA_EXEC_WRAPPER that point to either binary executable or script (normally bash).

Method 1: define the AWS_LAMBDA_EXEC_WRAPPER in function from template.yml

AWSTemplateFormatVersion: '2010-09-09'
Transform: 'AWS::Serverless-2016-10-31'
Description: OpenTelemetry Ruby Lambda layer for Ruby
Parameters:
  LayerName:
    ...
Resources:
  OTelLayer:
    ...
  api:
    ...
  function:
    Type: AWS::Serverless::Function
    Properties:
      ...
      Environment:
        Variables:
          AWS_LAMBDA_EXEC_WRAPPER: /opt/otel-handler # this is an example of the path

Method 2: directly update the environmental variable in lambda console: Configuration -> Environemntal variables

For more information about aws lambda wrapper and wrapper layer, check aws lambda runtime-wrapper. We provide a sample wrapper file in src/layer/otel-handler as reference.

Sample App

  1. Make sure the requirements are met (e.g. sam, aws, docker, ruby version.). Current sample app only support testing Ruby 3.2.0. If you wish to play with other ruby version, please modify ruby version from Runtime in sample-apps/template.yml and src/otel/layer/Makefile.

  2. Navigate to the path cd ruby/src to build layer

sam build -u -t template.yml
  1. Navigate to the path cd ruby/sample-apps
  2. Build the layer and function based on template.yml. You will see .aws-sam folder after executed the command
sam build -u -t template.yml
# for different arch, define it in properties from template.yml
   # Architectures:
    #   - arm64
  1. Test with local simulation
sam local start-api --skip-pull-image
  1. curl the lambda function
curl http://127.0.0.1:3000
# you should expect: Hello 1.4.1

In this sample-apps, we use src/layer/otel-handler as default AWS_LAMBDA_EXEC_WRAPPER; to change it, please edit in sample-apps/template.yml

In ruby/sample-apps/template.yml, the OTelLayer -> Properties -> ContentUri is pointing to ruby/src/layer/. This is for local testing purpose. If you wish to deploy (e.g. sam deploy), please point it to correct location or zip file.

Test with Jaeger Endpoint

Assume you have a lambda function with current released layer, and you want to test it out that send trace to jaeger endpoint, below should be your environmental variable.

AWS_LAMBDA_EXEC_WRAPPER=/opt/otel-handler
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://<jaeger_endpoint:port_number>/v1/traces

Try with jaeger-all-in-one at Jaeger