2018-05-30 19:14:54 +02:00
# Node exporter
2014-02-07 17:09:39 +01:00
2016-01-24 23:38:06 +01:00
[][circleci]
2017-08-24 12:29:34 +02:00
[](https://buildkite.com/prometheus/node-exporter)
2016-04-30 19:14:29 +02:00
[][quay]
[][hub]
2017-02-28 18:49:09 +01:00
[][goreportcard]
2015-03-19 03:04:29 +01:00
2017-01-23 20:57:08 +01:00
Prometheus exporter for hardware and OS metrics exposed by \*NIX kernels, written
2016-12-22 17:38:25 +01:00
in Go with pluggable metric collectors.
2014-02-07 17:09:39 +01:00
2020-06-01 21:07:42 +02:00
The [Windows exporter ](https://github.com/prometheus-community/windows_exporter ) is recommended for Windows users.
2018-11-19 19:35:01 +01:00
To expose NVIDIA GPU metrics, [prometheus-dcgm
2020-07-12 11:10:51 +02:00
](https://github.com/NVIDIA/gpu-monitoring-tools#dcgm-exporter)
2018-11-19 19:35:01 +01:00
can be used.
2017-01-23 20:57:08 +01:00
2020-11-25 17:07:59 +01:00
## Installation and Usage
If you are new to Prometheus and `node_exporter` there is a [simple step-by-step guide ](https://prometheus.io/docs/guides/node-exporter/ ).
### Ansible
For automated installs with [Ansible ](https://www.ansible.com/ ), there is the [Cloud Alchemy role ](https://github.com/cloudalchemy/ansible-node-exporter ).
### RHEL/CentOS/Fedora
There is a [community-supplied COPR repository ](https://copr.fedorainfracloud.org/coprs/ibotty/prometheus-exporters/ ) which closely follows upstream releases.
### Docker
The `node_exporter` is designed to monitor the host system. It's not recommended
to deploy it as a Docker container because it requires access to the host system.
For situations where Docker deployment is needed, some extra flags must be used to allow
the `node_exporter` access to the host namespaces.
Be aware that any non-root mount points you want to monitor will need to be bind-mounted
into the container.
If you start container for host monitoring, specify `path.rootfs` argument.
This argument must match path in bind-mount of host root. The node\_exporter will use
`path.rootfs` as prefix to access host filesystem.
```bash
docker run -d \
--net="host" \
--pid="host" \
-v "/:/host:ro,rslave" \
quay.io/prometheus/node-exporter:latest \
--path.rootfs=/host
```
For Docker compose, similar flag changes are needed.
```yaml
---
version: '3.8'
services:
node_exporter:
image: quay.io/prometheus/node-exporter:latest
container_name: node_exporter
command:
- '--path.rootfs=/host'
network_mode: host
pid: host
restart: unless-stopped
volumes:
- '/:/host:ro,rslave'
```
On some systems, the `timex` collector requires an additional Docker flag,
`--cap-add=SYS_TIME` , in order to access the required syscalls.
2016-01-22 00:09:24 +01:00
## Collectors
2015-02-09 22:41:51 +01:00
2016-01-22 00:09:24 +01:00
There is varying support for collectors on each operating system. The tables
below list all existing collectors and the supported systems.
2015-02-09 11:41:04 +01:00
2017-09-28 15:06:26 +02:00
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.
2015-02-09 11:41:04 +01:00
### Enabled by default
2016-01-22 00:09:24 +01:00
Name | Description | OS
---------|-------------|----
2017-04-11 17:45:19 +02:00
arp | Exposes ARP statistics from `/proc/net/arp` . | Linux
Add bcache collector (#597)
* Add bcache collector for Linux
This collector gathers metrics related to the Linux block cache
(bcache) from sysfs.
* Removed commented out code
* Use project comment style
* Add _sectors to metric name to indicate unit
* Really use project comment style
* Rename bcache.go to bcache_linux.go
* Keep collector namespace clean
Rename:
- metric -> bcacheMetric
- periodStatsToMetrics -> bcachePeriodStatsToMetric
* Shorten slice initialization
* Change label names to backing_device, cache_device
* Remove five minute metrics (keep only total)
* Include units in additional metric names
* Enable bcache collector by default
* Provide metrics in seconds, not nanoseconds
* remove metrics with label "all"
* Add fixtures, update end-to-end for bcache collector
* Move fixtures/sys into tar.gz
This changeset moves the collector/fixtures/sys directory into
collector/fixtures/sys.tar.gz and tweaks the Makefile to unpack the
tarball before tests are run.
The reason for this change is that Windows does not allow colons in a
path (colons are present in some of the bcache fixture files), nor can
it (out of the box) deal with pathnames longer than 260 characters
(which we would be increasingly likely to hit if we tried to replace
colons with longer codes that are guaranteed not the turn up in regular
file names).
* Add ttar: plain text archive, replacement for tar
This changeset adds ttar, a plain text replacement for tar, and uses it
for the sysfs fixture archive. The syntax is loosely based on tar(1).
Using a plain text archive makes it possible to review changes without
downloading and extracting the archive. Also, when working on the repo,
git diff and git log become useful again, allowing a committer to verify
and track changes over time.
The code is written in bash, because bash is available out of the box on
all major flavors of Linux and on macOS. The feature set used is
restricted to bash version 3.2 because that is what Apple is still
shipping.
The programm also works on Windows if bash is installed. Obviously, it
does not solve the Windows limitations (path length limited to 260
characters, no symbolic links) that prompted the move to an archive
format in the first place.
2017-07-07 07:20:18 +02:00
bcache | Exposes bcache statistics from `/sys/fs/bcache/` . | Linux
2018-03-29 16:18:12 +02:00
bonding | Exposes the number of configured and active slaves of Linux bonding interfaces. | Linux
2020-11-23 23:16:27 +01:00
btrfs | Exposes btrfs statistics | Linux
2019-01-12 13:33:56 +01:00
boottime | Exposes system boot time derived from the `kern.boottime` sysctl. | Darwin, Dragonfly, FreeBSD, NetBSD, OpenBSD, Solaris
2016-01-22 00:09:24 +01:00
conntrack | Shows conntrack statistics (does nothing if no `/proc/sys/net/netfilter/` present). | Linux
2019-01-12 13:33:56 +01:00
cpu | Exposes CPU statistics | Darwin, Dragonfly, FreeBSD, Linux, Solaris
2019-02-19 17:22:54 +01:00
cpufreq | Exposes CPU frequency statistics | Linux, Solaris
2019-02-06 11:36:22 +01:00
diskstats | Exposes disk I/O statistics. | Darwin, Linux, OpenBSD
2016-08-16 17:10:23 +02:00
edac | Exposes error detection and correction statistics. | Linux
2016-01-22 00:09:24 +01:00
entropy | Exposes available entropy. | Linux
2017-02-28 22:23:10 +01:00
exec | Exposes execution statistics. | Dragonfly, FreeBSD
2016-06-20 18:09:13 +02:00
filefd | Exposes file descriptor statistics from `/proc/sys/fs/file-nr` . | Linux
2017-01-04 12:30:48 +01:00
filesystem | Exposes filesystem statistics, such as disk space used. | Darwin, Dragonfly, FreeBSD, Linux, OpenBSD
2016-10-06 17:33:24 +02:00
hwmon | Expose hardware monitoring and sensor data from `/sys/class/hwmon/` . | Linux
2017-08-16 07:32:54 +02:00
infiniband | Exposes network statistics specific to InfiniBand and Intel OmniPath configurations. | Linux
2017-07-26 15:20:28 +02:00
ipvs | Exposes IPVS status from `/proc/net/ip_vs` and stats from `/proc/net/ip_vs_stats` . | Linux
2016-01-22 00:09:24 +01:00
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
2018-01-04 10:33:57 +01:00
meminfo | Exposes memory statistics. | Darwin, Dragonfly, FreeBSD, Linux, OpenBSD
2018-07-16 15:08:18 +02:00
netclass | Exposes network interface info from `/sys/class/net/` | Linux
2017-01-04 12:30:48 +01:00
netdev | Exposes network interface statistics such as bytes transferred. | Darwin, Dragonfly, FreeBSD, Linux, OpenBSD
2016-01-22 00:09:24 +01:00
netstat | Exposes network statistics from `/proc/net/netstat` . This is the same information as `netstat -s` . | Linux
2018-02-16 15:42:47 +01:00
nfs | Exposes NFS client statistics from `/proc/net/rpc/nfs` . This is the same information as `nfsstat -c` . | Linux
nfsd | Exposes NFS kernel server statistics from `/proc/net/rpc/nfsd` . This is the same information as `nfsstat -s` . | Linux
2020-11-23 23:23:43 +01:00
powersupplyclass | Exposes Power Supply statistics from `/sys/class/power_supply` | Linux
2020-11-24 18:33:54 +01:00
pressure | Exposes pressure stall statistics from `/proc/pressure/` . | Linux (kernel 4.20+ and/or [CONFIG\_PSI ](https://www.kernel.org/doc/html/latest/accounting/psi.html ))
2020-01-17 13:32:16 +01:00
rapl | Exposes various statistics from `/sys/class/powercap` . | Linux
2019-07-10 09:16:24 +02:00
schedstat | Exposes task scheduler statistics from `/proc/schedstat` . | Linux
2017-01-26 04:06:10 +01:00
sockstat | Exposes various statistics from `/proc/net/sockstat` . | Linux
2019-12-30 01:36:10 +01:00
softnet | Exposes statistics from `/proc/net/softnet_stat` . | Linux
2017-06-13 11:21:53 +02:00
stat | Exposes various statistics from `/proc/stat` . This includes boot time, forks and interrupts. | Linux
2016-01-22 00:09:24 +01:00
textfile | Exposes statistics read from local disk. The `--collector.textfile.directory` flag must be set. | _any_
2019-08-12 05:52:16 +02:00
thermal\_zone | Exposes thermal zone & cooling device statistics from `/sys/class/thermal` . | Linux
2016-01-22 00:09:24 +01:00
time | Exposes the current system time. | _any_
Add timex collector (#664)
This collector is based on adjtimex(2) system call. The collector returns
three values, status if time is synchronised, offset to remote reference,
and local clock frequency adjustment.
Values are taken from kernel time keeping data structures to avoid getting
involved how the synchronisation is implemented. By that I mean one should
not care if time is update using ntpd, systemd.timesyncd, ptpd, and so on.
Since all time sync implementation will always end up telling to kernel what
is the status with time one can simply omit the software in between, and
look results of the syncing. As a positive side effect this makes collector
very quick and conceptually specific, this does not monitor availability of
NTP server, or network in between, or dns resolution, and other unrelated
but necessary things.
Minimum set of values to keep eye on are the following three:
The node_timex_sync_status tells if local clock is in sync with a remote
clock. Value is set to zero when synchronisation to a reliable server
is lost, or a time sync software is misconfigured.
The node_timex_offset_seconds tells how much local clock is off when
compared to reference. In case of multiple time references this value
is outcome of RFC 5905 adjustment algorithm. Ideally offset should be
close to zero, and it depends about use case how large value is
acceptable. For example a typical web server is probably fine if offset
is about 0.1 or less, but that would not be good enough for mobile phone
base station operator.
The node_timex_freq tells amount of adjustment to local clock tick
frequency. For example if offset is one second and growing the local
clock will need instruction to tick quicker. Number value itself is not
very important, and occasional small adjustments are fine. When
frequency is unusually in stable one can assume quality of time stamps
will not be accurate to very far in sub second range. Obviously
explaining why local clock frequency behaves like a passenger in roller
coaster is different matter. Explanations can vary from system load, to
environmental issues such as a machine being physically too hot.
Rest of the measurements can help when debugging. If you run a clock server
do probably want to collect and keep track of everything.
Pull-request: https://github.com/prometheus/node_exporter/pull/664
2017-09-19 16:54:06 +02:00
timex | Exposes selected adjtimex(2) system call stats. | Linux
2020-03-31 10:46:32 +02:00
udp_queues | Exposes UDP total lengths of the rx_queue and tx_queue from `/proc/net/udp` and `/proc/net/udp6` . | Linux
2019-08-03 12:32:43 +02:00
uname | Exposes system information as provided by the uname system call. | Darwin, FreeBSD, Linux, OpenBSD
2016-01-22 00:09:24 +01:00
vmstat | Exposes statistics from `/proc/vmstat` . | Linux
2017-04-22 00:19:35 +02:00
xfs | Exposes XFS runtime statistics. | Linux (kernel 4.4+)
2019-01-12 13:33:56 +01:00
zfs | Exposes [ZFS ](http://open-zfs.org/ ) performance statistics. | [Linux ](http://zfsonlinux.org/ ), Solaris
2015-02-09 11:41:04 +01:00
### Disabled by default
2020-11-25 16:46:58 +01:00
`node_exporter` also implements a number of collectors that are disabled by default. Reasons for this vary by
collector, and may include:
* High cardinality
* Prolonged runtime that exceeds Prometheus` `scrape_interval` or `scrape_timeout`
* Significant resource demands on the host
You can enable additional collectors as desired by adding them to your
init system's or service supervisor's startup configuration for
`node_exporter` but caution is advised. Enable at most one at a time,
testing first on a non-production system, then by hand on a single
production node. When enabling additional collectors, you should
carefully monitor the change by observing the `
scrape_duration_seconds` metric to ensure that collection completes
and does not time out. In addition, monitor the
`scrape_samples_post_metric_relabeling` metric to see the changes in
cardinality.
The `perf` collector may not work out of the box on some Linux systems due to kernel
configuration and security settings. To allow access, set the following `sysctl`
2019-05-07 13:21:41 +02:00
parameter:
```
sysctl -w kernel.perf_event_paranoid=X
```
- 2 allow only user-space measurements (default since Linux 4.6).
- 1 allow both kernel and user measurements (default before Linux 4.6).
- 0 allow access to CPU-specific data but not raw tracepoint samples.
- -1 no restrictions.
Depending on the configured value different metrics will be available, for most
cases `0` will provide the most complete set. For more information see [`man 2
perf_event_open`](http://man7.org/linux/man-pages/man2/perf_event_open.2.html).
2020-11-25 16:46:58 +01:00
By default, the `perf` collector will only collect metrics of the CPUs that
2020-02-20 11:36:33 +01:00
`node_exporter` is running on (ie
[`runtime.NumCPU` ](https://golang.org/pkg/runtime/#NumCPU ). If this is
insufficient (e.g. if you run `node_exporter` with its CPU affinity set to
2020-03-27 20:59:47 +01:00
specific CPUs), you can specify a list of alternate CPUs by using the
2020-02-20 11:36:33 +01:00
`--collector.perf.cpus` flag. For example, to collect metrics on CPUs 2-6, you
would specify: `--collector.perf --collector.perf.cpus=2-6` . The CPU
2020-03-27 20:59:47 +01:00
configuration is zero indexed and can also take a stride value; e.g.
`--collector.perf --collector.perf.cpus=1-10:5` would collect on CPUs
2020-02-20 11:36:33 +01:00
1, 5, and 10.
2020-11-25 16:46:58 +01:00
The `perf` collector is also able to collect
2020-04-17 12:02:08 +02:00
[tracepoint ](https://www.kernel.org/doc/html/latest/core-api/tracepoint.html )
counts when using the `--collector.perf.tracepoint` flag. Tracepoints can be
found using [`perf list` ](http://man7.org/linux/man-pages/man1/perf.1.html ) or
from debugfs. And example usage of this would be
`--collector.perf.tracepoint="sched:sched_process_exec"` .
2020-02-20 11:36:33 +01:00
2016-01-22 00:09:24 +01:00
Name | Description | OS
---------|-------------|----
2017-02-07 15:29:50 +01:00
buddyinfo | Exposes statistics of memory fragments as reported by /proc/buddyinfo. | Linux
2016-10-07 18:40:33 +02:00
devstat | Exposes device statistics | Dragonfly, FreeBSD
2017-08-02 08:04:13 +02:00
drbd | Exposes Distributed Replicated Block Device statistics (to version 8.4) | Linux
2016-01-22 00:09:24 +01:00
interrupts | Exposes detailed interrupts statistics. | Linux, OpenBSD
ksmd | Exposes kernel and system statistics from `/sys/kernel/mm/ksm` . | Linux
2016-04-20 17:28:12 +02:00
logind | Exposes session counts from [logind ](http://www.freedesktop.org/wiki/Software/systemd/logind/ ). | Linux
2016-12-22 17:38:25 +01:00
meminfo\_numa | Exposes memory statistics from `/proc/meminfo_numa` . | Linux
2016-12-12 22:46:45 +01:00
mountstats | Exposes filesystem statistics from `/proc/self/mountstats` . Exposes detailed NFS client statistics. | Linux
2017-09-19 10:36:14 +02:00
ntp | Exposes local NTP daemon health to check [time ](./docs/TIME.md ) | _any_
2018-10-11 18:27:41 +02:00
processes | Exposes aggregate process statistics from `/proc` . | Linux
2017-05-23 11:55:50 +02:00
qdisc | Exposes [queuing discipline ](https://en.wikipedia.org/wiki/Network_scheduler#Linux_kernel ) statistics | Linux
2016-01-22 00:09:24 +01:00
runit | Exposes service status from [runit ](http://smarden.org/runit/ ). | _any_
supervisord | Exposes service status from [supervisord ](http://supervisord.org/ ). | _any_
systemd | Exposes service and system status from [systemd ](http://www.freedesktop.org/wiki/Software/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
2018-10-11 18:27:41 +02:00
wifi | Exposes WiFi device and station statistics. | Linux
2019-05-07 13:21:41 +02:00
perf | Exposes perf based metrics (Warning: Metrics are dependent on kernel configuration and settings). | Linux
2016-01-22 00:09:24 +01:00
### Textfile Collector
2015-02-09 11:41:04 +01:00
2020-11-25 16:46:58 +01:00
The `textfile` collector is similar to the [Pushgateway ](https://github.com/prometheus/pushgateway ),
2015-02-09 11:41:04 +01:00
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
2020-11-25 16:46:58 +01:00
should be used for service-level metrics. The `textfile` module is for metrics
2015-02-09 11:41:04 +01:00
that are tied to a machine.
2020-11-25 16:46:58 +01:00
To use it, set the `--collector.textfile.directory` flag on the `node_exporter` commandline. The
2015-02-18 18:15:57 +01:00
collector will parse all files in that directory matching the glob `*.prom`
using the [text
2019-03-19 11:23:17 +01:00
format](http://prometheus.io/docs/instrumenting/exposition_formats/). **Note:** Timestamps are not supported.
2015-02-09 11:41:04 +01:00
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
```
2015-06-07 17:59:17 +02:00
2017-10-14 14:23:42 +02:00
### Filtering enabled collectors
2018-04-09 17:27:30 +02:00
The `node_exporter` will expose all metrics from enabled collectors by default. This is the recommended way to collect metrics to avoid errors when comparing metrics of different families.
2018-01-10 15:16:33 +01:00
For advanced use the `node_exporter` can be passed an optional list of collectors to filter metrics. The `collect[]` parameter may be used multiple times. In Prometheus configuration you can use this syntax under the [scrape config ](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#<scrape_config> ).
2017-10-14 14:23:42 +02:00
```
2018-01-10 15:16:33 +01:00
params:
collect[]:
- foo
- bar
```
This can be useful for having different Prometheus servers collect specific metrics from nodes.
2017-10-14 14:23:42 +02:00
2020-11-25 17:07:59 +01:00
## Development building and running
2016-01-22 00:09:24 +01:00
2017-10-11 11:46:13 +02:00
Prerequisites:
* [Go compiler ](https://golang.org/dl/ )
* RHEL/CentOS: `glibc-static` package.
Building:
2020-11-25 17:07:59 +01:00
git clone https://github.com/prometheus/node_exporter.git
cd node_exporter
2016-01-22 00:09:24 +01:00
make
./node_exporter < flags >
2017-03-22 17:20:34 +01:00
To see all available configuration flags:
./node_exporter -h
2016-01-22 00:09:24 +01:00
## Running tests
make test
2020-02-20 13:42:47 +01:00
## TLS endpoint
** EXPERIMENTAL **
The exporter supports TLS via a new web configuration file.
```console
./node_exporter --web.config=web-config.yml
```
See the [https package ](https/README.md ) for more details.
2016-01-22 00:09:24 +01:00
2016-01-24 23:38:06 +01:00
[travis]: https://travis-ci.org/prometheus/node_exporter
[hub]: https://hub.docker.com/r/prom/node-exporter/
[circleci]: https://circleci.com/gh/prometheus/node_exporter
2016-04-30 19:14:29 +02:00
[quay]: https://quay.io/repository/prometheus/node-exporter
2017-02-28 18:49:09 +01:00
[goreportcard]: https://goreportcard.com/report/github.com/prometheus/node_exporter
