Skip to content

Commit

Permalink
Merge pull request #3357 from newrelic/doc-7147-otel-span-events
Browse files Browse the repository at this point in the history
New content for span events.
  • Loading branch information
rhetoric101 committed Sep 14, 2021
2 parents 2bebb1c + c4547f3 commit cf64012
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 17 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.
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 @@ -36,7 +36,7 @@ If you still need information about the New Relic Exporter, see the [opentelemet

The [OpenTelemetry Collector with New Relic Exporter](https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/collector/nr-exporter-docker) example demonstrates what such a setup might look like.

## Endpoint Configuraion for New Relic exporters [#h2-change-endpoints]
## Endpoint configuration for New Relic exporters [#h2-change-endpoints]

You can change the New Relic endpoints where you send your data.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,64 @@ After you import OpenTelemetry data into New Relic, you can use a variety of too

## Explorer: Get the big picture along with the details [#explorer]

The New Relic explorer is a good place to get overview information about your applications, as well as detailed information, such as distributed tracing.
The New Relic **Explorer** tab is a good place to start gathering information about your services:

To get started with the explorer:

1. Go to [one.newrelic.com](https://one.newrelic.com) and click **Explorer**.
1. Go to [one.newrelic.com](https://one.newrelic.com).
2. In the left sidebar, click **Services - OpenTelemetry**:

![Screen capture showing how to filter for OpenTelemetry services.](./images/explorer_otel_services.png "Filter for OpenTelemetry to see only those entities.")

3. Click the service you want to know more about.
3. In the center pane, click the service you want to know more about, or find your service by entering the name in the top filter bar.

If you need help understanding the data, see the explanations which follow.
If you need help understanding how we display your data, see the following descriptions of the left-pane options in the UI.

### Summary page [#summary]

The opening page of the explorer is 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.
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.

### Distributed tracing [#tracing]

When you access distributed tracing through the explorer, you are looking at traces that include that service. Once you’re in that service, you can filter spans to find the ones you want. For example, to query `service.name` or `trace.id`, you can use the following:
In **Distributed tracing**, you can locate traces and examine span details:

1. To narrow the search for 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.
3. Click on specific spans within the trace to display span details in the right panel.

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

#### 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")

* `service.name = YOUR_SERVICE_NAME`
* `trace.id = YOUR_TRACE_ID`
The error details are populated by spans containing `otel.status_code = ERROR` and display the content of `otel.status_description`.

For more ways to filter and analyze your spans, see our [distributed tracing UI page](/docs/understand-dependencies/distributed-tracing/ui-data/understand-use-distributed-tracing-ui).
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 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">
If you prefer to search traces across all New Relic accounts in your organization, you can go outside explorer: **[one.newrelic.com](https://one.newrelic.com) > Apps > Favorites > Distributed tracing.**
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]
Expand All @@ -55,10 +85,6 @@ The **Databases** page shows an application's database and cache data. The page

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.

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

Please sign in to comment.