pinger

Documentation

Index

• type MessageStruct
• type Target
  • func (t Target) IsTargetReachable(packetLoss float64) bool
  • func (t Target) Out(reachable bool) (err error)
  • func (t Target) PingIt() (stats *probing.Statistics, err error)
  • func (t *Target) SetExtendedDefaults()
  • func (t *Target) Validate() (err error)

Types

type MessageStruct

type MessageStruct struct {
	MessagePositive, MessageNegative                   string
	SkipReachableMessageOut, SkipUnreachableMessageOut bool
}

MessageStruct - holds all relevant information about passed message details.

type Target

type Target struct {
	Address, Filepath   string
	Count, TTL, Size    int
	Timeout, Interval   time.Duration
	Privileged, Stdout  bool
	PacketLossThreshold float64
	Message             MessageStruct
}

Target - holds pro-bing ("github.com/prometheus-community/pro-bing") parameters enriched with Message details and other.

func (Target) IsTargetReachable

func (t Target) IsTargetReachable(packetLoss float64) bool

IsTargetReachable - returns true or false based if the PacketLossThreshold has been breached.

func (Target) Out

func (t Target) Out(reachable bool) (err error)

Out - determines if and what message should be printed, either to standard output or to the file specified in the filepath.

func (Target) PingIt

func (t Target) PingIt() (stats *probing.Statistics, err error)

PingIt - creates a NawPinger, sets various parameters for it and returns statistics gathered. Writes ping details to standard output.

func (*Target) SetExtendedDefaults

func (t *Target) SetExtendedDefaults()

SetExtendedDefaults - extends default MessagePositive and MessageNegative with Address if no custom message value was specified.

func (*Target) Validate

func (t *Target) Validate() (err error)

Validate - validates passed values to flags.