mon

Documentation

Index

• Constants
• type Check
  • func (c Check) String() string
• type Checks
• type Destination
• type Instance
• type Mon
  • func New(addr netip.Addr, services map[Instance]Target, notifier Notifier, ...) (*Mon, error)
  • func (m *Mon) Init(services map[Instance]Target) error
  • func (m *Mon) Probe(addr netip.Addr, c Check) (ok bool, s string)
  • func (m *Mon) ProbeVIP(vip, addr netip.Addr, c Check) (ok bool, s string)
  • func (m *Mon) Start(addr netip.Addr, services map[Instance]Target) error
  • func (m *Mon) Status(svc Service, dst Destination) (status Status, _ bool)
  • func (m *Mon) Stop()
  • func (m *Mon) Update(checks map[Instance]Target)
• type Notifier
• type Prober
• type SYN
  • func Syn(addr netip.Addr, rst bool) (*SYN, error)
  • func (s *SYN) Check(dst [4]byte, port uint16) (bool, string)
  • func (s *SYN) Probe(addr netip.Addr, port uint16) bool
• type Service
• type Services
• type Status
• type SynChecks
• type Target

Constants

const (
	GET  method = false
	HEAD method = true
	UDP  method = false
	TCP  method = true
)

Types

type Check

type Check struct {
	// Type of check; http, https, syn, dns
	Type string `json:"type,omitempty"`

	// TCP/UDP port to use for L4/L7 checks
	Port uint16 `json:"port,omitempty"`

	// HTTP Host header to send in healthcheck
	Host string `json:"host,omitempty"`

	// Path of resource to use when building a URI for HTTP/HTTPS healthchecks
	Path string `json:"path,omitempty"`

	// Expected HTTP status codes to allow check to succeed
	Expect []int `json:"expect,omitempty"`

	// Method - HTTP: GET=false, HEAD=true DNS: UDP=false TCP=true
	Method method `json:"method,omitempty"`
}

func (Check) String

func (c Check) String() string

render checks almost exactly like the raw Go output, but give more context to the method field

type Checks

type Checks = []Check

type Destination

type Destination struct {
	Address netip.Addr
	Port    uint16
}

type Instance

type Instance struct {
	Service     Service
	Destination Destination
}

type Mon

type Mon struct {
	C                    chan bool  // Used to signal changes in monitored service status
	Prober               Prober     // Override standard probing functionalitry
	Notifier             Notifier   // For logging
	CloseIdleConnections bool       // Call CloseIdleConnections on http.Client after probe if true
	IPv4                 netip.Addr // IP address to use as source for SYN probes (optional)
	// contains filtered or unexported fields
}

func New

func New(addr netip.Addr, services map[Instance]Target, notifier Notifier, prober Prober) (*Mon, error)

func (*Mon) Init

func (m *Mon) Init(services map[Instance]Target) error

func (*Mon) Probe

func (m *Mon) Probe(addr netip.Addr, c Check) (ok bool, s string)

func (*Mon) ProbeVIP

func (m *Mon) ProbeVIP(vip, addr netip.Addr, c Check) (ok bool, s string)

in case the http/s check has no host defined, use the vip as the host portion in the url (for DSR checks)

func (*Mon) Start

func (m *Mon) Start(addr netip.Addr, services map[Instance]Target) error

func (*Mon) Status

func (m *Mon) Status(svc Service, dst Destination) (status Status, _ bool)

func (*Mon) Stop

func (m *Mon) Stop()

func (*Mon) Update

func (m *Mon) Update(checks map[Instance]Target)

type Notifier

type Notifier interface {
	Notify(Instance, bool)
	Result(Instance, bool, string)
	Check(Instance, string, uint64, bool, string)
}

type Prober

type Prober interface {
	Probe(*Mon, Instance, Check) (bool, string)
}

type SYN

type SYN struct {
	// contains filtered or unexported fields
}

func Syn

func Syn(addr netip.Addr, rst bool) (*SYN, error)

func (*SYN) Check

func (s *SYN) Check(dst [4]byte, port uint16) (bool, string)

func (*SYN) Probe

func (s *SYN) Probe(addr netip.Addr, port uint16) bool

type Service

type Service struct {
	Address  netip.Addr
	Port     uint16
	Protocol uint8
}

type Services

type Services map[Instance]Checks

type Status

type Status struct {
	OK          bool
	Diagnostic  string
	Took        time.Duration
	Last        time.Time
	When        time.Time
	Initialised bool
}

type SynChecks

type SynChecks = SYN

type Target

type Target struct {
	Init   bool
	Checks Checks
}