Skip to content

Commit 5cc1580

Browse files
authored
add env vars documentation to readme (#1772)
1 parent e8026b5 commit 5cc1580

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

collector/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,15 @@ from an S3 object using a CloudFormation template:
163163
164164
Loading configuration from S3 will require that the IAM role attached to your function includes read access to the relevant bucket.
165165
166+
## Environment Variables
167+
168+
The following environment variables can be used to configure the OpenTelemetry Collector Lambda extension:
169+
170+
| Variable Name | Value | Description |
171+
| ------------------------------------ | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
172+
| `OPENTELEMETRY_COLLECTOR_CONFIG_URI` | URI (e.g., `/var/task/collector.yaml`, `http://...`, `s3://...`) | Specifies the location of the OpenTelemetry Collector configuration file. This can be a path within the function's deployment package, an HTTP URI, or an S3 URI. If loading from S3, the function's IAM role needs read access to the specified S3 object. |
173+
| `OPENTELEMETRY_EXTENSION_LOG_LEVEL` | `debug`, `info`, `warn`, `error`, `dpanic`, `panic`, `fatal` (Default: `info`) | Controls the logging level of the OpenTelemetry Lambda extension itself. |
174+
166175
## Auto-Configuration
167176

168177
Configuring the Lambda Collector without the decouple processor and batch processor can lead to performance issues. So the OpenTelemetry Lambda Layer automatically adds the decouple processor to the end of the chain if the batch processor is used and the decouple processor is not.

0 commit comments

Comments
 (0)