[docs] Add exception logging best practices #6037
Conversation
docs/logs/README.md
Outdated
| > [!NOTE] | ||
| > When using the compile-time source generator the first `Exception` parameter | ||
| > detected is automatically given special handling. It **SHOULD NOT** be part of | ||
| > the message template. |
There was a problem hiding this comment.
Few users may find it difficult to understand what we mean as message template. An example or calling it out would help.
There was a problem hiding this comment.
I added a link to runtime docs for more details. Think that will be enough?
| You want to use the correct `Exception` APIs because the OpenTelemetry | ||
| Specification [defines dedicated | ||
| attributes](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-logs.md) | ||
| for `Exception` details. The following examples show what **NOT** to do. In |
There was a problem hiding this comment.
If a user does not want to get the stack details (due to cost etc.), then there is no opt-out mechanism today, so this maybe a viable workaround folks can use today. i.e they send ex.msg, and ex.type as normal parameters, and not pass in the exception object...
There was a problem hiding this comment.
That's a good point. Probably doesn't belong in best practices though. What if we put that somewhere with more advanced content or somewhere showing customizations?
There was a problem hiding this comment.
That'd be good (move it elsewhere)
|
This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or pushing will instruct the bot to automatically remove the label. This bot runs once per day. |
github-actions
bot
added
the
Stale
Changes
Merge requirement checklist