diff --git a/docs/core/logger.md b/docs/core/logger.md index bd0be2de36..2fb54ccee7 100644 --- a/docs/core/logger.md +++ b/docs/core/logger.md @@ -41,8 +41,7 @@ The `Logger` utility must always be instantiated outside the Lambda handler. By ``` ### Utility settings - -The library requires two settings. You can set them as environment variables, or pass them in the constructor. +The library has three optional settings, which can be set via environment variables or passed in the constructor. These settings will be used across all logs emitted: @@ -50,8 +49,10 @@ These settings will be used across all logs emitted: | ---------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------- | ------------------- | ------------------------------------------------------ | ------------------- | --------------------- | | **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` | | **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` | -| **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` | -| **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` | +| **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` | + +See all enivronment variables in the [Environment variables](../index.md/#environment-variables) section. +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"}. #### Example using AWS Serverless Application Model (SAM) @@ -153,9 +154,9 @@ In each case, the printed log will look like this: } ``` -#### Log incoming event +### Log incoming event -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`. +When debugging in non-production environments, you can instruct Logger to log the incoming event with the middleware/decorator parameter `logEvent`. ???+ warning 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 1. Binding your handler method allows your handler to access `this` within the class methods. +Use `POWERTOOLS_LOGGER_LOG_EVENT` environment variable to enable or disable (`true`/`false`) this feature. + ### Appending persistent additional log keys and values 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 !!! tip "Logging errors and log level" 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. - ## Advanced ### Log levels