Go to file
Pontus Leitzler 0b6763886a Remove unnecessary select statement (#692)
* Remove unnecessary select statement

* Remove unnecessary if-statement
2017-10-18 07:38:48 +02:00
.github Add additional field to github issue template. (#645) 2017-08-17 12:44:26 +02:00
collector Add collect[] parameter (#699) 2017-10-14 14:23:42 +02:00
docs Add metrics from SNTPv4 packet to ntp collector & add ntpd sanity check (#655) 2017-09-19 10:36:14 +02:00
examples/systemd Switch to kingpin flags (#639) 2017-08-12 15:07:24 +02:00
text_collector_examples Fix smartmon.sh textfile script (#700) 2017-10-18 07:37:47 +02:00
vendor Update vendoring (#685) 2017-10-05 16:20:47 +02:00
.dockerignore New release process using docker, circleci and a centralized 2016-04-28 22:07:21 +02:00
.gitignore Ignore extracted sysfs fixture files from git 2017-07-20 14:36:48 -04:00
.promu.yml define binary name in promu configuration file (#650) 2017-08-22 17:24:07 +02:00
.travis.yml Test with Go 1.9.x (#667) 2017-08-31 18:00:55 +02:00
CHANGELOG.md Release v0.15.0 (#686) 2017-10-06 09:43:58 +02:00
circle.yml Fix circle docker test tag name. (#688) 2017-10-06 12:33:03 +02:00
CONTRIBUTING.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-19 18:27:34 +01:00
Dockerfile Run node-exporter in Docker as nobody (#599) 2017-06-08 20:02:20 +02:00
Dockerfile.ppc64le Add dockerfile for ppc64le (#638) 2017-08-17 11:53:04 +02:00
end-to-end-test.sh Replace --collectors.enabled with per-collector flags (#640) 2017-09-28 15:06:26 +02:00
example.rules Fix example.rules typos. 2017-01-17 21:52:59 +01:00
LICENSE License cleanup 2015-01-22 17:11:26 +01:00
MAINTAINERS.md Replace AUTHORS.md by an updated MAINTAINERS.md 2017-02-19 18:27:34 +01:00
Makefile Add collect[] parameter (#699) 2017-10-14 14:23:42 +02:00
node_exporter_test.go Remove unnecessary select statement (#692) 2017-10-18 07:38:48 +02:00
node_exporter.go Add collect[] parameter (#699) 2017-10-14 14:23:42 +02:00
NOTICE Vendor github.com/mdlayher/wifi and dependencies 2017-01-10 11:29:00 -05:00
README.md Add collect[] parameter (#699) 2017-10-14 14:23:42 +02:00
test_image.sh Resolves prometheus/node_exporter#585 (#586) 2017-07-07 07:26:11 +02:00
ttar Add bcache collector (#597) 2017-07-07 07:20:18 +02:00
VERSION Release v0.15.0 (#686) 2017-10-06 09:43:58 +02:00

Node exporter Build Status

CircleCI Buildkite status Docker Repository on Quay Docker Pulls Go Report Card

Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors.

The WMI exporter is recommended for Windows users.

Collectors

There is varying support for collectors on each operating system. The tables below list all existing collectors and the supported systems.

Collectors are enabled by providing a --collector.<name> flag. Collectors that are enabled by default can be disabled by providing a --no-collector.<name> flag.

Enabled by default

Name Description OS
arp Exposes ARP statistics from /proc/net/arp. Linux
bcache Exposes bcache statistics from /sys/fs/bcache/. Linux
conntrack Shows conntrack statistics (does nothing if no /proc/sys/net/netfilter/ present). Linux
cpu Exposes CPU statistics Darwin, Dragonfly, FreeBSD, Linux
diskstats Exposes disk I/O statistics. Darwin, Linux
edac Exposes error detection and correction statistics. Linux
entropy Exposes available entropy. Linux
exec Exposes execution statistics. Dragonfly, FreeBSD
filefd Exposes file descriptor statistics from /proc/sys/fs/file-nr. Linux
filesystem Exposes filesystem statistics, such as disk space used. Darwin, Dragonfly, FreeBSD, Linux, OpenBSD
hwmon Expose hardware monitoring and sensor data from /sys/class/hwmon/. Linux
infiniband Exposes network statistics specific to InfiniBand and Intel OmniPath configurations. Linux
ipvs Exposes IPVS status from /proc/net/ip_vs and stats from /proc/net/ip_vs_stats. Linux
loadavg Exposes load average. Darwin, Dragonfly, FreeBSD, Linux, NetBSD, OpenBSD, Solaris
mdadm Exposes statistics about devices in /proc/mdstat (does nothing if no /proc/mdstat present). Linux
meminfo Exposes memory statistics. Darwin, Dragonfly, FreeBSD, Linux
netdev Exposes network interface statistics such as bytes transferred. Darwin, Dragonfly, FreeBSD, Linux, OpenBSD
netstat Exposes network statistics from /proc/net/netstat. This is the same information as netstat -s. Linux
sockstat Exposes various statistics from /proc/net/sockstat. Linux
stat Exposes various statistics from /proc/stat. This includes boot time, forks and interrupts. Linux
textfile Exposes statistics read from local disk. The --collector.textfile.directory flag must be set. any
time Exposes the current system time. any
timex Exposes selected adjtimex(2) system call stats. Linux
uname Exposes system information as provided by the uname system call. Linux
vmstat Exposes statistics from /proc/vmstat. Linux
wifi Exposes WiFi device and station statistics. Linux
xfs Exposes XFS runtime statistics. Linux (kernel 4.4+)
zfs Exposes ZFS performance statistics. Linux

Disabled by default

Name Description OS
bonding Exposes the number of configured and active slaves of Linux bonding interfaces. Linux
buddyinfo Exposes statistics of memory fragments as reported by /proc/buddyinfo. Linux
devstat Exposes device statistics Dragonfly, FreeBSD
drbd Exposes Distributed Replicated Block Device statistics (to version 8.4) Linux
interrupts Exposes detailed interrupts statistics. Linux, OpenBSD
ksmd Exposes kernel and system statistics from /sys/kernel/mm/ksm. Linux
logind Exposes session counts from logind. Linux
meminfo_numa Exposes memory statistics from /proc/meminfo_numa. Linux
mountstats Exposes filesystem statistics from /proc/self/mountstats. Exposes detailed NFS client statistics. Linux
nfs Exposes NFS client statistics from /proc/net/rpc/nfs. This is the same information as nfsstat -c. Linux
ntp Exposes local NTP daemon health to check time any
qdisc Exposes queuing discipline statistics Linux
runit Exposes service status from runit. any
supervisord Exposes service status from supervisord. any
systemd Exposes service and system status from systemd. Linux
tcpstat Exposes TCP connection status information from /proc/net/tcp and /proc/net/tcp6. (Warning: the current version has potential performance issues in high load situations.) Linux

Deprecated

These collectors will be (re)moved in the future.

Name Description OS
gmond Exposes statistics from Ganglia. any
megacli Exposes RAID statistics from MegaCLI. Linux

Textfile Collector

The textfile collector is similar to the Pushgateway, in that it allows exporting of statistics from batch jobs. It can also be used to export static metrics, such as what role a machine has. The Pushgateway should be used for service-level metrics. The textfile module is for metrics that are tied to a machine.

To use it, set the --collector.textfile.directory flag on the Node exporter. The collector will parse all files in that directory matching the glob *.prom using the text format.

To atomically push completion time for a cron job:

echo my_batch_job_completion_time $(date +%s) > /path/to/directory/my_batch_job.prom.$$
mv /path/to/directory/my_batch_job.prom.$$ /path/to/directory/my_batch_job.prom

To statically set roles for a machine using labels:

echo 'role{role="application_server"} 1' > /path/to/directory/role.prom.$$
mv /path/to/directory/role.prom.$$ /path/to/directory/role.prom

Filtering enabled collectors

The node_exporter will expose all metrics from enabled collectors by default, but it can be passed an optional list of collectors to filter metrics. The collect[] parameter accepts values matching enabled collector names.

This can be useful for specifying different scrape intervals for different collectors in Prometheus:

scrape_configs:
  - job_name: 'node resources'
    scrape_interval: 15s
    static_configs:
      - targets:
        - '192.168.1.2:9100'
    params:
      collect[]:
        - cpu
        - meminfo
        - diskstats
        - netdev
        - netstat

  - job_name: 'node storage'
    scrape_interval: 1m
    static_configs:
      - targets:
        - '192.168.1.2:9100'
    params:
      collect[]:
        - filefd
        - filesystem
        - xfs

Building and running

Prerequisites:

Building:

go get github.com/prometheus/node_exporter
cd ${GOPATH-$HOME/go}/src/github.com/prometheus/node_exporter
make
./node_exporter <flags>

To see all available configuration flags:

./node_exporter -h

Running tests

make test

Using Docker

The node_exporter is designed to monitor the host system. It's not recommended to deploy it as Docker container because it requires access to the host system. If you need to run it on Docker, you can deploy this exporter using the node-exporter Docker image with the following options and bind-mounts:

for docker version >= 1.10

docker run -d -p 9100:9100 \
  -v "/proc:/host/proc:ro" \
  -v "/sys:/host/sys:ro" \
  -v "/:/rootfs:ro,rslave" \
  --net="host" \
  quay.io/prometheus/node-exporter \
    --path.procfs /host/proc \
    --path.sysfs /host/sys \
    --collector.filesystem.ignored-mount-points "^/(sys|proc|dev|host|etc)($|/)"

for docker version < 1.10

docker run -d -p 9100:9100 \
  -v "/proc:/host/proc:ro" \
  -v "/sys:/host/sys:ro" \
  -v "/:/rootfs:ro" \
  --net="host" \
  quay.io/prometheus/node-exporter \
    --path.procfs /host/proc \
    --path.sysfs /host/sys \
    --collector.filesystem.ignored-mount-points "^/(sys|proc|dev|host|etc)($|/)"

Be aware though that the mountpoint label in various metrics will now have /rootfs as prefix.

Using a third-party repository for RHEL/CentOS/Fedora

There is a community-supplied COPR repository. It closely follows upstream releases.