From bc38ffc538b1683ca033790c80fa163e975698a5 Mon Sep 17 00:00:00 2001 From: Ben Kochie Date: Wed, 10 Jan 2018 15:16:33 +0100 Subject: [PATCH] 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. --- README.md | 36 +++++++++--------------------------- 1 file changed, 9 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 7bb83a5d..ca139170 100644 --- a/README.md +++ b/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. +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. -This can be useful for specifying different scrape intervals for different collectors in Prometheus: +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/#). -```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 ``` + params: + collect[]: + - foo + - bar +``` + +This can be useful for having different Prometheus servers collect specific metrics from nodes. ## Building and running