Skip to content

Commit 76c7d85

Browse files
author
Liudmila Molkova
committed
minor fixes
1 parent ba90a1f commit 76c7d85

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

oteps/4333-recording-exceptions-on-logs.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,17 @@ Recording exception on logs is essential for troubleshooting. But regardless of
2222
In this OTEP, we'll provide guidance around recording exceptions that minimizes duplication, allows to reduce noise with configuration and
2323
allows to capture exceptions in absence of a recorded span.
2424

25-
This guidance applies to general-purpose instrumentations including native ones. Application developers should consider following it as a starting point, but they are expected to adjust it to their needs.
25+
This guidance applies to general-purpose instrumentations including native ones. Application developers should consider following it as a
26+
starting point, but they are encouraged to adjust it to their needs.
2627

2728
## Guidance
2829

2930
This guidance boils down to the following:
3031

3132
- we should record full exception details including stack traces only for unhandled exceptions (by default).
32-
- we should log error details and context when the error happens. These records don't need need to include exception stack traces unless this exception is unhandled.
33-
- we should avoid logging the same error as it propagates up through the stack.
33+
- we should log error details and context when the error happens. These records should not include
34+
exception stack traces unless this exception is unhandled.
35+
- we should avoid logging the same error multiple times as it propagates up through the stack.
3436
- we should log errors with appropriate severity ranging from `Trace` to `Fatal`.
3537

3638
> [!NOTE]

0 commit comments

Comments
 (0)