Skip to content

Commit

Permalink
PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
jack-berg committed May 6, 2024
1 parent 1566532 commit 5ac18b8
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ tags:
- OTLP
- Troubleshoot
metaDescription: Troubleshoot common OTLP ingest errors
freshnessValidatedDate: never
freshnessValidatedDate: 2024-05-06
---

New Relic has supported [native OTLP ingest](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp/) for several years. In the process of working through support cases that come up from time to time, we've learned about common issues users face. For some, the problem is easy to identify and fix. Others are deviously tricky, given that the internet is unreliable and there are many components (software, networking, hardware, etc) involved under the control of various parties (customers, New Relic, and public networking infrastructure outside the control of either). With so much complexity, configuration, and failure points, it can be difficult to determine which is at fault an how to best address.
New Relic has supported [native OTLP ingest](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp/) for several years. In the process of working through support cases that come up from time to time, we've learned about common issues users face. For some, the problem is easy to identify and fix. Others are deviously tricky, given that the internet is unreliable and there are many components (software, networking, hardware, etc.) involved under the control of various parties, such as customers, New Relic, and public networking infrastructure outside the control of either. With so much complexity, configuration, and failure points, it can be difficult to determine which is at fault and how to best address.

Filing and working through a support case can be time consuming and at times frustrating for customers (and for New Relic!). Therefore, we've put together this troubleshooting guide to help establish a shared understanding, and provide tools to self-diagnose and fix issues when possible.
Working through a support case can be time consuming and at times frustrating for customers (and for New Relic!). Therefore, we've put together this troubleshooting guide to help establish a shared understanding, and provide tools to self-diagnose and fix issues when possible.

First, please review the New Relic [OTLP configuration requirements / recommendations](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp/#configuration). It contains essential advice and context that anyone looking to use OTLP with New Relic should be aware of.
First, please review the New Relic [OTLP configuration requirements / recommendations](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp/). It contains essential advice and context that anyone looking to use OTLP with New Relic should be aware of.

The [General Triaging](#general-triaging) section describes basic troubleshooting steps you should follow when you encounter some issue with OTLP.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ freshnessValidatedDate: never

[OpenTelemetry Protocol](https://github.com/open-telemetry/opentelemetry-proto/blob/main/docs/specification.md), or OTLP for short, is a general purpose telemetry data delivery protocol designed for the OpenTelemetry project. Each OpenTelemetry language SDK provides OTLP exporters, and the OpenTelemetry collector has OTLP receivers and exporters. Additionally, various tools outside the OpenTelemetry project have added support for OTLP export.

New Relic supports native OTLP ingest, and recommends OTLP as the means for sending OpenTelemetry data to New Relic. This document describes New Relic OTLP support, including configuration requirements and recommendations.
New Relic supports native OTLP ingest, and recommends it as the preferred method for sending OpenTelemetry data to the New Relic platform. This document delves into New Relic's OTLP support, including configuration requirements and recommendations.

## Config: Before you start [#prereqs]

Expand Down Expand Up @@ -164,7 +164,7 @@ If using the collector, prefer the [otlphttpexporter](https://github.com/open-te
id="note-endpoints"
title="Additional endpoint details"
>
Per the [OpenTelemetry spec](https://opentelemetry.io/docs/specs/otel/protocol/exporter/#endpoint-urls-for-otlphttp) on endpoint URLs for OTLP/HTTP: If you are sending OTLP/HTTP traffic and using the signal agnostic environment variable (`OTEL_EXPORTER_OTLP_ENDPOINT`), you can simply set `OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net:{port}` and the exporter should append the appropriate path for the signal type (i.e., `v1/traces` or `v1/metrics`).
Per the [OpenTelemetry spec](https://opentelemetry.io/docs/specs/otel/protocol/exporter/#endpoint-urls-for-otlphttp) on endpoint URLs for OTLP/HTTP, if you are sending OTLP/HTTP traffic and using the signal agnostic environment variable (`OTEL_EXPORTER_OTLP_ENDPOINT`), you can simply set `OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net:{port}` and the exporter should append the appropriate path for the signal type (i.e., `v1/traces` or `v1/metrics`).

If you are using a signal-specific environment variable (i.e., `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` and/or `OTEL_EXPORTER_OTLP_METRICS_ENDPOINT`), you must include the appropriate path. For example, `OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=https://otlp.nr-data.net:4318/v1/traces`. Not doing so will result in a 404. Note that this signal-specific environment variables take precedence over signal-agnostic environment variables.
</Collapser>
Expand Down
4 changes: 2 additions & 2 deletions src/nav/opentelemetry.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ pages:
pages:
- title: OTLP
pages:
- title: New Relic OTLP Endpoint
- title: New Relic OTLP endpoint
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp
- title: OTLP Troubleshooting
- title: OTLP troubleshooting
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp-troubleshooting
- title: Logs
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-best-practices-logs
Expand Down

0 comments on commit 5ac18b8

Please sign in to comment.