Skip to content

Commit 884d251

Browse files
authored
docs(home): add note about POWERTOOLS_DEV side effects in CloudWatch Logs (#3770)
1 parent f31ea17 commit 884d251

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

docs/index.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -734,18 +734,17 @@ Core utilities such as Tracing, Logging, Metrics, and Event Handler will be avai
734734

735735
### Optimizing for non-production environments
736736

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

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

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

744-
| Utility | Effect |
745-
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
746-
| __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 |
747-
| __Event Handler__ | Enable full traceback errors in the response, indent request/responses, and CORS in dev mode (`*`). |
748-
| __Tracer__ | Future-proof safety to disables tracing operations in non-Lambda environments. This already happens automatically in the Tracer utility. |
743+
| Utility | Effect |
744+
| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
745+
| __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. |
746+
| __Event Handler__ | Enable full traceback errors in the response, indent request/responses, and CORS in dev mode (`*`). |
747+
| __Tracer__ | Future-proof safety to disables tracing operations in non-Lambda environments. This already happens automatically in the Tracer utility. |
749748

750749
## Debug mode
751750

0 commit comments

Comments
 (0)