Skip to content

Commit 875e9f0

Browse files
committed
add env vars documentation to readme
1 parent ea1f8e9 commit 875e9f0

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-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.

pr_template.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!-- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
This PR adds documentation for the environment variables used to configure the OpenTelemetry Lambda Collector extension.
5+
6+
## Changes
7+
* Added an "Environment Variables" section to `collector/README.md`.
8+
* Documented `OPENTELEMETRY_COLLECTOR_CONFIG_URI` and `OPENTELEMETRY_EXTENSION_LOG_LEVEL` in a table format, including their descriptions and possible values.
9+
10+
## Testing
11+
N/A - Documentation change only.
12+
13+
## Related Issues
14+
<!-- List any related issues this PR resolves (e.g., "Resolves #123") -->
15+
16+
## Checklist:
17+
<!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
18+
<!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
19+
- [x] My code follows the code style of this project.
20+
- [x] I have updated the documentation accordingly.
21+
- [ ] I have added tests to cover my changes. (Not applicable)
22+
- [x] All new and existing tests passed. (Not applicable)

0 commit comments

Comments
 (0)