RepoMirrors
/
node_exporter
mirror of https://github.com/prometheus/node_exporter
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
node_exporter/README.md

77 lines
3.0 KiB
Markdown
Raw Normal View History

Flesh out readme.
2015-02-09 10:41:04 +00:00
# Node exporter
Add support for selecting collectors at buildtime This works by using a global array with references to NewXCollector functions. Each collector appends to that array in it's init() function. Which file gets build depends on the build tags: To build only the ganglia exporter, you can do: go build -tags nonative,ganglia By default it will build only the native collector.
2014-02-07 16:09:39 +00:00
Link Travis badge to Travis build status page.
2015-03-21 10:32:18 +00:00
[![Build Status](https://travis-ci.org/prometheus/node_exporter.svg)](https://travis-ci.org/prometheus/node_exporter)
added travis automated build and status on the readme
2015-03-19 02:04:29 +00:00
Flesh out readme.
2015-02-09 10:41:04 +00:00
Prometheus exporter for machine metrics, written in Go with pluggable metric
collectors.
Add support for selecting collectors at buildtime This works by using a global array with references to NewXCollector functions. Each collector appends to that array in it's init() function. Which file gets build depends on the build tags: To build only the ganglia exporter, you can do: go build -tags nonative,ganglia By default it will build only the native collector.
2014-02-07 16:09:39 +00:00
Add tests and run info to README.md and Makefile.
2015-02-09 21:41:51 +00:00
## Building and running
make
./node_exporter <flags>
## Running tests
make test
Flesh out readme.
2015-02-09 10:41:04 +00:00
## Available collectors
Add support for selecting collectors at buildtime This works by using a global array with references to NewXCollector functions. Each collector appends to that array in it's init() function. Which file gets build depends on the build tags: To build only the ganglia exporter, you can do: go build -tags nonative,ganglia By default it will build only the native collector.
2014-02-07 16:09:39 +00:00
Flesh out readme.
2015-02-09 10:41:04 +00:00
By default the build will include the native collectors that expose information
from /proc.
Make collector-specific flags consistent with others. This puts all collector-specific flags into their own namespace under "collector.<collector-name>", and moves from camel case to dashes, which is the standard in Prometheus land now.
2015-02-18 17:15:57 +00:00
Which collectors are used is controlled by the `--collectors.enabled` flag.
Flesh out readme.
2015-02-09 10:41:04 +00:00
### Enabled by default
Name | Description
---------|------------
attributes | Exposes attributes from the configuration file. Deprecated, use textfile module instead.
diskstats | Exposes disk I/O statistics from /proc/diskstats.
filesystem | Exposes filesystem statistics, such as disk space used.
loadavg | Exposes load average.
meminfo | Exposes memory statistics from /proc/meminfo.
netdev | Exposes network interface statistics from /proc/netstat, such as bytes transferred.
netstat | Exposes network statistics from /proc/net/netstat. This is the same information as `netstat -s`.
stat | Exposes various statistics from /proc/stat. This includes CPU usage, boot time, forks and interrupts.
Make collector-specific flags consistent with others. This puts all collector-specific flags into their own namespace under "collector.<collector-name>", and moves from camel case to dashes, which is the standard in Prometheus land now.
2015-02-18 17:15:57 +00:00
textfile | Exposes statistics read from local disk. The `--collector.textfile.directory` flag must be set.
Flesh out readme.
2015-02-09 10:41:04 +00:00
time | Exposes the current system time.
### Disabled by default
Name | Description
---------|------------
bonding | Exposes the number of configured and active slaves of Linux bonding interfaces.
gmond | Exposes statistics from Ganglia.
interrupts | Exposes detailed interrupts statistics from /proc/interrupts.
lastlogin | Exposes the last time there was a login.
megacli | Exposes RAID statistics from MegaCLI.
ntp | Exposes time drift from an NTP server.
runit | Exposes service status from [runit](http://smarden.org/runit/).
Add collector for /proc/net/tcp
2015-03-24 11:34:48 +00:00
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.)
Flesh out readme.
2015-02-09 10:41:04 +00:00
## Textfile Collector
The textfile collector is similar to the [Pushgateway](https://github.com/prometheus/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.
Wording/punctuation improvement in README.md.
2015-03-21 10:27:43 +00:00
To use it, set the `--collector.textfile.directory` flag on the Node exporter. The
Make collector-specific flags consistent with others. This puts all collector-specific flags into their own namespace under "collector.<collector-name>", and moves from camel case to dashes, which is the standard in Prometheus land now.
2015-02-18 17:15:57 +00:00
collector will parse all files in that directory matching the glob `*.prom`
using the [text
format](http://prometheus.io/docs/instrumenting/exposition_formats/).
Flesh out readme.
2015-02-09 10:41:04 +00: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
```