Skip to content

Commit

Permalink
feat(OTEL): Rearranged topics on UI page to alphabetical
Browse files Browse the repository at this point in the history
  • Loading branch information
@rhetoric101
rhetoric101 committed Sep 21, 2021
1 parent d9584a3 commit ca76837
Showing 1 changed file with 9 additions and 84 deletions.
93 changes: 9 additions & 84 deletions ...telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ If you need help understanding how we display your data, see the left-pane optio

After you click on a service in the **Explorer** tab, you see the **Summary** page listing various golden signals about your entity. Golden signals are key monitoring details such as response time, throughput, and error rate. By using this information, you can quickly decide if you need to dig deeper.

For your data to appear in this section, make sure it has the following attributes:
For your data to appear in this section, make sure it has the following:

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
UI pane
UI area
</th>
<th>
Attribute
Expand Down Expand Up @@ -105,7 +105,7 @@ The following attributes are typically not added explicitly to spans. Rather, th
[span.kind](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#spankind)
</td>
<td>
A span’s kind is generally set when [starting a span](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span-creation). New Relic uses span.kind to infer that a span is an entry point to a given service. When span.kind = server or consumer it is considered an entry point. When `span.kind = client` or `producer`, it is considered a call to an external service or database system.
A span’s kind is generally set when [starting a span](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#span-creation). New Relic uses `span.kind` to infer that a span is an entry point to a given service. When `span.kind = server` or `consumer` it is considered an entry point. When `span.kind = client` or `producer`, it is considered a call to an external service or database system.

</td>
</tr>
Expand All @@ -115,17 +115,17 @@ The following attributes are typically not added explicitly to spans. Rather, th
</td>
<td>
* A span’s [status is set](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#set-status) using the span API. The `otel.status_code` attribute is how it is manifested by New Relic.
* The OIE experience primarily uses `otel.status_code` for the purpose of identifying errors.
* The UI primarily uses `otel.status_code` for the purpose of identifying errors.
</td>
</tr>
</tbody>
</table>

#### Narrow your search
#### Find traces and their associated spans

Here are some ways to target your searches:

1. To narrow the search for traces you want, you can run queries like these in the filter bar:
1. To find the traces you want, you can run queries like these in the filter bar:
* `service.name = YOUR_SERVICE_NAME`
* `trace.id = YOUR_TRACE_ID`
2. When you find an interesting trace, click on it to display a waterfall diagram showing the spans of the trace.
Expand Down Expand Up @@ -166,83 +166,17 @@ If you have span events, links for these appear in the right pane:
OpenTelemetry exceptions handled by the app/service are displayed independently of span error status and are not necessarily associated with a span error status.
</Callout>

#### View spans with errors

After you click on a span in the trace waterfall view, you can see span errors in the right panel under **Error details**.

![Screenshot showing the right pane with Error details section](./images/view-span-errors.png "Screenshot showing the right pane with Error details section")

The error details are populated by spans containing `otel.status_code = ERROR` and display the content of `otel.status_description`.

To narrow your search for spans with errors, you can enter `otel.status_code = ERROR` directly in the distributed tracing filter bar.

#### View span events

If you send span events as described by the [OpenTelemetry specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/api.md#add-events), you can view them in the New Relic UI. Span events have two general types:
* Exceptions
* Non-exceptions (for example, logs)

If you have span events, links for these appear in the right pane:

1. Click on a span in the waterfall view.
2. In the right pane, click **View span events**, or you can expand **Error details** and click the link at the bottom of the errors.

![Screenshot showing the right pane showing the two links for span events](./images/view-span-events.png "Screenshot showing the right pane showing the two links for span events")

3. When you're in span events and only want to view exceptions, toggle **Only show exceptions**.

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

<Callout variant="tip">
OpenTelemetry exceptions handled by the app/service are displayed independently of span error status. These exceptions are not necessarily associated with a span error status.
</Callout>

For your data to appear in this section, make sure it has the following attributes:

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
UI pane
</th>
<th>
Description
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Top Transactions
</td>
<td>
* `span.kind = server` or `consumer`
* Facets by span name
</td>
</tr>
<tr>
<td>
Throughput
</td>
<td>
* `span.kind = server` or `consumer`
* Facets by span name
</td>
</tr>
</tbody>
</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.

For your data to appear in this section, make sure it has the following attributes:
For your data to appear in this section, make sure it has the following:

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
UI pane
UI area
</th>
<th>
Attribute
Expand Down Expand Up @@ -289,12 +223,8 @@ For your data to appear in this section, make sure it has the following attribut

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

<<<<<<< HEAD
<<<<<<< HEAD
For your data to appear in this section, make sure it has the following:
=======
For your data to appear in this section, make sure it has the following attributes:
>>>>>>> feat(OTEL): Added attributes you need to light up UI.


* `span.kind = client` or `producer`
* `db.system` is not present
Expand All @@ -313,11 +243,6 @@ For your data to appear in this section, make sure it has the following:
* Requires a unique `service.instance.id` attribute for rendering the list of JVMs
* `Service.instance.id` is an OpenTelemetry resource attribute

<<<<<<< HEAD
=======
>>>>>>> feat(OTEL): Added span event information that is from another branch
=======
>>>>>>> feat(OTEL): Added attributes you need to light up UI.
### 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 ca76837

Please sign in to comment.