You can collect metrics about your infrastructure hosts with OpenTelemetry if you set up the host receiver in a collector. The collector is a component of OpenTelemetry that collects, processes, and exports telemetry data to New Relic (or any observability back-end).
If you're looking for help with other collector use cases, see the newrelic-opentelemetry-examples repository.
Make sure you've completed the following before going further:
- If you haven't already done so, sign up for a free New Relic account.
- Get the license key for the New Relic account to which you want to report data.
To do a basic installation for single hosts in the cloud or on-premises, see OpenTelemetry's instructions for up-to-date installation steps from the community. Instructions are available for the following:
- Linux: Debian systems
- Linux: Red Hat
- Docker, Kubernetes, and other options
Your deployment experience might vary depending on which vendor-specific distributions you use. For example, installation via a package manager might be available for Linux hosts.
To set up infrastructure monitoring, you need to install and configure 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 release.
This collector example is meant to serve as a starting point from which you can extend, customize, and validate configurations before using them in production.
collector-contrib release provides a
hostreceiver that generates metrics about the system scraped from various sources. Deploy the collector as an agent when you use a
When using the host receiver as part of the collector configuration, New Relic automatically detects host metrics as part of a
Host entity and will synthesize its golden metrics providing the same experience as with the New Relic infrastructure agent. The following are the configuration requirements to enable the
Host entity experience in New Relic UI:
host.idattribute is present in host metrics.
container.idattributes are not present in host metrics.
Learn more about available metrics and advanced configurations from the OpenTelemetry documentation in GitHub.
config.yaml with these recommended parameters:
CPU, load, memory, and disk utilization metrics require otelcol-contrib release
v0.47.0 or greater.
Enable host metrics.
Keep the following in mind:
The batch processor accepts spans, metrics, or logs and places them into batches. Batching helps better compress the data and reduce the number of outgoing connections required to transmit the data. This processor supports both size and time based batching.
The memory limiter processor is used to prevent out of memory situations on the collector.
Putting checks in place is important because:
The cumulative delta processor converts cumulative sum metrics to cumulative delta. This helps you query system metric rates more easily in New Relic.
Here is a sample configuration YAML file. Be sure to do the following:
- Replace OTLP_ENDPOINT_HERE with the appropriate endpoint.
- Replace YOUR_KEY_HERE with your account's license key.
extensions:health_check:receivers:hostmetrics:collection_interval: 20sscrapers:cpu:metrics:system.cpu.utilization:enabled: trueload:memory:metrics:system.memory.utilization:enabled: truedisk:filesystem:metrics:system.filesystem.utilization:enabled: truenetwork:paging:metrics:system.paging.utilization:enabled: trueprocesses:process:processors:memory_limiter:check_interval: 1slimit_mib: 1000spike_limit_mib: 200batch:cumulativetodelta:include:metrics:- system.network.io- system.disk.operations- system.network.dropped- system.network.packets- process.cpu.timematch_type: strictresource:attributes:- key: host.idfrom_attribute: host.nameaction: upsertresourcedetection:detectors: [env, system]exporters:otlp:endpoint: OTLP_ENDPOINT_HEREheaders:api-key: YOUR_KEY_HEREservice:pipelines:metrics:receivers: [hostmetrics]processors: [batch, resourcedetection, resource, cumulativetodelta]exporters: [otlp]extensions: [health_check]
You can view your collector data in a variety of places in the New Relic UI.
By using the recommended configuration for the host receiver, you can view data through the standard features in the Infrastructure UI (New Host UI) experience.
The following NRQL queries show examples to help you explore the metrics you received:
Listing number of metric updates ingested by metric nameSELECT count(*) FROM Metric WHERE metricName LIKE 'system.%' FACET metricName LIMIT max
Querying specific metrics faceted by hostSELECT average(system.disk.operations) FROM Metric FACET host.name TIMESERIES
Listing dimensions available for a given metricSELECT keyset() FROM Metric WHERE metricName = 'system.disk.operations'
Learn more about querying the metric data type.
After you set up your collector, check out our best practices guide for tips to improve your use of OpenTelemetry and New Relic.