summaryrefslogtreecommitdiffstats
path: root/charts.d/README.md
diff options
context:
space:
mode:
authorFederico Ceratto <federico.ceratto@gmail.com>2018-03-27 21:28:21 +0000
committerFederico Ceratto <federico.ceratto@gmail.com>2018-03-27 21:28:21 +0000
commitd4dd00f58a502c9ca4b63e36ce6bc7a9945dc63c (patch)
treefaac99f51f182bb8c0a03e95e393d421ac9ddf42 /charts.d/README.md
parentNew upstream version 1.9.0+dfsg (diff)
downloadnetdata-d4dd00f58a502c9ca4b63e36ce6bc7a9945dc63c.tar.xz
netdata-d4dd00f58a502c9ca4b63e36ce6bc7a9945dc63c.zip
New upstream version 1.10.0+dfsgupstream/1.10.0+dfsg
Diffstat (limited to 'charts.d/README.md')
-rw-r--r--charts.d/README.md293
1 files changed, 168 insertions, 125 deletions
diff --git a/charts.d/README.md b/charts.d/README.md
index 37c9d22e..748af08a 100644
--- a/charts.d/README.md
+++ b/charts.d/README.md
@@ -1,5 +1,76 @@
The following charts.d plugins are supported:
+---
+
+# hddtemp
+
+The plugin will collect temperatures from disks
+
+It will create one chart with all active disks
+
+1. **temperature in Celsius**
+
+### configuration
+
+hddtemp needs to be running in daemonized mode
+
+```sh
+# host with daemonized hddtemp
+hddtemp_host="localhost"
+
+# port on which hddtemp is showing data
+hddtemp_port="7634"
+
+# array of included disks
+# the default is to include all
+hddtemp_disks=()
+```
+
+---
+
+# libreswan
+
+The plugin will collects bytes-in, bytes-out and uptime for all established libreswan IPSEC tunnels.
+
+The following charts are created, **per tunnel**:
+
+1. **Uptime**
+
+ * the uptime of the tunnel
+
+2. **Traffic**
+
+ * bytes in
+ * bytes out
+
+### configuration
+
+Its config file is `/etc/netdata/charts.d/libreswan.conf`.
+
+The plugin executes 2 commands to collect all the information it needs:
+
+```sh
+ipsec whack --status
+ipsec whack --trafficstatus
+```
+
+The first command is used to extract the currently established tunnels, their IDs and their names.
+The second command is used to extract the current uptime and traffic.
+
+Most probably user `netdata` will not be able to query libreswan, so the `ipsec` commands will be denied.
+The plugin attempts to run `ipsec` as `sudo ipsec ...`, to get access to libreswan statistics.
+
+To allow user `netdata` execute `sudo ipsec ...`, create the file `/etc/sudoers.d/netdata` with this content:
+
+```
+netdata ALL = (root) NOPASSWD: /sbin/ipsec whack --status
+netdata ALL = (root) NOPASSWD: /sbin/ipsec whack --trafficstatus
+```
+
+Make sure the path `/sbin/ipsec` matches your setup (execute `which ipsec` to find the right path).
+
+---
+
# mysql
The plugin will monitor one or more mysql servers
@@ -76,67 +147,89 @@ The above sets the mysql command only for server2. server1 will use the system d
If no configuration is given, the plugin will attempt to connect to mysql server at localhost.
+
---
-# squid
+# nut
-The plugin will monitor a squid server.
+The plugin will collect UPS data for all UPSes configured in the system.
-It will produce 4 charts:
+The following charts will be created:
-1. **Squid Client Bandwidth** in kbps
+1. **UPS Charge**
- * in
- * out
- * hits
+ * percentage changed
-2. **Squid Client Requests** in requests/sec
+2. **UPS Battery Voltage**
- * requests
- * hits
- * errors
+ * current voltage
+ * high voltage
+ * low voltage
+ * nominal voltage
-3. **Squid Server Bandwidth** in kbps
+3. **UPS Input Voltage**
- * in
- * out
+ * current voltage
+ * fault voltage
+ * nominal voltage
-4. **Squid Server Requests** in requests/sec
+4. **UPS Input Current**
- * requests
- * errors
+ * nominal current
-### autoconfig
+5. **UPS Input Frequency**
-The plugin will by itself detect squid servers running on
-localhost, on ports 3128 or 8080.
+ * current frequency
+ * nominal frequency
-It will attempt to download URLs in the form:
+6. **UPS Output Voltage**
-- `cache_object://HOST:PORT/counters`
-- `/squid-internal-mgr/counters`
+ * current voltage
+
+7. **UPS Load**
+
+ * current load
+
+8. **UPS Temperature**
+
+ * current temperature
-If any succeeds, it will use this.
### configuration
-If you need to configure it by hand, create the file
-`/etc/netdata/squid.conf` with the following variables:
+This is the internal default for `/etc/netdata/nut.conf`
-- `squid_host=IP` the IP of the squid host
-- `squid_port=PORT` the port the squid is listening
-- `squid_url="URL"` the URL with the statistics to be fetched from squid
-- `squid_timeout=SECONDS` how much time we should wait for squid to respond
-- `squid_update_every=SECONDS` the frequency of the data collection
+```sh
+# a space separated list of UPS names
+# if empty, the list returned by 'upsc -l' will be used
+nut_ups=
-Example `/etc/netdata/squid.conf`:
+# how frequently to collect UPS data
+nut_update_every=2
+```
+
+---
+
+# postfix
+
+The plugin will collect the postfix queue size.
+
+It will create two charts:
+
+1. **queue size in emails**
+2. **queue size in KB**
+
+### configuration
+
+This is the internal default for `/etc/netdata/postfix.conf`
```sh
-squid_host=127.0.0.1
-squid_port=3128
-squid_url="cache_object://127.0.0.1:3128/counters"
-squid_timeout=2
-squid_update_every=5
+# the postqueue command
+# if empty, it will use the one found in the system path
+postfix_postqueue=
+
+# how frequently to collect queue size
+postfix_update_every=15
```
---
@@ -189,113 +282,63 @@ sensors_excluded=()
---
-# hddtemp
-
-The plugin will collect temperatures from disks
-
-It will create one chart with all active disks
-
-1. **temperature in Celsius**
-
-### configuration
-
-hddtemp needs to be running in daemonized mode
-
-```sh
-# host with daemonized hddtemp
-hddtemp_host="localhost"
-
-# port on which hddtemp is showing data
-hddtemp_port="7634"
-
-# array of included disks
-# the default is to include all
-hddtemp_disks=()
-```
-
----
-
-# postfix
-
-The plugin will collect the postfix queue size.
-
-It will create two charts:
-
-1. **queue size in emails**
-2. **queue size in KB**
-
-### configuration
-
-This is the internal default for `/etc/netdata/postfix.conf`
-
-```sh
-# the postqueue command
-# if empty, it will use the one found in the system path
-postfix_postqueue=
-
-# how frequently to collect queue size
-postfix_update_every=15
-```
-
----
-
-# nut
-
-The plugin will collect UPS data for all UPSes configured in the system.
-
-The following charts will be created:
+# squid
-1. **UPS Charge**
+The plugin will monitor a squid server.
- * percentage changed
+It will produce 4 charts:
-2. **UPS Battery Voltage**
+1. **Squid Client Bandwidth** in kbps
- * current voltage
- * high voltage
- * low voltage
- * nominal voltage
+ * in
+ * out
+ * hits
-3. **UPS Input Voltage**
+2. **Squid Client Requests** in requests/sec
- * current voltage
- * fault voltage
- * nominal voltage
+ * requests
+ * hits
+ * errors
-4. **UPS Input Current**
+3. **Squid Server Bandwidth** in kbps
- * nominal current
+ * in
+ * out
-5. **UPS Input Frequency**
+4. **Squid Server Requests** in requests/sec
- * current frequency
- * nominal frequency
+ * requests
+ * errors
-6. **UPS Output Voltage**
+### autoconfig
- * current voltage
+The plugin will by itself detect squid servers running on
+localhost, on ports 3128 or 8080.
-7. **UPS Load**
+It will attempt to download URLs in the form:
- * current load
+- `cache_object://HOST:PORT/counters`
+- `/squid-internal-mgr/counters`
-8. **UPS Temperature**
+If any succeeds, it will use this.
- * current temperature
+### configuration
+If you need to configure it by hand, create the file
+`/etc/netdata/squid.conf` with the following variables:
-### configuration
+- `squid_host=IP` the IP of the squid host
+- `squid_port=PORT` the port the squid is listening
+- `squid_url="URL"` the URL with the statistics to be fetched from squid
+- `squid_timeout=SECONDS` how much time we should wait for squid to respond
+- `squid_update_every=SECONDS` the frequency of the data collection
-This is the internal default for `/etc/netdata/nut.conf`
+Example `/etc/netdata/squid.conf`:
```sh
-# a space separated list of UPS names
-# if empty, the list returned by 'upsc -l' will be used
-nut_ups=
-
-# how frequently to collect UPS data
-nut_update_every=2
+squid_host=127.0.0.1
+squid_port=3128
+squid_url="cache_object://127.0.0.1:3128/counters"
+squid_timeout=2
+squid_update_every=5
```
-
----
-