Skip to content

Commit e2163db

Browse files
grobiegrobie
committed
Document os support of each collector
1 parent 33f99c4 commit e2163db

6 files changed

+50
-47
lines changed

‎README.md

+49-44
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,55 @@
55
Prometheus exporter for machine metrics, written in Go with pluggable metric
66
collectors.
77

8-
## Building and running
9-
10-
make
11-
./node_exporter <flags>
12-
13-
## Running tests
14-
15-
make test
8+
## Collectors
169

17-
## Available collectors
18-
19-
By default the build will include the native collectors that expose information
20-
from `/proc`.
10+
There is varying support for collectors on each operating system. The tables
11+
below list all existing collectors and the supported systems.
2112

2213
Which collectors are used is controlled by the `--collectors.enabled` flag.
2314

2415
### Enabled by default
2516

26-
Name | Description
27-
---------|------------
28-
conntrack | Shows conntrack statistics (does nothing if no `/proc/sys/net/netfilter/` present).
29-
diskstats | Exposes disk I/O statistics from `/proc/diskstats`.
30-
entropy | Exposes available entropy.
31-
filefd | Exposes file descriptor statistics.
32-
filesystem | Exposes filesystem statistics, such as disk space used.
33-
loadavg | Exposes load average.
34-
mdadm | Exposes statistics about devices in `/proc/mdstat` (does nothing if no `/proc/mdstat` present).
35-
meminfo | Exposes memory statistics from `/proc/meminfo`.
36-
netdev | Exposes network interface statistics from `/proc/netstat`, such as bytes transferred.
37-
netstat | Exposes network statistics from `/proc/net/netstat`. This is the same information as `netstat -s`.
38-
stat | Exposes various statistics from `/proc/stat`. This includes CPU usage, boot time, forks and interrupts.
39-
textfile | Exposes statistics read from local disk. The `--collector.textfile.directory` flag must be set.
40-
time | Exposes the current system time.
41-
vmstat | Exposes statistics from `/proc/vmstat`.
42-
version | Exposes node\_exporter version.
17+
Name | Description | OS
18+
---------|-------------|----
19+
conntrack | Shows conntrack statistics (does nothing if no `/proc/sys/net/netfilter/` present). | Linux
20+
diskstats | Exposes disk I/O statistics from `/proc/diskstats`. | Linux
21+
entropy | Exposes available entropy. | Linux
22+
filefd | Exposes file descriptor statistics. | Linux
23+
filesystem | Exposes filesystem statistics, such as disk space used. | FreeBSD, Linux, OpenBSD
24+
loadavg | Exposes load average. | Darwin, Dragonfly, FreeBSD, Linux, NetBSD, OpenBSD, Solaris
25+
mdadm | Exposes statistics about devices in `/proc/mdstat` (does nothing if no `/proc/mdstat` present). | Linux
26+
meminfo | Exposes memory statistics. | FreeBSD, Linux
27+
netdev | Exposes network interface statistics such as bytes transferred. | FreeBSD, Linux, OpenBSD
28+
netstat | Exposes network statistics from `/proc/net/netstat`. This is the same information as `netstat -s`. | Linux
29+
stat | Exposes various statistics from `/proc/stat`. This includes CPU usage, boot time, forks and interrupts. | Linux
30+
textfile | Exposes statistics read from local disk. The `--collector.textfile.directory` flag must be set. | _any_
31+
time | Exposes the current system time. | _any_
32+
vmstat | Exposes statistics from `/proc/vmstat`. | Linux
33+
version | Exposes node\_exporter version. | _any_
4334

4435

4536
### Disabled by default
4637

47-
Name | Description
48-
---------|------------
49-
bonding | Exposes the number of configured and active slaves of Linux bonding interfaces.
50-
gmond | Exposes statistics from Ganglia.
51-
interrupts | Exposes detailed interrupts statistics from `/proc/interrupts`.
52-
ipvs | Exposes IPVS status from `/proc/net/ip_vs` and stats from `/proc/net/ip_vs_stats`.
53-
lastlogin | Exposes the last time there was a login.
54-
megacli | Exposes RAID statistics from MegaCLI.
55-
ntp | Exposes time drift from an NTP server.
56-
runit | Exposes service status from [runit](http://smarden.org/runit/).
57-
supervisord | Exposes service status from [supervisord](http://supervisord.org/).
58-
systemd | Exposes service and system status from [systemd](http://www.freedesktop.org/wiki/Software/systemd/).
59-
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.)
60-
61-
## Textfile Collector
38+
Name | Description | OS
39+
---------|-------------|----
40+
cpu | Exposes CPU statistics | FreeBSD
41+
bonding | Exposes the number of configured and active slaves of Linux bonding interfaces. | Linux
42+
devstat | Exposes device statistics | FreeBSD
43+
gmond | Exposes statistics from Ganglia. | _any_
44+
interrupts | Exposes detailed interrupts statistics. | Linux, OpenBSD
45+
ipvs | Exposes IPVS status from `/proc/net/ip_vs` and stats from `/proc/net/ip_vs_stats`. | Linux
46+
ksmd | Exposes kernel and system statistics from `/sys/kernel/mm/ksm`. | Linux
47+
lastlogin | Exposes the last time there was a login. | _any_
48+
megacli | Exposes RAID statistics from MegaCLI. | Linux
49+
meminfo_numa | Exposes memory statistics from `/proc/meminfo_numa`. | Linux
50+
ntp | Exposes time drift from an NTP server. | _any_
51+
runit | Exposes service status from [runit](http://smarden.org/runit/). | _any_
52+
supervisord | Exposes service status from [supervisord](http://supervisord.org/). | _any_
53+
systemd | Exposes service and system status from [systemd](http://www.freedesktop.org/wiki/Software/systemd/). | Linux
54+
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
55+
56+
### Textfile Collector
6257

6358
The textfile collector is similar to the [Pushgateway](https://github.com/prometheus/pushgateway),
6459
in that it allows exporting of statistics from batch jobs. It can also be used
@@ -83,6 +78,16 @@ echo 'role{role="application_server"} 1' > /path/to/directory/role.prom.$$
8378
mv /path/to/directory/role.prom.$$ /path/to/directory/role.prom
8479
```
8580

81+
## Building and running
82+
83+
make
84+
./node_exporter <flags>
85+
86+
## Running tests
87+
88+
make test
89+
90+
8691
## Using Docker
8792

8893
You can deploy this exporter using the [prom/node-exporter](https://registry.hub.docker.com/u/prom/node-exporter/) Docker image.

‎collector/interrupts_common.go

+1-3
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,8 @@
1111
// See the License for the specific language governing permissions and
1212
// limitations under the License.
1313

14+
// +build linux openbsd
1415
// +build !nointerrupts
15-
// +build !darwin
16-
// +build !freebsd
17-
// +build !windows
1816

1917
package collector
2018

‎collector/ipvs.go ‎collector/ipvs_linux.go

File renamed without changes.

‎collector/ipvs_test.go ‎collector/ipvs_linux_test.go

File renamed without changes.

‎collector/mdadm.go ‎collector/mdadm_linux.go

File renamed without changes.

‎collector/mdadm_test.go ‎collector/mdadm_linux_test.go

File renamed without changes.

0 commit comments

Comments
 (0)