From 98316701b0d0f49db2686fc78da154045f954a5d Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 14:58:02 +0100 Subject: [PATCH 1/6] Adjust document hierarchy --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d8e0bb7..6bd1bda 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # Grafana Dashboards -Grafana dashboards - -### Node Exporter Full +## Node Exporter Full For node_exporter @@ -27,7 +25,7 @@ Thanks to the PCP project for document the values reported by the kernel in /pro -### Node Exporter FreeBSD +## Node Exporter FreeBSD For node_exporter in FreeBSD system @@ -37,7 +35,7 @@ Only requires a configured target under any job_name. -### Haproxy Full _deprecated_ +## Haproxy Full _deprecated_ For haproxy_exporter @@ -47,7 +45,7 @@ Only requires a configured target under any job_name. -### Haproxy 2 Full +## Haproxy 2 Full For Haproxy compiled with Prometheus support @@ -57,7 +55,7 @@ Only requires a configured target under any job_name. -### Apache Full +## Apache Full Monitor Apache service. @@ -65,7 +63,7 @@ Moved to https://github.com/grafana/jsonnet-libs -### NFS Full +## NFS Full For node_exporter @@ -77,7 +75,7 @@ The same as Node Exporter Full. Only requires the default job_name: node, add as -### Bind9 Full +## Bind9 Full For prometheus-bind-exporter https://github.com/prometheus-community/bind_exporter From b697be4040db68cf26d5c31532c07f00ab1f85cb Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 14:58:53 +0100 Subject: [PATCH 2/6] Add syntax highlighting --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6bd1bda..a075c77 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Monitor Linux system. Only requires the default job_name: node, add as many targets as you need in '/etc/prometheus/prometheus.yml'. -``` +```yaml - job_name: node static_configs: - targets: ['localhost:9100'] @@ -81,7 +81,7 @@ For prometheus-bind-exporter https://github.com/prometheus-community/bind_export Monitor Bind9 service. Required configuration in /etc/bind/named.conf.options: -``` +```c++ statistics-channels { inet 127.0.0.1 port 8053 allow { 127.0.0.1; }; }; @@ -89,7 +89,7 @@ statistics-channels { On Grafana, it only requires a configured target under any job_name. For example: -``` +```yaml - job_name: 'bind' static_configs: - targets: From b05b003c4330f4b40c6614d93fc6d448cdf4554c Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 15:08:21 +0100 Subject: [PATCH 3/6] Beautify literals and links --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a075c77..c8cd951 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ For node_exporter Monitor Linux system. -Only requires the default job_name: node, add as many targets as you need in '/etc/prometheus/prometheus.yml'. +Only requires the default job_name: node, add as many targets as you need in `/etc/prometheus/prometheus.yml`. ```yaml @@ -15,13 +15,13 @@ Only requires the default job_name: node, add as many targets as you need in '/e - targets: ['localhost:9100'] ``` -Recommended for prometheus-node-exporter the arguments '--collector.systemd --collector.processes' because the graph uses some of their metrics. +Recommended for prometheus-node-exporter the arguments `--collector.systemd` and `--collector.processes` because the graph uses some of their metrics. Notes: -For prometheus-node-expter v.0.16 or older, use node-exporter-full-old.json +For prometheus-node-expter v.0.16 or older, use `node-exporter-full-old.json` -Thanks to the PCP project for document the values reported by the kernel in /proc (in their /pmdas/linux/help src file mainly). Url --> http://pcp.io +Thanks to the [PCP project](http://pcp.io) for document the values reported by the kernel in `/proc` (in their `/pmdas/linux/help` src file mainly). @@ -35,7 +35,7 @@ Only requires a configured target under any job_name. -## Haproxy Full _deprecated_ +## Haproxy Full _(deprecated)_ For haproxy_exporter @@ -59,7 +59,7 @@ Only requires a configured target under any job_name. Monitor Apache service. -Moved to https://github.com/grafana/jsonnet-libs +> Moved to https://github.com/grafana/jsonnet-libs @@ -69,17 +69,17 @@ For node_exporter Monitor all NFS and NFSd exported values. -Check that the process was started with the arguments "--collector.nfs" and "--collector.nfsd". +Check that the process was started with the arguments `--collector.nfs` and `--collector.nfsd`. -The same as Node Exporter Full. Only requires the default job_name: node, add as many targets as you need in '/etc/prometheus/prometheus.yml'. +The same as Node Exporter Full. Only requires the default job_name: node, add as many targets as you need in `/etc/prometheus/prometheus.yml`. -## Bind9 Full +## BIND 9 Full -For prometheus-bind-exporter https://github.com/prometheus-community/bind_exporter +For [prometheus-bind-exporter](https://github.com/prometheus-community/bind_exporter) -Monitor Bind9 service. Required configuration in /etc/bind/named.conf.options: +Monitor BIND 9 service. Required configuration in `/etc/bind/named.conf.options`: ```c++ statistics-channels { @@ -87,7 +87,7 @@ statistics-channels { }; ``` -On Grafana, it only requires a configured target under any job_name. For example: +On Grafana, it only requires a configured target under any `job_name`. For example: ```yaml - job_name: 'bind' From 7d8f8961564ea4d8cfd49a74a58a95ec21d23fc7 Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 15:13:35 +0100 Subject: [PATCH 4/6] Descriptions to bullet points --- README.md | 47 ++++++++++++++++++++--------------------------- 1 file changed, 20 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index c8cd951..08af79c 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,11 @@ ## Node Exporter Full -For node_exporter - -Monitor Linux system. +- For node_exporter +- Monitor Linux system. Only requires the default job_name: node, add as many targets as you need in `/etc/prometheus/prometheus.yml`. - ```yaml - job_name: node static_configs: @@ -18,46 +16,41 @@ Only requires the default job_name: node, add as many targets as you need in `/e Recommended for prometheus-node-exporter the arguments `--collector.systemd` and `--collector.processes` because the graph uses some of their metrics. Notes: - -For prometheus-node-expter v.0.16 or older, use `node-exporter-full-old.json` - -Thanks to the [PCP project](http://pcp.io) for document the values reported by the kernel in `/proc` (in their `/pmdas/linux/help` src file mainly). +- For prometheus-node-exporter v.0.16 or older, use `node-exporter-full-old.json` +- Thanks to the [PCP project](http://pcp.io) for document the values reported by the kernel in `/proc` (in their `/pmdas/linux/help` src file mainly). ## Node Exporter FreeBSD -For node_exporter in FreeBSD system +- For node_exporter in FreeBSD system +- Monitor FreeBSD system. -Monitor FreeBSD system. - -Only requires a configured target under any job_name. +Only requires a configured target under any `job_name`. ## Haproxy Full _(deprecated)_ -For haproxy_exporter +- For haproxy_exporter +- Monitor Haproxy service. -Monitor Haproxy service. - -Only requires a configured target under any job_name. +Only requires a configured target under any `job_name`. ## Haproxy 2 Full -For Haproxy compiled with Prometheus support +- For Haproxy compiled with Prometheus support +- Monitor Haproxy service direct. -Monitor Haproxy service direct. - -Only requires a configured target under any job_name. +Only requires a configured target under any `job_name`. ## Apache Full -Monitor Apache service. +- Monitor Apache service. > Moved to https://github.com/grafana/jsonnet-libs @@ -65,9 +58,8 @@ Monitor Apache service. ## NFS Full -For node_exporter - -Monitor all NFS and NFSd exported values. +- For node_exporter +- Monitor all NFS and NFSd exported values. Check that the process was started with the arguments `--collector.nfs` and `--collector.nfsd`. @@ -77,9 +69,10 @@ The same as Node Exporter Full. Only requires the default job_name: node, add as ## BIND 9 Full -For [prometheus-bind-exporter](https://github.com/prometheus-community/bind_exporter) - -Monitor BIND 9 service. Required configuration in `/etc/bind/named.conf.options`: +- For [prometheus-bind-exporter](https://github.com/prometheus-community/bind_exporter) +- Monitor BIND 9 service. + +Required configuration in `/etc/bind/named.conf.options`: ```c++ statistics-channels { From a44ac0c2ab4a3869a9f18ce51f05ba5b85a8d519 Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 15:21:58 +0100 Subject: [PATCH 5/6] Formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 08af79c..a6d4aff 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ Only requires a configured target under any `job_name`. Check that the process was started with the arguments `--collector.nfs` and `--collector.nfsd`. -The same as Node Exporter Full. Only requires the default job_name: node, add as many targets as you need in `/etc/prometheus/prometheus.yml`. +The same as Node Exporter Full. Only requires the default `job_name: node`, add as many targets as you need in `/etc/prometheus/prometheus.yml`. From 5dc30e50a9c25231efea070c870e29fc66c84717 Mon Sep 17 00:00:00 2001 From: Karsten Rohrbach Date: Sat, 9 Dec 2023 15:22:39 +0100 Subject: [PATCH 6/6] Add note about timeInterval, fixes #137 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6d4aff..1e02572 100644 --- a/README.md +++ b/README.md @@ -15,9 +15,9 @@ Only requires the default job_name: node, add as many targets as you need in `/e Recommended for prometheus-node-exporter the arguments `--collector.systemd` and `--collector.processes` because the graph uses some of their metrics. -Notes: -- For prometheus-node-exporter v.0.16 or older, use `node-exporter-full-old.json` -- Thanks to the [PCP project](http://pcp.io) for document the values reported by the kernel in `/proc` (in their `/pmdas/linux/help` src file mainly). +> - `timeInterval` in the Grafana data source has to be set accordingly to the > `scrape_interval` configured in Prometheus +> - For prometheus-node-exporter v.0.16 or older, use `node-exporter-full-old.> json` +> - Thanks to the [PCP project](http://pcp.io) for document the values reported > by the kernel in `/proc` (in their `/pmdas/linux/help` src file mainly).