Grafana Agent FlowReferenceComponentsprometheus.​integration.​node_exporter


The prometheus.integration.node_exporter component embeds node_exporter which exposes a wide variety of hardware and OS metrics for *nix-based systems.

The node_exporter itself is comprised of various collectors, which can be enabled and disabled at will. For more information on collectors, refer to the collectors-list section.

The prometheus.integration.node_exporter component can only appear once per configuration file, and a block label must not be passed to it.


prometheus.integration.node_exporter {


The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values.

set_collectorslist(string)Overrides the default set of enabled collectors with the collectors
enable_collectorslist(string)Collectors to mark as
disable_collectorslist(string)Collectors to mark as
include_exporter_metricsbooleanWhether metrics about the exporter itself should be reported.falseno
procfs_pathstringThe procfs mountpoint./procno
sysfs_pathstringThe sysfs mountpoint./sysno
rootfs_pathstringSpecify a prefix for accessing the host filesystem./no

set_collectors defines a hand-picked list of enabled-by-default collectors. If set, anything not provided in that list is disabled by default. See the Collectors list for the default set of enabled collectors for each supported operating system.

enable_collectors enables more collectors over the default set, or on top of the ones provided in set_collectors.

disable_collectors extends the default set of disabled collectors. In case of conflicts, it takes precedence over enable_collectors.


The following blocks are supported inside the definiton of prometheus.integration.node_exporter to configure collector-specific options:

bcachebcacheConfigures the bcache
cpucpuConfigures the cpu
diskdiskConfigures the diskstats
ethtoolethtoolConfigures the ethtool
filesystemfilesystemConfigures the filesystem
ipvsipvsConfigures the ipvs
ntpntpConfigures the ntp
netclassnetclassConfigures the netclass
netdevnetdevConfigures the netdev
netstatnetstatConfigures the netstat
perfperfConfigures the perf
powersupplypowersupplyConfigures the powersupply
runitrunitConfigures the runit
supervisordsupervisordConfigures the supervisord
systemdsystemdConfigures the systemd
tapestatstapestatsConfigures the tapestats
textfiletextfileConfigures the textfile
vmstatvmstatConfigures the vmstat

bcache block

priority_statsbooleanEnable exposing of expensive bcache priority stats.falseno

cpu block

guestbooleanEnable the node_cpu_guest_seconds_total metric.trueno
infobooleanEnable the cpu_info metric for the cpu collector.trueno
bugs_includestringRegexp of bugs field in cpu info to
flags_includestringRegexp of flags field in cpu info to

disk block

ignored_devicesstringRegexp of devices to ignore for diskstats."^(ram|loop|fd|(h|s|v|xv)d[a-z]|nvme\\d+n\\d+p)\\d+$"no

ethtool block

device_excludestringRegexp of ethtool devices to exclude (mutually exclusive with device_include).no
device_includestringRegexp of ethtool devices to include (mutually exclusive with device_exclude).no
metrics_includestringRegexp of ethtool stats to include..*no

filesystem block

fs_types_excludestringRegexp of filesystem types to ignore for filesystem collector.(see below )no
mount_points_excludestringRegexp of mount points to ignore for filesystem collector."^/(dev|proc|sys|var/lib/docker/.+)($|/)"no
mount_timeoutdurationHow long to wait for a mount to respond before marking it as stale."5s"no

fs_types_exclude defaults to the following regular expression string:


ipvs block

backend_labelslist(string)Array of IPVS backend stats labels.[local_address, local_port, remote_address, remote_port, proto, local_mark]no

ntp block

serverstringNTP server to use for the collector.""no
server_is_localbooleanCertifies that the server address is not a public ntp server.falseno
ip_ttlintTTL to use while sending NTP query.1no
local_offset_tolerancedurationOffset between local clock and local ntpd time to tolerate."1ms"no
max_distancedurationMax accumulated distance to the root."3466080us"no
protocol_versionintNTP protocol version.4no

netclass block

ignore_invalid_speed_devicebooleanIgnore net devices with invalid speed values.falseno
ignored_devicesstringRegexp of net devices to ignore for netclass collector."^$"no

netdev block

address_infobooleanEnable collecting address-info for every device.falseno
device_excludestringRegexp of net devices to exclude (mutually exclusive with device_include).no
device_includestringRegexp of net devices to include (mutually exclusive with device_exclude).no

netstat block

fieldsstringRegexp of fields to return for netstat collector.(see below)no

fields defaults to the following regular expression string:


perf block

cpusstringList of CPUs from which perf metrics should be
tracepointlist(string)Array of perf tracepoints that should be

powersupply block

ignored_suppliesstringRegexp of power supplies to ignore for the powersupplyclass collector."^$"no

runit block

service_dirstringPath to runit service directory."/etc/service"no

supervisord block

urlstringXML RPC endpoint for the supervisord collector."http://localhost:9001/RPC2"no

Setting SUPERVISORD_URL in the environment overrides the default value. An explicit value in the block takes precedence over the environment variable.

systemd block

enable_restartsbooleanEnables service unit metric service_restart_totalfalseno
start_timebooleanEnables service unit metric unit_start_time_secondsfalseno
task_metricsbooleanEnables service unit task metrics unit_tasks_current and unit_tasks_max.falseno
unit_excludestringRegexp of systemd units to exclude. Units must both match include and not match exclude to be collected.".+\\.(automount|device|mount|scope|slice)"no
unit_includestringRegexp of systemd units to include. Units must both match include and not match exclude to be collected.".+"no

tapestats block

ignored_devicesstringRegexp of tapestats devices to ignore."^$"no

textfile block

textfile_directorystringDirectory to read *.prom files from for the textfile

vmstat block

fieldsstringRegexp of fields to return for the vmstat collector."^(oom_kill|pgpg|pswp|pg.*fault).*"no

Exported fields

The following fields are exported and can be referenced by other components.

targetslist(map(string))The targets that can be used to collect node_exporter metrics.

For example, the targets could either be passed to a prometheus.relabel component to rewrite the metrics’ label set, or to a prometheus.scrape component that collects the exposed metrics.

Component health

prometheus.integration.node_exporter is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

prometheus.integration.node_exporter does not expose any component-specific debug information.

Debug metrics

prometheus.integration.node_exporter does not expose any component-specific debug metrics.

Collectors list

The following table lists the available collectors that node_exporter brings bundled in. Some collectors only work on specific operating systems; enabling a collector that is not supported by the host OS where Flow is running is a no-op.

Users can choose to enable a subset of collectors to limit the amount of metrics exposed by the prometheus.integration.node_exporter component, or disable collectors that are expensive to run.

NameDescriptionOSEnabled by default
arpExposes ARP statistics from /proc/net/arp.Linuxyes
bcacheExposes bcache statistics from /sys/fs/bcache.Linuxyes
bondingExposes the number of configured and active slaves of Linux bonding interfaces.Linuxyes
boottimeExposes system boot time derived from the kern.boottime sysctl.Darwin, Dragonfly, FreeBSD, NetBSD, OpenBSD, Solarisyes
btrfsExposes statistics on btrfs.Linuxyes
buddyinfoExposes statistics of memory fragments as reported by /proc/buddyinfo.Linuxno
conntrackShows conntrack statistics (does nothing if no /proc/sys/net/netfilter/ present).Linuxyes
cpuExposes CPU statistics.Darwin, Dragonfly, FreeBSD, Linux, Solarisyes
cpufreqExposes CPU frequency statistics.Linux, Solarisyes
devstatExposes device statistics.Dragonfly, FreeBSDno
diskstatsExposes disk I/O statistics.Darwin, Linux, OpenBSDyes
dmiExposes DMI information.Linuxyes
drbdExposes Distributed Replicated Block Device statistics (to version 8.4).Linuxno
drmExposes GPU card info from /sys/class/drm/card?/device.Linuxno
edacExposes error detection and correction statistics.Linuxyes
entropyExposes available entropy.Linuxyes
ethtoolExposes ethtool stats.Linuxno
execExposes execution statistics.Dragonfly, FreeBSDyes
fibrechannelExposes FibreChannel statistics.Linuxyes
filefdExposes file descriptor statistics from /proc/sys/fs/file-nr.Linuxyes
filesystemExposes filesystem statistics, such as disk space used.Darwin, Dragonfly, FreeBSD, Linux, OpenBSDyes
hwmonExposes hardware monitoring and sensor data from /sys/class/hwmon.Linuxyes
infinibandExposes network statistics specific to InfiniBand and Intel OmniPath configurations.Linuxyes
interruptsExposes detailed interrupts statistics.Linux, OpenBSDno
ipvsExposes IPVS status from /proc/net/ip_vs and stats from /proc/net/ip_vs_stats.Linuxyes
ksmdExposes kernel and system statistics from /sys/kernel/mm/ksm.Linuxno
lnstatExposes Linux network cache stats.Linuxno
loadavgExposes load average.Darwin, Dragonfly, FreeBSD, Linux, NetBSD, OpenBSD, Solarisyes
logindExposes session counts from logind.Linuxno
mdadmExposes statistics about devices in /proc/mdstat (does nothing if no /proc/mdstat present).Linuxyes
meminfoExposes memory statistics.Darwin, Dragonfly, FreeBSD, Linux, OpenBSDyes
meminfo_numaExposes memory statistics from /proc/meminfo_numa.Linuxno
mountstatsExposes filesystem statistics from /proc/self/mountstats. Exposes detailed NFS client statistics.Linuxno
netclassExposes network interface info from /sys/class/net.Linuxyes
netdevExposes network interface statistics such as bytes transferred.Darwin, Dragonfly, FreeBSD, Linux, OpenBSDyes
netstatExposes network statistics from /proc/net/netstat. This is the same information as netstat -s.Linuxyes
network_routeExposes network route statistics.Linuxno
nfsExposes NFS client statistics from /proc/net/rpc/nfs. This is the same information as nfsstat -c.Linuxyes
nfsdExposes NFS kernel server statistics from /proc/net/rpc/nfsd. This is the same information as nfsstat -s.Linuxyes
ntpExposes local NTP daemon health to check time.anyno
nvmeExposes NVMe statistics.Linuxyes
osExposes os-release information.Linuxyes
perfExposes perf based metrics (Warning: Metrics are dependent on kernel configuration and settings).Linuxno
powersupplyclassCollects information on power supplies.anyyes
pressureExposes pressure stall statistics from /proc/pressure/.Linux (kernel 4.20+ and/or CONFIG_PSI)yes
processesExposes aggregate process statistics from /proc.Linuxno
qdiscExposes queuing discipline statistics.Linuxno
raplExposes various statistics from /sys/class/powercap.Linuxyes
runitExposes service status from runit.anyno
schedstatExposes task scheduler statistics from /proc/schedstat.Linuxyes
sockstatExposes various statistics from /proc/net/sockstat.Linuxyes
softnetExposes statistics from /proc/net/softnet_stat.Linuxyes
statExposes various statistics from /proc/stat. This includes boot time, forks and interrupts.Linuxyes
supervisordExposes service status from supervisord.anyno
systemdExposes service and system status from systemd.Linuxno
tapestatsExposes tape device stats.Linuxyes
tcpstatExposes TCP connection status information from /proc/net/tcp and /proc/net/tcp6. (Warning: The current version has potential performance issues in high load situations.)Linuxno
textfileCollects metrics from files in a directory matching the filename pattern *.prom. The files must be using the text format defined here:
thermalExposes thermal statistics.Darwinyes
thermal_zoneExposes thermal zone & cooling device statistics from /sys/class/thermal.Linuxyes
timeExposes the current system time.anyyes
timexExposes selected adjtimex(2) system call stats.Linuxyes
udp_queuesExposes UDP total lengths of the rx_queue and tx_queue from /proc/net/udp and /proc/net/udp6.Linuxyes
unameExposes system information as provided by the uname system call.Darwin, FreeBSD, Linux, OpenBSDyes
vmstatExposes statistics from /proc/vmstat.Linuxyes
wifiExposes WiFi device and station statistics.Linuxno
xfsExposes XFS runtime statistics.Linux (kernel 4.4+)yes
zfsExposes ZFS performance statistics.Linux, Solarisyes
zoneinfoExposes zone stats.Linuxno

Running on Docker/Kubernetes

When running Flow in a Docker container, you need to bind mount the filesystem, procfs, and sysfs from the host machine, as well as set the corresponding arguments for the component to work.

You may also need to add capabilities such as SYS_TIME and make sure that the Agent is running with elevated privileges for some of the collectors to work properly.


This example uses a prometheus.scrape component to collect metrics from prometheus.integration.node_exporter:

prometheus.integration.node_exporter {

// Configure a prometheus.scrape component to collect node_exporter metrics.
prometheus.scrape "demo" {
  targets    = prometheus.integration.node_exporter.targets
  forward_to = [ /* ... */ ]