connectivity

Documentation

Index

• Variables
• type Checker
  • func (c *Checker) Check() bool
  • func (c *Checker) IsConnected() bool
• type Config
  • func (c *Config) ValidateAndSetDefaults() error

Variables

var (
	ErrInvalidInterval  = errors.New("connectivity.checker.interval must be 5s or higher")
	ErrInvalidDNSTarget = errors.New("connectivity.checker.target must be suffixed with :53")
)

Types

type Checker

type Checker struct {
	Target   string        `yaml:"target"` // e.g. 1.1.1.1:53
	Interval time.Duration `yaml:"interval,omitempty"`
	// contains filtered or unexported fields
}

Checker is the configuration for making sure Gatus has access to the internet.

func (*Checker) Check

func (c *Checker) Check() bool

func (*Checker) IsConnected

func (c *Checker) IsConnected() bool

type Config

type Config struct {
	Checker *Checker `yaml:"checker,omitempty"`
}

Config is the configuration for the connectivity checker.

func (*Config) ValidateAndSetDefaults

func (c *Config) ValidateAndSetDefaults() error