ping

Documentation

Index

• type Context
• type Manager
  • func NewManager(hist *prometheus.HistogramVec, conf ManagerConfig) *Manager
  • func (m *Manager) Run(ctx context.Context) error
• type ManagerConfig
• type Pinger
  • func NewPinger(ip *net.IPAddr, obs observerVec, interval, timeout time.Duration) (Pinger, error)

Types

type Context

type Context struct {
	context.Context
	// contains filtered or unexported fields
}

Context is used to track the execution of Pingers

type Manager

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

Manager starts and stops pinger instances based on configuration and DNS responses

func NewManager

func NewManager(hist *prometheus.HistogramVec, conf ManagerConfig) *Manager

NewManager returns a new instance of a ping Manager

func (*Manager) Run

func (m *Manager) Run(ctx context.Context) error

Run starts the manager. This will block until the context is canceled

type ManagerConfig

type ManagerConfig struct {
	Source     string
	DNSTargets []string
	IPTargets  []string

	UpdateInterval time.Duration
	PingInterval   time.Duration
	PingTimeout    time.Duration
}

ManagerConfig contains configuration of the Manager

type Pinger

type Pinger interface {
	Ping(ctx context.Context) error
}

Pinger provides a method to continuously ping a single configured endpoint

func NewPinger

func NewPinger(ip *net.IPAddr, obs observerVec, interval, timeout time.Duration) (Pinger, error)

NewPinger returns a new instance of pinger