Skip to content

Commit

Permalink
Merge pull request #3609 from icd2k3/patch-1
Browse files Browse the repository at this point in the history
Update docs for otel span errors and exceptions
  • Loading branch information
rhetoric101 committed Sep 13, 2021
2 parents 5fea958 + 9bcb4df commit 32bb670
Showing 1 changed file with 17 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -432,15 +432,15 @@ Here are some additional distributed tracing UI details, rules, and limits:
id="error-tips"
title="How to understand span errors"
>
Span-level errors show you where errors originated in a process, how they bubbled up, and where they were handled. Every span that ends with an exception is shown with an error in the UI and contributes to the total error count for that trace.
Span-level errors show you where errors originated in a process, how they bubbled up, and where they were handled. Every span that ends with an error is shown with an error in the UI and contributes to the total error count for that trace.

Here are some general tips about understanding span errors:

* Spans with errors are highlighted red in the distributed tracing UI. You can see more information on the **Error Details** pane for each span.
* All spans that exit with errors are counted in the span error count.
* When multiple errors occur on the same span, only one is written to the span in this order of precedence:
* A `noticeError`
* The most recent span exception
* The most recent span error within the scope of that span

This table describes how different span errors are handled:

Expand All @@ -460,11 +460,11 @@ Here are some additional distributed tracing UI details, rules, and limits:
<tbody>
<tr>
<td>
Spans ending in exceptions
Spans ending in errors
</td>

<td>
An exception that leaves the boundary of a span results in an error on that span and on any ancestor spans that also exit with an error, until the exception is caught or exits the transaction. You can see if an exception is caught in an ancestor span.
An error that leaves the boundary of a span results in an error on that span and on any ancestor spans that also exit with an error, until the error is caught or exits the transaction. You can see if an error is caught in an ancestor span.
</td>
</tr>

Expand Down Expand Up @@ -492,6 +492,19 @@ Here are some additional distributed tracing UI details, rules, and limits:
The response code for these spans is captured as an attribute `httpResponseCode` and attached to that span.
</td>
</tr>
<tr>
<td>
OpenTelemetry Errors
</td>

<td>
The **Error Details** box of the right pane is populated by spans containing `otel.status_code = ERROR` and displays the content of `otel.status_description`.

<Callout variant="tip">
OpenTelemetry span events handled by the app/service are displayed independently of span error status and are not necessarily associated with a span error status. You can view span event exceptions and non-exceptions by clicking **View span events** in the right pane.
</Callout>
</td>
</tr>
</tbody>
</table>
</Collapser>
Expand Down

0 comments on commit 32bb670

Please sign in to comment.