Skip to content

Commit

Permalink
fix(otel): Added steps to infra collector instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
rhetoric101 committed Mar 24, 2022
1 parent 7391992 commit e3bd332
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The collector setup is part of the larger process of setting up OpenTelemetry wi

If you're looking for help with other collector use cases, see the [newrelic-opentelemetry-examples](https://github.com/newrelic/newrelic-opentelemetry-examples) repository.

## Install the OpenTelemetry collector [#install-generic]
## Step 1: Install the OpenTelemetry collector [#install-generic]

To do a basic installation for single hosts in the cloud or on-premises, see [OpenTelemetry's instructions](https://opentelemetry.io/docs/collector/getting-started/#linux-packaging) for up-to-date installation steps from the community. Instructions are available for the following:

Expand All @@ -28,7 +28,7 @@ Your deployment experience might vary depending on which vendor-specific distrib
To set up infrastructure monitoring, you need to install and configuring components that are included in the `collector-contrib` release. For example, the host receiver is required to collect basic host metrics such as CPU, memory, disk and network stats and is only available in the [OpenTelemetry collector-contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) release.
</Callout>

## Configure the OpenTelemetry collector for New Relic [#configure]
## Step 2: Configure the OpenTelemetry collector for New Relic [#configure]

These examples are meant to serve as a starting point from which you can extend, customize, and validate configurations before using them in production.

Expand Down Expand Up @@ -197,11 +197,15 @@ service:
extensions: [health_check]
```

## Browsing host data in infrastructure UI [#using-ui]
## Step 3: View your data [#using-ui]

Using the recommended configuration for the host receiver enables all the standard capabilities of the [Infrastructure UI](/docs/infrastructure/infrastructure-ui-pages/infrastructure-ui-entities#access-new-ui) (New Host UI) experience.
You can view your collector data in a variety of places in the New Relic UI.

## Query host metrics [#query-host-metrics]
### Browsing host data in infrastructure UI [#using-ui]

By using the recommended configuration for the host receiver, you can view data through the standard features in the [Infrastructure UI](/docs/infrastructure/infrastructure-ui-pages/infrastructure-ui-entities#access-new-ui) (New Host UI) experience.

### Query host metrics [#query-host-metrics]

Once metrics are successfully ingested in New Relic, they are available in data explorer and query builder.

Expand All @@ -227,6 +231,9 @@ The following NRQL queries show examples to help you explore the metrics you rec

Learn more about [querying the metric data type](/docs/data-apis/understand-data/metric-data/query-metric-data-type).

## What's next? [#next]

After you set up your collector, check out our [best-practices](/docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-concepts/) guide for tips to improve your use of OpenTelemetry and New Relic.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You have two choices for exporting data to New Relic via OTLP:

![Diagram showing the export to New Relic from a collector](./images/native_otlp_with_collector.png "Diagram showing the export to New Relic from a collector")
<figcaption>
You can set up the collector as a gateway that receives, processes, and exports to the New Relic OTLP receiver. Alternatively, you can set up the collector as a sidecar agent with your app.
You can set up the collector as a gateway that receives, processes, and exports to the New Relic OTLP receiver. Alternatively, you can set up the collector as an agent that runs with your application or runs on the same host.
</figcaption>


Expand Down Expand Up @@ -204,4 +204,4 @@ New Relic currently supports [opentelemetry-specification](https://github.com/op

## What's next? [#next]

After you do your initial setup, check out our [best-practices](/docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-concepts/) guide for tips about various configurations to improve your use of OpenTelemetry and New Relic.
After you do your initial setup, check out our [best-practices](/docs/integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-concepts/) guide for tips to improve your use of OpenTelemetry and New Relic.

0 comments on commit e3bd332

Please sign in to comment.