Skip to content

Commit

Permalink
docs: Use specific URL examples in New Relic (#5918)
Browse files Browse the repository at this point in the history
Co-authored-by: Edward Huang <[email protected]>
  • Loading branch information
abernix and shorgi authored Aug 30, 2024
1 parent ed32712 commit f3fd8f6
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions docs/source/configuration/telemetry/exporters/metrics/new-relic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,39 @@ description: Configure the New Relic exporter for metrics via OpenTelemetry Prot

Enable and configure the [OTLP exporter](./otlp) for metrics in the GraphOS Router or Apollo Router Core for use with [New Relic](https://newrelic.com/).

For general tracing configuration, refer to [Router Metrics Configuration](./overview).
For general metrics configuration, refer to [Router Metrics Configuration](./overview).

## New Relic configuration

To configure the router, enable the [OTLP exporter](./otlp#configuration) and set `temporality: delta`, `endpoint: <new-relic-endpoint>` and `api-key: <new-relic-api-key>`. For example:
To configure the router, enable the [OTLP exporter](./otlp#configuration) with `temporality: delta` and the appropriate endpoint and New Relic API key.

<Note>

For New Relic, `temporality: delta` must be set and the value of the `endpoint` **must** end with `/v1/metrics`. The example below uses a common default for New Relic. Check your New Relic account to verify the correct value as the actual domain may vary by region.

</Note>

For example:

```yaml title="router.yaml"
telemetry:
exporters:
metrics:
otlp:
enabled: true
protocol: grpc

# Temporality MUST be set to delta. Failure to do this will result in incorrect metrics.
temporality: delta
# Endpoint for your region.
endpoint: <new-relic-endpoint>
protocol: grpc

# Ensure the endpoint provided ends with "/v1/metrics"
# Be sure to use the correct URL for your region.
endpoint: https://otlp.nr-data.net:4317/v1/metrics
grpc:
metadata:
"api-key":
- <new-relic-api-key>

api-key:
- "<new-relic-api-key>"
```
<Note>

**You must set `temporality: delta`**, otherwise metrics will not be visible in New Relic.

</Note>

For more details about New Relic configuration, see [New Relic's docs on OpenTelemetry configuration](https://docs.newrelic.com/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/opentelemetry-set-up-your-app/#review-settings).

0 comments on commit f3fd8f6

Please sign in to comment.