Skip to content

Commit 5d4d881

Browse files
am29ddreamorosi
authored andcommitted
docs(logger): remove logEvent from required settings (#1821)
* docs: removed required settings and added section for envs * fix typo * remove env section in logs, adjust woring and link to api and index page * clarified wording on logEvent
1 parent da49f92 commit 5d4d881

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

docs/core/logger.md

+9-7
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,18 @@ The `Logger` utility must always be instantiated outside the Lambda handler. By
4141
```
4242

4343
### Utility settings
44-
45-
The library requires two settings. You can set them as environment variables, or pass them in the constructor.
44+
The library has three optional settings, which can be set via environment variables or passed in the constructor.
4645

4746
These settings will be used across all logs emitted:
4847

4948
| Setting | Description | Environment variable | Default Value | Allowed Values | Example Value | Constructor parameter |
5049
| ---------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------- | ------------------- | ------------------------------------------------------ | ------------------- | --------------------- |
5150
| **Service name** | Sets the name of service of which the Lambda function is part of, that will be present across all log statements | `POWERTOOLS_SERVICE_NAME` | `service_undefined` | Any string | `serverlessAirline` | `serviceName` |
5251
| **Logging level** | Sets how verbose Logger should be, from the most verbose to the least verbose (no logs) | `POWERTOOLS_LOG_LEVEL` | `INFO` | `DEBUG`, `INFO`, `WARN`, `ERROR`, `CRITICAL`, `SILENT` | `ERROR` | `logLevel` |
53-
| **Log incoming event** | Whether to log or not the incoming event when using the decorator or middleware | `POWERTOOLS_LOGGER_LOG_EVENT` | `false` | `true`, `false` | `false` | `logEvent` |
54-
| **Debug log sampling** | Probability that a Lambda invocation will print all the log items regardless of the log level setting | `POWERTOOLS_LOGGER_SAMPLE_RATE` | `0` | `0.0` to `1` | `0.5` | `sampleRateValue` |
52+
| **Sample rate** | Probability that a Lambda invocation will print all the log items regardless of the log level setting | `POWERTOOLS_LOGGER_SAMPLE_RATE` | `0` | `0.0` to `1.0` | `0.1` | `sampleRateValue` |
53+
54+
See all enivronment variables in the [Environment variables](../index.md/#environment-variables) section.
55+
Check API docs to learn more about [Logger constructor options](https://docs.powertools.aws.dev/lambda/typescript/latest/api/types/_aws_lambda_powertools_logger.types.ConstructorOptions.html){target="_blank"}.
5556

5657
#### Example using AWS Serverless Application Model (SAM)
5758

@@ -153,9 +154,9 @@ In each case, the printed log will look like this:
153154
}
154155
```
155156

156-
#### Log incoming event
157+
### Log incoming event
157158

158-
When debugging in non-production environments, you can instruct Logger to log the incoming event with the middleware/decorator parameter `logEvent` or via `POWERTOOLS_LOGGER_LOG_EVENT` env var set to `true`.
159+
When debugging in non-production environments, you can instruct Logger to log the incoming event with the middleware/decorator parameter `logEvent`.
159160

160161
???+ warning
161162
This is disabled by default to prevent sensitive info being logged
@@ -174,6 +175,8 @@ When debugging in non-production environments, you can instruct Logger to log th
174175

175176
1. Binding your handler method allows your handler to access `this` within the class methods.
176177

178+
Use `POWERTOOLS_LOGGER_LOG_EVENT` environment variable to enable or disable (`true`/`false`) this feature.
179+
177180
### Appending persistent additional log keys and values
178181

179182
You can append additional persistent keys and values in the logs generated during a Lambda invocation using either mechanism:
@@ -389,7 +392,6 @@ The error will be logged with default key name `error`, but you can also pass yo
389392
!!! tip "Logging errors and log level"
390393
You can also log errors using the `warn`, `info`, and `debug` methods. Be aware of the log level though, you might miss those errors when analyzing the log later depending on the log level configuration.
391394

392-
393395
## Advanced
394396

395397
### Log levels

0 commit comments

Comments
 (0)