Update collect[] param documentation (#784)

Improve recommendations and wording around advanced use of the collect[]
param.

Remove example that causes users to copy-and-paste it.
pull/788/head
Ben Kochie 8 years ago committed by GitHub
parent 8d3484d0ca
commit bc38ffc538
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 40
      README.md

@ -109,36 +109,18 @@ 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:
```yaml
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
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 familes.
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>).
```
params:
collect[]:
- foo
- bar
```
This can be useful for having different Prometheus servers collect specific metrics from nodes.
## Building and running

Loading…
Cancel
Save