serverless-aws-otel-plugin

A Serverless plugin to automatically configure AWS OpenTelemetry layer and environment variables for Python Lambda functions.

Installation

npm install serverless-aws-otel-plugin

Usage

Add the plugin to your serverless.yml:

plugins:
  - serverless-aws-otel-plugin

Configuration

Basic Usage (Uses Defaults)

plugins:
  - serverless-aws-otel-plugin

Custom Configuration

custom:
  otelPlugin:
    # Override the default OpenTelemetry layer ARN
    layerArn: 'arn:aws:lambda:us-east-1:615299751070:layer:AWSOpenTelemetryDistroPython:20'

    # Override or add environment variables
    envVars:
      OTEL_LOGS_EXPORTER: 'otlp'
      OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: 'logging,requests'
      OTEL_RESOURCE_ATTRIBUTES: 'service.name=${self:service},service.version=2.0.0,service.environment=${self:custom.stage}'

Default Configuration

The plugin automatically adds:

• Layer: arn:aws:lambda:us-east-1:615299751070:layer:AWSOpenTelemetryDistroPython:18
• Environment Variables:
  • AWS_LAMBDA_EXEC_WRAPPER: /opt/otel-instrument
  • OTEL_LOGS_EXPORTER: none
  • OTEL_PYTHON_DISABLED_INSTRUMENTATIONS: logging
  • OTEL_RESOURCE_ATTRIBUTES: service.name=${self:service},service.version=1.0.0,service.environment=${self:custom.stage}
  • OTEL_SERVICE_NAME: ${self:service}
  • OTEL_PROPAGATORS: tracecontext,baggage,xray

Publishing Steps

1. Create GitHub repository
2. Test locally:

   npm pack

3. Publish to npm:

   npm login
   npm publish

License

MIT