powertools-lambda-typescript
powertools-lambda-typescript copied to clipboard
aws-powertools
Documentation (logger, tracer, metrics): add supported values for env variables
Description of the improvement
Summary of the proposal
In all sections where the supported environment variables are documented for a certain utility, it would be helpful to clarify what values are supported, the default values, and an example of a supported value.
How, where did you look for information
https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#environment-variables https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/#utility-settings https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/#utility-settings https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/#utility-settings
Missing or unclear documentation
- Supported values
- Default values (if no value is passes)
- Example of a value
Improvement
Add these fields in each table.
Related existing documentation
https://awslabs.github.io/aws-lambda-powertools-typescript/latest/#environment-variables https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/#utility-settings https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/#utility-settings https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/#utility-settings
Related issues, RFCs
N/A
