Skip to content

Commit

Permalink
Revamped the UI steps based on SME feedback in PR 3609.
Browse files Browse the repository at this point in the history
  • Loading branch information
rhetoric101 committed Aug 27, 2021
1 parent 84d4818 commit 7161029
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 53 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -30,56 +30,34 @@ After you click on a service in the **Explorer** tab, you see the **Summary** pa

### Distributed tracing [#tracing]

In this section, you mostly locate traces and examine span details.
In **Distributed tracing**, you can locate traces and examine span details:

#### Locate important traces

In **Distributed tracing**, you can filter traces to find the ones you want. For example, to query `service.name` or `trace.id`, you can enter the following in the top filter bar:

* `service.name = YOUR_SERVICE_NAME`
* `trace.id = YOUR_TRACE_ID`
1. If you don't see the traces you want, you can run queries like these in the filter bar:
* `service.name = YOUR_SERVICE_NAME`
* `trace.id = YOUR_TRACE_ID`

<Callout variant="tip">
For more ways to filter traces, see our [distributed tracing UI page](/docs/understand-dependencies/distributed-tracing/ui-data/understand-use-distributed-tracing-ui).
</Callout>

#### Examine span details

When you find an interesting trace and click on it, the spans appear in a waterfall diagram. You can click on specific spans within the trace, which displays span details in the right panel.

If you are sending in span events, such as logs and errors, you can see their attributes and values:

1. Click **View span events**.

![Screenshot showing how to find span events.](./images/view-span-events.png)

2. To filter span events by exceptions, toggle **Only show exceptions**.

![Screenshot showing span events and how you can filter exceptions.](./images/span-events-exceptions.png)

### Transactions [#trx]

Use **Transactions** to identify slow or error transactions that might be causing a spike in your application's response time. To get a list of transactions: From the **Transaction Summary** page, select the transactions table.

### Databases [#databases]

The **Databases** page shows an application's database and cache data. The page shows individual database transactions as a sortable table, and shows operations, throughput, and response time as charts.

### Externals [#externals]

Externals capture calls to out-of-process services such as web services, resources in the cloud, and other network entities.

### Errors [#errors]

On the **Errors** page, you can see total errors as well as charts showing error count and error rate.
2. When you find an interesting trace, click on it to show a waterfall diagram showing the spans of the trace.
3. Click on specific spans within the trace to display span details in the right panel.
4. To view exceptions labelled by `otel.status = ERROR`, click **Error details** in the right pane.
![Screenshot showing the right pane with Error details section](./images/error-details.png)
5. To view exceptions handled by the app/service:
* Click **View span events** in the right pane.
* Filter by exceptions using the toggle **Only show exceptions**.
![Screenshot showing span events and how you can filter exceptions.](./images/span-events-exceptions.png)

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.

Here are some general tips about understanding span errors:
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
* 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

This table describes how different span errors are handled:

Expand Down Expand Up @@ -136,21 +114,32 @@ This table describes how different span errors are handled:
OpenTelemetry Errors
</td>

<td>
* `otel.status = error` displays spans containing an error.
* `otel.status_code` displays the status code in the error details box.
* `otel.status_description` displays the error description in the error details box.

<Callout variant="tip">
OpenTelemetry exceptions are displayed independently of span error status.

OpenTelemetry span event exceptions are accessible via span details when you click **View span events**, but exceptions are not necessarily associated with a span error status.
</Callout>
</td>
<td>
Exceptions containing the following are displayed in the **Error Details** box of the right pane:
* `otel.status = ERROR` displays the span as having an error.
* `otel.status_code` displays the status code.
* `otel.status_description` displays the error description.

<Callout variant="tip">
OpenTelemetry exceptions 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 OpenTelemetry span event exceptions by clicking **View span events** in the right pane.
</Callout>
</td>
</tr>
</tbody>
</table>

### Transactions [#trx]

Use **Transactions** to identify slow or error transactions that might be causing a spike in your application's response time. To get a list of transactions: From the **Transaction Summary** page, select the transactions table.

### Databases [#databases]

The **Databases** page shows an application's database and cache data. The page shows individual database transactions as a sortable table, and shows operations, throughput, and response time as charts.

### Externals [#externals]

Externals capture calls to out-of-process services such as web services, resources in the cloud, and other network entities.

### Logs [#logs]

The **Logs** page displays logs from your application. For more information about how to associate log data to your application in New Relic, see our [OpenTelemetry and logging documentation](/docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-logs).
Expand Down

0 comments on commit 7161029

Please sign in to comment.