ping

README

Ping Input plugin

This input plugin will measures the round-trip

Configuration:

# 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>)
## Not available in Windows.
# 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:

• 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 )
• packets_received ( from ping output )
• percent_reply_loss ( compute from packets_transmitted and reply_received )
• percent_packets_loss ( compute from packets_transmitted and packets_received )
• errors ( when host can not be found or wrong parameters is passed to application )
• response time
  • average_response_ms ( compute from minimum_response_ms and maximum_response_ms )
  • minimum_response_ms ( from ping output )
  • maximum_response_ms ( from ping output )
• result_code
  • 0: success
  • 1: no such host

Tags:

• host
• url

Example Output:

$ ./telegraf --config telegraf.conf --input-filter ping --test
* Plugin: ping, Collection 1
ping,host=WIN-PBAPLP511R7,url=www.google.com result_code=0i,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

Documentation

Index

• type HostPinger
• type Ping
  • func (_ *Ping) Description() string
  • func (p *Ping) Gather(acc telegraf.Accumulator) error
  • func (_ *Ping) SampleConfig() string

Types

type HostPinger

type HostPinger func(timeout float64, args ...string) (string, error)

HostPinger is a function that runs the "ping" function using a list of passed arguments. This can be easily switched with a mocked ping function for unit test purposes (see ping_test.go)

type Ping

type Ping struct {
	// Interval at which to ping (ping -i <INTERVAL>)
	PingInterval float64 `toml:"ping_interval"`

	// Number of pings to send (ping -c <COUNT>)
	Count int

	// Ping timeout, in seconds. 0 means no timeout (ping -W <TIMEOUT>)
	Timeout float64

	// Interface to send ping from (ping -I <INTERFACE>)
	Interface string

	// URLs to ping
	Urls []string
	// contains filtered or unexported fields
}

func (*Ping) Description

func (_ *Ping) Description() string

func (*Ping) Gather

func (p *Ping) Gather(acc telegraf.Accumulator) error

func (*Ping) SampleConfig

func (_ *Ping) SampleConfig() string