Skip to content

Commit f5d5691

Browse files
Liudmila Molkovajoaopgrassi
andauthored
Apply suggestions from code review
Co-authored-by: Joao Grassi <[email protected]>
1 parent 5ddfd05 commit f5d5691

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ Instrumentations should record exception information (along with other context)
5454
use appropriate severity - only unhandled exceptions should be recorded as `Error` or higher. Instrumentations
5555
should strive to report each exception once.
5656

57-
Instrumentations should provide the whole exception instance to the OTel (instead of individual attributes)
58-
and the OTel SDK should, based on configuration, decide which information to record. As a default,
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,
5959
this OTEP proposes to record exception stack traces on logs with `Error` or higher severity.
6060

6161
### Details
@@ -72,7 +72,7 @@ this OTEP proposes to record exception stack traces on logs with `Error` or high
7272
7373
Some runtimes provide global exception handler that can be used to log exceptions.
7474
Priority should be given to the instrumentation point where the operation context is available.
75-
Language SIGs are encouraged to give runtime-specific guidance. For example, here's
75+
Language SIGs are encouraged to give runtime-specific guidance. For example, here is the
7676
[.NET guidance](https://github.com/open-telemetry/opentelemetry-dotnet/tree/main/docs/trace/reporting-exceptions#unhandled-exception)
7777
for recording exceptions on traces.
7878

@@ -84,7 +84,7 @@ this OTEP proposes to record exception stack traces on logs with `Error` or high
8484

8585
5. An error should be logged with appropriate severity depending on the available context.
8686

87-
- Error that don't indicate any issue should be recorded with severity not higher than `Info`.
87+
- Errors that don't indicate any issue should be recorded with severity not higher than `Info`.
8888
- Transient errors (even if it's the last try) should be recorded with severity not higher than `Warning`.
8989
- Unhandled exceptions that don't result in application shutdown should be recorded with severity `Error`
9090
- Errors that result in application shutdown should be recorded with severity `Fatal`.
@@ -156,7 +156,7 @@ try {
156156
}
157157
```
158158

159-
### Logging error inside the library (native instrumentation)
159+
### Logging error inside the instrumented Library (native instrumentation)
160160

161161
It's a common practice to record exceptions using logging libraries. Client libraries that are natively instrumented with OpenTelemetry should
162162
leverage OTel Events/Logs API for their exception logging purposes.

0 commit comments

Comments
 (0)