Skip to content

docs(home): add note about POWERTOOLS_DEV side effects in CloudWatch Logs #3770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 15, 2024
Merged

docs(home): add note about POWERTOOLS_DEV side effects in CloudWatch Logs #3770

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
07c7355
fix(parameters): make cache aware of single vs multiple calls
heitorlessa Jul 25, 2023
1319ba2
chore: cleanup, add test for single and nested
heitorlessa Jul 25, 2023
67b58e1
docs(home): add note about POWERTOOLS_DEV and CloudWatch Logs side ef…
heitorlessa Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -734,18 +734,17 @@ Core utilities such as Tracing, Logging, Metrics, and Event Handler will be avai

### Optimizing for non-production environments

Whether you're prototyping locally or against a non-production environment, you can use `POWERTOOLS_DEV` to increase verbosity across multiple utilities.
!!! info "We will emit a warning when this feature is used to help you detect misuse in production."

???+ info
We will emit a warning when `POWERTOOLS_DEV` is enabled to help you detect misuse in production environments.
Whether you're prototyping locally or against a non-production environment, you can use `POWERTOOLS_DEV` to increase verbosity across multiple utilities.

When `POWERTOOLS_DEV` is set to a truthy value (`1`, `true`), it'll have the following effects:

| Utility | Effect |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| __Logger__ | Increase JSON indentation to 4. This will ease local debugging when running functions locally under emulators or direct calls while not affecting unit tests |
| __Event Handler__ | Enable full traceback errors in the response, indent request/responses, and CORS in dev mode (`*`). |
| __Tracer__ | Future-proof safety to disables tracing operations in non-Lambda environments. This already happens automatically in the Tracer utility. |
| Utility | Effect |
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| __Logger__ | Increase JSON indentation to 4. This will ease local debugging when running functions locally under emulators or direct calls while not affecting unit tests. <br><br> However, Amazon CloudWatch Logs view will degrade as each new line is treated as a new message. |
| __Event Handler__ | Enable full traceback errors in the response, indent request/responses, and CORS in dev mode (`*`). |
| __Tracer__ | Future-proof safety to disables tracing operations in non-Lambda environments. This already happens automatically in the Tracer utility. |

## Debug mode

Expand Down