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 committed Sep 21, 2021
1 parent a3ba7cc commit 906d8f3
Showing 1 changed file with 48 additions and 48 deletions.
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 following descr

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,56 +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. These exceptions are not necessarily associated with a span error status.
</Callout>

### 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.

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 @@ -262,7 +223,7 @@ 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.

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:

* `span.kind = client` or `producer`
* `db.system` is not present
Expand Down Expand Up @@ -294,6 +255,45 @@ For your data to appear in this section, make sure it has the following:

For selected OpenTelemetry languages, you can see information about your metrics in this section. Also, if you are using the Prometheus exporter with OpenTelemetry, you can view your metric data here.

### 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.

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

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
UI area
</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>

## Data explorer and query builder [#query-builder]

Explore your metrics and traces using the [data explorer](/docs/query-your-data/explore-query-data/data-explorer/introduction-data-explorer), or write your own queries in query builder using NRQL. For more on how to query your data once it's in New Relic, see [Query your data](/docs/query-your-data/explore-query-data/explore-data/introduction-querying-new-relic-data) and [Introduction to NRQL](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language).

0 comments on commit 906d8f3

Please sign in to comment.