ping

Documentation

Overview

Package ping is the ping probe package

Index

• Constants
• type Ping
  • func (p *Ping) Config(gConf global.ProbeSettings) error
  • func (p *Ping) DoProbe() (bool, string)
  • func (p *Ping) ExportMetrics(stats *ping.Statistics)

Constants

const DefaultLostThreshold = 0.0

DefaultLostThreshold is the default lost threshold - 0% lost

const DefaultPingCount = 3

DefaultPingCount is the default ping count

Types

type Ping

type Ping struct {
	base.DefaultProbe `yaml:",inline"`
	Host              string  `yaml:"host" json:"host" jsonschema:"required,title=Host,description=The host to ping"`
	Count             int     `yaml:"count" json:"count" jsonschema:"title=Count,description=The number of ping packets to send,minimum=1,default=3"`
	LostThreshold     float64 `` /* 128-byte string literal not displayed */
	Privileged        bool    `yaml:"privileged" json:"privileged" jsonschema:"title=Privileged,description=Run ping with privileged modem, default=false"`
	// contains filtered or unexported fields
}

Ping implements a config for ping

func (*Ping) Config

func (p *Ping) Config(gConf global.ProbeSettings) error

Config Ping Config Object

func (*Ping) DoProbe

func (p *Ping) DoProbe() (bool, string)

DoProbe return the checking result

func (*Ping) ExportMetrics

func (p *Ping) ExportMetrics(stats *ping.Statistics)

ExportMetrics export Ping metrics