Update fping plugin documentation with better details about the required version. (#13765)
Update fping plugin documentation with better details about required version.
Austin S. Hemmelgarn committed
Oct 13, 2022 at 09:36 UTC
4521b76927488a8af02b83b7dce742a8f250e5e3
1 file changed
+14
-6
collectors/fping.plugin/README.md
+14
-6
@@ -8,22 +8,30 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/fping
8
The fping plugin supports monitoring latency, packet loss and uptime of any number of network end points,
9
by pinging them with `fping`.
10
11
-A recent version of `fping` is required (one that supports option `-N`).
12
-The supplied plugin can install it, by running:
11
+This plugin requires version 5.1 or newer of `fping` (earlier versions may or may not work). Our static builds and
12
+Docker images come bundled with a known working version of `fping`. Native packages and local builds will need to
13
+have a working version installed before the plugin is usable.
14
+
15
+## Installing fping locally
16
+
17
+If your distribution’s repositories do not include a working version of `fping`, the supplied plugin can install
18
+it, by running:
19
20
```sh
21
/usr/libexec/netdata/plugins.d/fping.plugin install
22
```
23
18
-The above will download, build and install the right version as `/usr/local/bin/fping`.
24
+The above will download, build and install the right version as `/usr/local/bin/fping`. This requires a working C
25
+compiler, GNU autotools (at least autoconf and automake), and GNU make. On Debian or Ubuntu, you can pull in most
26
+of the required tools by installing the `build-essential` package (this should include everything except automake
27
+and autoconf).
28
+
29
+## Configuration
30
31
Then you need to edit `/etc/netdata/fping.conf` (to edit it on your system run
32
`/etc/netdata/edit-config fping.conf`) like this:
33
34
```sh
24
-# uncomment the following line - it should already be there
25
-fping="/usr/local/bin/fping"
26
-
35
# set here all the hosts you need to ping
36
# I suggest to use hostnames and put their IPs in /etc/hosts
37
hosts="host1 host2 host3"