Skip to content

Commit

Permalink
minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Dec 17, 2024
1 parent ba90a1f commit 76c7d85
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions oteps/4333-recording-exceptions-on-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ Recording exception on logs is essential for troubleshooting. But regardless of
In this OTEP, we'll provide guidance around recording exceptions that minimizes duplication, allows to reduce noise with configuration and
allows to capture exceptions in absence of a recorded span.

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.
This guidance applies to general-purpose instrumentations including native ones. Application developers should consider following it as a
starting point, but they are encouraged to adjust it to their needs.

## Guidance

This guidance boils down to the following:

- we should record full exception details including stack traces only for unhandled exceptions (by default).
- 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.
- we should avoid logging the same error as it propagates up through the stack.
- we should log error details and context when the error happens. These records should not include
exception stack traces unless this exception is unhandled.
- we should avoid logging the same error multiple times as it propagates up through the stack.
- we should log errors with appropriate severity ranging from `Trace` to `Fatal`.

> [!NOTE]
Expand Down

0 comments on commit 76c7d85

Please sign in to comment.