Skip to content

Latest commit

 

History

History
 
 

README.md

nrdot-collector-host

Status
Distro nrdot-collector-host
Stability public
Artifacts Docker images on DockerHub
Linux packages and archives under GitHub Releases

A distribution of the NRDOT collector focused on

  • monitoring the host the collector is deployed on via hostmetricsreceiver and filelogreceiver
  • enriching other OTLP data with host metadata via the otlpreceiver and resourcedetectionprocessor

Note: See general README for information that applies to all distributions.

Installation

The following instructions assume you have read and understood the general installation instructions.

Containerized Environments

If you're deploying the host distribution as a container, make sure to configure the root_path and mount the host's file system accordingly, otherwise NRDOT will not be able See also our troubleshooting guide for more details.

Configuration

Note: See general README for information that applies to all distributions.

Distribution-specific configuration

Environment Variable Description Default
OTEL_RESOURCE_ATTRIBUTES Key-value pairs to be used as resource attributes, see OTel Docs N/A

Enable process metrics

Process metrics are disabled by default as they are quite noisy. If you want to enable them, you can do so by reconfiguring the hostmetricsreceiver, see also receiver docs. Note that there is a processesscraper (system.processes.* metrics) and a processscraper (process.* metrics) with separate options. An example configuration would look like this:

newrelic/nrdot-collector-host --config /etc/nrdot-collector-host/config.yaml \
--config='yaml:receivers::hostmetrics::scrapers::processes: ' \
--config='yaml:receivers::hostmetrics::scrapers::process: { metrics: { process.cpu.utilization: { enabled: true }, process.cpu.time: { enabled: false } } }'

Troubleshooting

Please refer to our troubleshooting guide.