You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: oteps/4333-recording-exceptions-on-logs.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,8 +40,8 @@ Recording exceptions is essential for troubleshooting, but regardless of how exc
40
40
associated with ingesting and storing them. It's also common to log exceptions multiple times while they bubble up
41
41
leading to duplication and aggravating the verbosity problem.
42
42
43
-
In this OTEP, we'll provide guidance around recording exceptions that minimizes duplication, allows to reduce noise with configuration and
44
-
allows to capture exceptions in absence of a recorded span.
43
+
In this OTEP, we'll provide guidance around recording exceptions that minimizes duplication, allows reducing noise with configuration, and
44
+
allows capturing exceptions in the absence of a recorded span.
45
45
46
46
This guidance applies to general-purpose instrumentations including native ones. Application developers should consider following it as a
47
47
starting point, but they are encouraged to adjust it to their needs.
@@ -50,17 +50,17 @@ starting point, but they are encouraged to adjust it to their needs.
50
50
51
51
This guidance boils down to the following:
52
52
53
-
Instrumentations should record exception information (along with other context) on the log record and
53
+
Instrumentations should record exception information (along with other context) as a log record and
54
54
use appropriate severity - only unhandled exceptions should be recorded as `Error` or higher.
55
55
Instrumentations should strive to report each exception once.
56
56
57
57
Instrumentations should provide the whole exception instance to the OTel SDK (instead of individual attributes)
58
-
and the SDK should, based on configuration, decide which information to record. As a default,
59
-
this OTEP proposes to record exception stack traces on logs with`Error` or higher severity.
58
+
and the SDK should, based on configuration, decide which information to record. The default SDK
59
+
behavior should be to record exception stack traces when logging exceptions at`Error` or higher severity.
60
60
61
61
### Details
62
62
63
-
1. Exceptions should be recorded on[logs](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-logs.md)
63
+
1. Exceptions should be recorded as[logs](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/exceptions/exceptions-logs.md)
64
64
or [log-based events](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/events.md)
65
65
66
66
2. Instrumentations for incoming requests, message processing, background job execution, or others that wrap user code and usually create local root spans, should record logs
@@ -72,11 +72,11 @@ this OTEP proposes to record exception stack traces on logs with `Error` or high
0 commit comments