dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update ping-input-plugin Readme (#2651)

This commit is contained in:
Gregory Kman 2017-04-12 19:46:48 -05:00 committed by Daniel Nelson
parent 9388fff1f7
commit 45c9b867f6
2 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
plugins/inputs/ping/README.md
View File

@ -1,20 +1,27 @@
# Ping input plugin # Ping Input plugin
This input plugin will measures the round-trip This input plugin will measures the round-trip
## Windows:
### Configuration: ### Configuration:
```
## urls to ping
urls = ["www.google.com"] # required
## number of pings to send per collection (ping -n <COUNT>)
count = 4 # required
## Ping timeout, in seconds. 0 means default timeout (ping -w <TIMEOUT>)
Timeout = 0
``` ```
# NOTE: this plugin forks the ping command. You may need to set capabilities
# via setcap cap_net_raw+p /bin/ping
[[inputs.ping]]
## List of urls to ping
urls = ["www.google.com"] # required
## number of pings to send per collection (ping -c <COUNT>)
# count = 1
## interval, in s, at which to ping. 0 == default (ping -i <PING_INTERVAL>)
# ping_interval = 1.0
## per-ping timeout, in s. 0 == no timeout (ping -W <TIMEOUT>)
# timeout = 1.0
## interface to send ping from (ping -I <INTERFACE>)
# interface = ""
```
### Measurements & Fields: ### Measurements & Fields:
- packets_transmitted ( from ping output ) - packets_transmitted ( from ping output )
- reply_received ( increasing only on valid metric from echo replay, eg. 'Destination net unreachable' reply will increment packets_received but not reply_received ) - reply_received ( increasing only on valid metric from echo replay, eg. 'Destination net unreachable' reply will increment packets_received but not reply_received )
- packets_received ( from ping output ) - packets_received ( from ping output )
@ -27,10 +34,14 @@ This input plugin will measures the round-trip
- maximum_response_ms ( from ping output ) - maximum_response_ms ( from ping output )
### Tags: ### Tags:
- server
- host
- url
### Example Output: ### Example Output:
``` ```
$ ./telegraf -config telegraf.conf -input-filter ping -test
* Plugin: ping, Collection 1 * Plugin: ping, Collection 1
ping,host=WIN-PBAPLP511R7,url=www.google.com average_response_ms=7i,maximum_response_ms=9i,minimum_response_ms=7i,packets_received=4i,packets_transmitted=4i,percent_packet_loss=0,percent_reply_loss=0,reply_received=4i 1469879119000000000 ping,host=WIN-PBAPLP511R7,url=www.google.com average_response_ms=7i,maximum_response_ms=9i,minimum_response_ms=7i,packets_received=4i,packets_transmitted=4i,percent_packet_loss=0,percent_reply_loss=0,reply_received=4i 1469879119000000000
``` ```

2
plugins/inputs/ping/ping.go
View File

@ -49,7 +49,7 @@ const sampleConfig = `
## NOTE: this plugin forks the ping command. You may need to set capabilities ## NOTE: this plugin forks the ping command. You may need to set capabilities
## via setcap cap_net_raw+p /bin/ping ## via setcap cap_net_raw+p /bin/ping
# #
## urls to ping ## List of urls to ping
urls = ["www.google.com"] # required urls = ["www.google.com"] # required
## number of pings to send per collection (ping -c <COUNT>) ## number of pings to send per collection (ping -c <COUNT>)
# count = 1 # count = 1