Skip to main content

AWS Lambda - NodeJS function instrumentation

This document covers how to install and configure OpenTelemetry distributed tracing for AWS Lambda functions based on NodeJS and send the data to Sumo Logic.

To obtain tracing data from AWS Lambda functions developed in Node.js you can use Sumo Logic Distribution for OpenTelemetry NodeJS Lambda. It provides auto instrumentation.

Sumo Logic OTel NodeJS Lambda layer supports:

  • nodejs14.x, nodejs16.x and nodejs18.x runtimes
  • x86_64 and arm64 architectures

Sumo Logic Distribution for OpenTelemetry Lambda Layer

Sumo Logic Distribution for OpenTelemetry Lambda Layer version 1.12.0 provides packed OpenTelemetry NodeJS libraries that automatically instrument Lambda functions. The biggest advantage of installing Sumo Logic OTel Lambda as a layer is disabling/enabling instrumentation of the Lambda function without changing the code.

Lambda function requirements

It is very simple to instrument your AWS NodeJS Lambda function using the Sumo Logic Distro for Lambda layer. You'll need the following:

  • NodeJS v14.x or newer
  • Lambda layers add permissions
  • Sumo Logic OTLP/HTTP Source endpoint URL - To send spans from the instrumented Lambda function to Sumo Logic you need an endpoint URL from an existing or new OTLP/HTTP source.
  1. Navigate to functions in the AWS Lambda Console and open the function you want to instrument.

  2. Navigate to the Layers section and click Add a layer.

  3. In the Choose a layer menu, select Specify an ARN and paste the ARN ID for your Lambda function AWS Region. Reference the amd64 and arm64 tables for the ARN ID.

    Choose a layer
  4. Ensure the AWS Distro layer is present in the Layers section:

    Layers section
    note

    You must place the Sumo Logic layer first in the order or you won't see traces in Sumo Logic.

  5. Navigate to the Configuration > Environment variables section and set up the following environment variables (the first are three required):

    • AWS_LAMBDA_EXEC_WRAPPER = /opt/otel-handler - Enables auto-instrumentation.

    • OTEL_TRACES_SAMPLER = always_on - Enables traces sampling.

    • OTEL_SERVICE_NAME = YOUR_SERVICE_NAME - Ensure you define it as a string value that represents the function name and its business logic such as "Check SQS Lambda". This will appear as the tracing service name in Sumo Logic.

    • OTEL_RESOURCE_ATTRIBUTES - Sets OpenTelemetry resources. Add the deployment.environment=[environment-name] tag as needed to allow for filtering by environment on dashboard panels. (For more information, see Services Dashboard Panels). Tracing application and cloud.account.id are set with the OTEL_RESOURCE_ATTRIBUTES environment variable:

      • application=YOUR_APPLICATION_NAME - the string value, if the function is a part of complex system/application then set it for all other functions/applications.

      • cloud.account.id=YOUR_CLOUD_ACCOUNT_ID - set an additional tag that will contain your AWS Lambda Account ID. This will help to provide more relevant data. 

        All of the attributes above are comma separated key/value pairs (this is also a way to add additional information to the spans, just after comma add additional key=value pair) such as, OTEL_RESOURCE_ATTRIBUTES=application=YOUR_APPLICATION_NAME,cloud.account.id=123456789012.

    • SUMO_OTLP_HTTP_ENDPOINT_URL has to be set to send all gathered telemetry data to Sumo Logic. The URL comes from an OTLP/HTTP source. You can use an existing Source or create a new one, if needed.

    note

    The SUMOLOGIC_HTTP_TRACES_ENDPOINT_URL environment variable is deprecated. You'll need to switch from the HTTP Traces Source to OTLP/HTTP source and use the SUMO_OTLP_HTTP_ENDPOINT_URL environment variable instead.

    Environment variables
  6. Your function should be successfully instrumented. Invoke the function and find your traces in the Sumo Logic Tracing screen.

Sumo Logic Distro Lambda layers for AWS Region - amd64 (x86_64) architecture

The following are the Sumo Logic OTel Lambda layers for AWS Region for amd64 (x86_64) architecture.

AWS RegionARN
af-south-1arn:aws:lambda:af-south-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-east-1arn:aws:lambda:ap-east-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-northeast-1arn:aws:lambda:ap-northeast-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-northeast-2arn:aws:lambda:ap-northeast-2:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-northeast-3arn:aws:lambda:ap-northeast-3:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-south-1arn:aws:lambda:ap-south-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-southeast-1arn:aws:lambda:ap-southeast-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ap-southeast-2arn:aws:lambda:ap-southeast-2:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
ca-central-1arn:aws:lambda:ca-central-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-central-1arn:aws:lambda:eu-central-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-north-1arn:aws:lambda:eu-north-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-south-1arn:aws:lambda:eu-south-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-west-1arn:aws:lambda:eu-west-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-west-2arn:aws:lambda:eu-west-2:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
eu-west-3arn:aws:lambda:eu-west-3:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
me-south-1arn:aws:lambda:me-south-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
sa-east-1arn:aws:lambda:sa-east-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
us-east-1arn:aws:lambda:us-east-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
us-east-2arn:aws:lambda:us-east-2:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
us-west-1arn:aws:lambda:us-west-1:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1
us-west-2arn:aws:lambda:us-west-2:663229565520:layer:sumologic-otel-lambda-nodejs-x86_64-v1-17-1:1

Sumo Logic Distro Lambda layers for AWS Region - arm64 (arm) architecture

The following are the Sumo Logic OTel Lambda layers for AWS Region for arm64.

AWS RegionARN
ap-northeast-1arn:aws:lambda:ap-northeast-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
ap-northeast-3arn:aws:lambda:ap-northeast-3:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
ap-south-1arn:aws:lambda:ap-south-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
ap-southeast-1arn:aws:lambda:ap-southeast-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
ap-southeast-2arn:aws:lambda:ap-southeast-2:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
eu-central-1arn:aws:lambda:eu-central-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
eu-west-1arn:aws:lambda:eu-west-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
eu-west-2arn:aws:lambda:eu-west-2:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
us-east-1arn:aws:lambda:us-east-1:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
us-east-2arn:aws:lambda:us-east-2:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1
us-west-2arn:aws:lambda:us-west-2:663229565520:layer:sumologic-otel-lambda-nodejs-arm64-v1-17-1:1

Sumo Logic OTel Lambda container instrumentation

Sumo Logic Distribution for OpenTelemetry Lambda Layer version 1.12.0 also provides packed OpenTelemetry NodeJS libraries for container based Lambda functions.

note

The instructions below support only AWS Base Images for Lambda.

Container based lambda requirements

Instrumentation of container based AWS Lambda function requires some changes in the Dockerfile and image rebuild. You'll need the following:

  • Docker
  • NodeJS v14.x or newer
  • Sumo Logic OTLP/HTTP Source endpoint URL - To send spans from the instrumented Lambda function to Sumo Logic you need an endpoint URL from an existing or new OTLP/HTTP source.

Lambda function image changes

  1. Download and extract Sumo Logic OTel Lambda archive with instrumentation packages specific for your architecture - amd64 (x86_64) or arm64.

  2. Extracted instrumentation libraries have to be added to the image in /opt directory. Please see Dockerfile example:

    FROM public.ecr.aws/lambda/nodejs:14-arm64

    # Lambda Function Code
    COPY index.js ${LAMBDA_TASK_ROOT}
    COPY package.json ${LAMBDA_TASK_ROOT}
    RUN  npm install

    **# Copy OT Instrumentation
    COPY collector-config/ /opt/collector-config/
    COPY extensions/ /opt/extensions/
    COPY nodejs/ /opt/nodejs/
    COPY otel-handler /opt/
    COPY wrapper.d.ts /opt/
    COPY wrapper.d.ts.map /opt/
    COPY wrapper.js /opt/
    COPY wrapper.js.map /opt/**

    CMD \[ "index.handler" \]
  3. Rebuild docker image.

Deployment

  1. Navigate to functions in the AWS Lambda Console and open the function you want to instrument.

  2. Deploy new function image.

  3. Navigate to the Configuration > Environment variables section and set up the following environment variables:

    • AWS_LAMBDA_EXEC_WRAPPER = /opt/otel-handler - Enables auto-instrumentation.

    • OTEL_TRACES_SAMPLER = always_on - Enables traces sampling.

    • OTEL_SERVICE_NAME = YOUR_SERVICE_NAME - Sets the tracing service name in Sumo Logic. Make sure to define it as a string value that represents the function name and its business logic, such as "Check SQS Lambda".

    • OTEL_RESOURCE_ATTRIBUTES - Sets OpenTelemetry resources. Add the deployment.environment=[environment-name] tag as needed to allow for filtering by environment on dashboard panels. (For more information, see Services Dashboard Panels). Tracing application and cloud.account.id are set with the OTEL_RESOURCE_ATTRIBUTES environment variable:

      • application=YOUR_APPLICATION_NAME - the string value, if the function is a part of complex system/application then set it for all other functions/applications.

      • cloud.account.id=YOUR_CLOUD_ACCOUNT_ID - set an additional tag that will contain your AWS Lambda Account ID. This will help to provide more relevant data. 

        All of the attributes above are comma separated key/value pairs (this is also a way to add additional information to the spans, just after comma add additional key=value pair) such as, OTEL_RESOURCE_ATTRIBUTES=application=YOUR_APPLICATION_NAME,cloud.account.id=123456789012.

    • SUMO_OTLP_HTTP_ENDPOINT_URL has to be set to send all gathered telemetry data to Sumo Logic. The URL comes from an OTLP/HTTP source. You can use an existing Source or create a new one, if needed.

    note

    The SUMOLOGIC_HTTP_TRACES_ENDPOINT_URL environment variable is deprecated. You'll need to switch from the HTTP Traces Source to OTLP/HTTP source and use the SUMO_OTLP_HTTP_ENDPOINT_URL environment variable instead.

    • SUMO_OTEL_DISABLE_AWS_CONTEXT_PROPAGATION (optional, default: true, values: true, false) - in case of xray trace context propagation (AWS) set to false.
    Environment variables
  4. Your function should be successfully instrumented. Invoke the function and find your traces in the Sumo Logic Tracing screen.

Status
Legal
Privacy Statement
Terms of Use

Copyright © 2024 by Sumo Logic, Inc.