Simplify OpenTelemetry APM getting started documentation #17372
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,83 +10,111 @@ metaDescription: Set up OpenTelemetry-based APM monitoring with New Relic. | |
| freshnessValidatedDate: 2024-05-14 | ||
| redirects: | ||
| - /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/opentelemetry-set-up-your-app/ | ||
| - /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-java | ||
| - /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-python | ||
| --- | ||
|
|
||
| import moreintegrationsNativeOtlpNoCollector from 'images/more-integrations_diagram_native-otlp-no-collector.webp' | ||
|
|
||
| import moreintegrationsNativeOtlpWithCollector from 'images/more-integrations_diagram_native-otlp-with-collector.webp' | ||
|
|
||
| OpenTelemetry provides general purpose APIs and SDKs for collecting, processing, | ||
| and exporting observability data. One of the most popular use cases for these | ||
| APIs and SDKs is APM monitoring, where instrumentation is installed to monitor | ||
| an app or service. | ||
|
|
||
| This page describes common set up steps for OpenTelemetry based APM monitoring | ||
| with New Relic. | ||
|
|
||
| <Steps> | ||
| <Step> | ||
| ## Before you start [#prereqs] | ||
|
|
||
| * [Sign up](https://newrelic.com/signup) for a New Relic account. | ||
| * Get the [license key](https://one.newrelic.com/launcher/api-keys-ui.launcher) | ||
| for the New Relic account to which you want to report data. | ||
| </Step> | ||
|
|
||
| <Step> | ||
| ## Instrument your app or service with OpenTelemetry [#instrument] | ||
|
|
||
| OpenTelemetry provides | ||
| [language-specific APIs and SDKs](https://opentelemetry.io/docs/languages/) | ||
| for instrumenting applications. Most languages provide a rich set of | ||
| [instrumentation](https://opentelemetry.io/docs/concepts/instrumentation/) | ||
| for popular libraries and frameworks. | ||
|
|
||
| To help you get started, we offer a simple example application in a variety of | ||
| languages. For each language, the application is built using web framework popular | ||
| to that language. The examples below demonstrate how to configure: | ||
|
|
||
| * The service name which will display in New Relic. | ||
| * The OpenTelemetry Protocol (OTLP) exporter to send data to the | ||
| [New Relic OTLP endpoint](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp). | ||
| * Additional recommended settings to optimize OpenTelemetry for the best New | ||
| Relic experience. | ||
|
|
||
| <TechTileGrid> | ||
| <TechTile | ||
| name="Go agent" | ||
| icon="logo-go" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/go" | ||
| /> | ||
|
|
||
| <TechTile | ||
| name="Java" | ||
| icon="logo-java" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/java" | ||
| /> | ||
|
|
||
| <TechTile | ||
| name=".NET" | ||
| icon="logo-dotnet" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/dotnet" | ||
| /> | ||
|
|
||
| <TechTile | ||
| name="Node.js" | ||
| icon="logo-nodejs" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/javascript" | ||
| /> | ||
|
|
||
| <TechTile | ||
| name="Python" | ||
| icon="logo-python" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/python" | ||
|
There was a problem hiding this comment. Reminder to merge newrelic/newrelic-opentelemetry-examples#598 |
||
| /> | ||
|
|
||
| <TechTile | ||
| name="Ruby" | ||
| icon="logo-ruby" | ||
| to="https://github.com/newrelic/newrelic-opentelemetry-examples/tree/main/getting-started-guides/ruby" | ||
| /> | ||
|
|
||
| </TechTileGrid> | ||
|
|
||
| For more information about what instrumentation is available and more advanced | ||
| scenarios, see the relevant | ||
| [OpenTelemetry language documentation](https://opentelemetry.io/docs/languages/). | ||
|
|
||
| <Callout variant="important"> | ||
| You can use any language that OpenTelemetry supports to send data to New Relic. However, the examples above reflect only a subset of the [supported languages](https://opentelemetry.io/docs/languages/). | ||
|
|
||
| Missing your language? Request an example by [opening an issue on GitHub](https://github.com/newrelic/newrelic-opentelemetry-examples/issues/new?assignees=&labels=enhancement%2C+needs-triage&projects=&template=enhancement.md&title=)! | ||
| </Callout> | ||
|
|
||
| </Step> | ||
|
|
||
| <Step> | ||
| ## View your data in the New Relic UI [#view-data] | ||
|
|
||
| Onec your app is instrumented and configured to export data to New Relic, you should be able to find your data in the New Relic UI: | ||
|
|
||
| * Find your entity at <DoNotTranslate>**All entities -> Services - OpenTelemetry**</DoNotTranslate>. The entity name is set to the value of the app's `service.name` resource attribute. For more information on how New Relic service entities are derived from OpenTelemetry resource attributes, see [Services](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-best-practices-resources/#services) | ||
| * Use [NRQL](/docs/nrql/get-started/introduction-nrql-new-relics-query-language/) to query directly for [traces](https://one.newrelic.com/launcher/nr1-core.explorer?overlay=eyJuZXJkbGV0SWQiOiJkYXRhLWV4cGxvcmF0aW9uLnF1ZXJ5LWJ1aWxkZXIiLCJpbml0aWFsQWN0aXZlSW50ZXJmYWNlIjoibnJxbEVkaXRvciIsImluaXRpYWxOcnFsVmFsdWUiOiIiLCJpbml0aWFsUXVlcmllcyI6W3sibnJxbCI6IkZST00gU3BhbiBTRUxFQ1QgY291bnQoKikgd2hlcmUgbmV3cmVsaWMuc291cmNlPSclb3RscCUnIFRJTUVTRVJJRVMifV0sImluaXRpYWxDaGFydFNldHRpbmdzIjp7ImNoYXJ0VHlwZSI6IkNIQVJUX0xJTkUiLCJsaW1pdCI6NzU0MiwibGlua2VkRW50aXR5R3VpZCI6bnVsbCwibGlua2VkRGFzaGJvYXJkSWQiOm51bGwsInlTY2FsZSI6eyJzdGF0aWMiOmZhbHNlLCJkb21haW4iOltudWxsLG51bGxdfSwieVplcm8iOnRydWV9fQo=), [metrics](https://one.newrelic.com/launcher/nr1-core.explorer?overlay=eyJuZXJkbGV0SWQiOiJkYXRhLWV4cGxvcmF0aW9uLnF1ZXJ5LWJ1aWxkZXIiLCJpbml0aWFsQWN0aXZlSW50ZXJmYWNlIjoibnJxbEVkaXRvciIsImluaXRpYWxOcnFsVmFsdWUiOiIiLCJpbml0aWFsUXVlcmllcyI6W3sibnJxbCI6IkZST00gTWV0cmljIFNFTEVDVCBjb3VudCgqKSB3aGVyZSBuZXdyZWxpYy5zb3VyY2UgTElLRSAnJW90bHAlJyBUSU1FU0VSSUVTIn1dLCJpbml0aWFsQ2hhcnRTZXR0aW5ncyI6eyJjaGFydFR5cGUiOiJDSEFSVF9MSU5FIiwibGltaXQiOjc1NDIsImxpbmtlZEVudGl0eUd1aWQiOm51bGwsImxpbmtlZERhc2hib2FyZElkIjpudWxsLCJ5U2NhbGUiOnsic3RhdGljIjpmYWxzZSwiZG9tYWluIjpbbnVsbCxudWxsXX0sInlaZXJvIjp0cnVlfX0K), and [logs](https://one.newrelic.com/launcher/nr1-core.explorer?overlay=eyJuZXJkbGV0SWQiOiJkYXRhLWV4cGxvcmF0aW9uLnF1ZXJ5LWJ1aWxkZXIiLCJpbml0aWFsQWN0aXZlSW50ZXJmYWNlIjoibnJxbEVkaXRvciIsImluaXRpYWxOcnFsVmFsdWUiOiIiLCJpbml0aWFsUXVlcmllcyI6W3sibnJxbCI6IkZST00gTG9nIFNFTEVDVCBjb3VudCgqKSB3aGVyZSBuZXdyZWxpYy5zb3VyY2U9JyVvdGxwJScgVElNRVNFUklFUyJ9XSwiaW5pdGlhbENoYXJ0U2V0dGluZ3MiOnsiY2hhcnRUeXBlIjoiQ0hBUlRfTElORSIsImxpbWl0Ijo3NTQyLCJsaW5rZWRFbnRpdHlHdWlkIjpudWxsLCJsaW5rZWREYXNoYm9hcmRJZCI6bnVsbCwieVNjYWxlIjp7InN0YXRpYyI6ZmFsc2UsImRvbWFpbiI6W251bGwsbnVsbF19LCJ5WmVybyI6dHJ1ZX19Cg==). | ||
| * See [OpenTelemetry APM UI](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/get-started/apm-monitoring/opentelemetry-apm-ui) for more information. | ||
|
|
||
| If you can't find your entity and don't see your data with NRQL, see [OTLP troubleshooting](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/best-practices/opentelemetry-otlp-troubleshooting). | ||
| <InstallFeedback /> | ||
| </Step> | ||
| </Steps> | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
One thing worse discussing: We've removed any sort of general setup instructions, instead redirecting folks to language specific setup which are all are telling readers the same set of things. We have 6 sets of language specific examples while there are 11 otel language APIs / SDKs in some stage of development. If a user asks how to setup in a language we haven't provided an example for yet (seems inevitable) do you think we should just add a new example for that language rather than provide some generic set of instructions?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jack-berg I think we could add a line saying, "If you're looking for more language-specific examples, submit a request (add link to do this, such as submitting a GitHub issue)"
cc @alanwest thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a good idea @ally-sassman. Gives the user a concrete call to action, and provides us with a signal that someone is actively interested in an additional example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jack-berg Would either of you be notified if they submitted an issue here: https://github.com/newrelic/newrelic-opentelemetry-examples/issues/new?assignees=&labels=enhancement%2C+needs-triage&projects=&template=enhancement.md&title= ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes.