Skip to content

Commit

Permalink
fix(otel): Rename quick-start and tweak prereqs.
Browse files Browse the repository at this point in the history
  • Loading branch information
rhetoric101 committed Mar 24, 2022
1 parent 98a1396 commit 3ac6bcb
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Instead of sending telemetry from your apps directly to New Relic, you can first

The Docker example below is meant to serve as starting point from which you can extend, customize, and validate configurations before using them in production.

The collector setup is part of the larger process of setting up OpenTelemetry with New Relic. If you haven't already done so, make sure you've completed "Step 2. Instrument your service with OpenTelemetry" in our [primary instructions](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start/#instrument). Then, as a substitute for "Step 3. Export your telemetry data to New Relic," complete the steps below:
The collector setup is part of the larger process of setting up OpenTelemetry with New Relic. Before following the collector steps below, make sure you've completed the [preceding setup steps](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start). If you've completed the previous steps, complete the following:

1. Save the following as `otel-config.yaml`:

Expand Down Expand Up @@ -64,7 +64,7 @@ docker run --rm \
--config otel-config.yaml
```

3. If you are completing the installation steps, return to [Step 5. View your data in the New Relic UI](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start/#view-data).
3. If you are completing the installation steps, return to [Step 5. View your data in the New Relic UI](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-setup/#view-data).



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,29 +14,18 @@ redirects:
- /docs/integrations/open-source-telemetry-integrations/opencensus/opencensus-exporter
- /docs/integrations/open-source-telemetry-integrations/open-source-telemetry-integration-list/new-relics-opencensus-integration
---
Are you already familiar with [OpenTelemetry](https://opentelemetry.io/) and want to begin the setup? Check out our quick start:

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start"
variant="primary"
>
Quick start
</ButtonLink>
</ButtonGroup>
OpenTelemetry is a toolkit you can use to gather telemetry data from your applications and to export that data to New Relic. Once the data is in New Relic, you can use the New Relic platform to analyze the data and resolve application issues. OpenTelemetry has features that overlap with New Relic agents, so review the information below to see if this tool will help you accomplish your telemetry goals.

If you don't have one already, [create a New Relic account](https://newrelic.com/signup). It's free, forever.

If you're just getting acquainted with OpenTelemetry, this is what we'll explore here:
If you're already familiar with OpenTelemetry and want to get started, see our [setup](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-setup) instructions. Here are some topics to help your get acquainted with OpenTelemetry:

* [Benefits of OpenTelemetry](#benefits)
* [Should I use OpenTelemetry or New Relic agents?](#choice)
* [How OpenTelemetry works with New Relic](#how-it-works)

## Benefits of OpenTelemetry [#benefits]

OpenTelemetry provides a secure, vendor-neutral [specification](https://github.com/open-telemetry/opentelemetry-specification) for service instrumentation so that you can export data to distinct backends of your choice, such as New Relic. OpenTelemetry offers a single set of APIs and libraries that standardize how you collect and transfer telemetry data for your services.
OpenTelemetry provides a secure, vendor-neutral [specification](https://github.com/open-telemetry/opentelemetry-specification) for service instrumentation so that you can export data to distinct back-ends of your choice, such as New Relic. OpenTelemetry offers a single set of APIs and libraries that standardize how you collect and transfer telemetry data for your services.

The following components make up the OpenTelemetry project:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OpenTelemetry quick start
title: OpenTelemetry setup
tags:
- Integrations
- Open source telemetry integrations
Expand All @@ -11,6 +11,7 @@ redirects:
- /docs/integrations/open-source-telemetry-integrations/opentelemetry/set-opentelemetry-new-relic
- /docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start-guide
- /docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-architecture-recipes/
- /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start
---

OpenTelemetry is a flexible toolkit that you can implement in a variety of ways. We recommend a basic five-step approach for setting up OpenTelemetry with New Relic. Here's an overview of the process, followed by details for each step.
Expand Down Expand Up @@ -190,7 +191,7 @@ Choose one of the following to see examples for setting up your collector to exp

## Step 5: View your data in the New Relic UI [#view-data]

Once you’ve instrumented your service and configured it to export its data to New Relic, watch the New Relic One user interface for your [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==)!
Once you’ve instrumented your service and configured it to export its data to New Relic, watch the New Relic One user interface for your [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==).

The UI for OpenTelemetry has some similarities to the APM agent UI, so if you are familiar with that, you can go right to the UI. If you need help understanding your OpenTelemetry UI options or how to make sure your data appears in the UI, see [View your OpenTelemetry data in New Relic](/docs/integrations/open-source-telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic).

Expand Down
2 changes: 1 addition & 1 deletion src/nav/integrations.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pages:
pages:
- title: Intro to OpenTelemetry
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/introduction-opentelemetry-new-relic
- title: Quick start
- title: Setup
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-quick-start
- title: View your OpenTelemetry data
path: /docs/more-integrations/open-source-telemetry-integrations/opentelemetry/view-your-opentelemetry-data-new-relic
Expand Down

0 comments on commit 3ac6bcb

Please sign in to comment.