ping

Documentation

Index

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

Types

type HostPinger

type HostPinger func(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 -t <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 plugins.Accumulator) error

func (*Ping) SampleConfig

func (_ *Ping) SampleConfig() string