From 133fabc672d5592523cb9b9fd5f2e965098aac10 Mon Sep 17 00:00:00 2001 From: Daniel Nelson Date: Thu, 25 Oct 2018 12:44:43 -0700 Subject: [PATCH] Update ipvs readme for style --- plugins/inputs/ipvs/README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/plugins/inputs/ipvs/README.md b/plugins/inputs/ipvs/README.md index 78bb94574..6a4eaf6fe 100644 --- a/plugins/inputs/ipvs/README.md +++ b/plugins/inputs/ipvs/README.md @@ -1,14 +1,18 @@ -# IPVS Input Plugin (Linux) +# IPVS Input Plugin The IPVS input plugin uses the linux kernel netlink socket interface to gather metrics about ipvs virtual and real servers. -## Configuration +**Supported Platforms:** Linux +### Configuration: + +```toml [[inputs.ipvs]] # no configuration +``` -## Permissions +### Permissions: Assuming you installed the telegraf package via one of the published packages, the process will be running as the `telegraf` user. However, in order for this @@ -16,9 +20,7 @@ plugin to communicate over netlink sockets it needs the telegraf process to be running as `root` (or some user with `CAP_NET_ADMIN` and `CAP_NET_RAW`). Be sure to ensure these permissions before running telegraf with this plugin included. -## Sample Output - -This is what you can expect the emitted metrics to look like +### Example Output: ``` ipvs_virtual_server,address=172.18.64.234,address_family=inet,netmask=32,port=9000,protocol=tcp,sched=mh_418 bytes_out=0i,pps_in=0i,pps_out=0i,cps=0i,pkts_in=0i,pkts_out=0i,connections=0i,bytes_in=0i 1540407540000000000