prober

Documentation

Index

• Variables
• type OptionFunc
  • func WithClient(client *http.Client) OptionFunc
  • func WithLogger(logger *log.Logger) OptionFunc
• type Prober
  • func New(timeout, backoff time.Duration, options ...OptionFunc) (*Prober, error)
  • func (p *Prober) Probe(url string) error

Variables

var ErrProbeTimeout = errors.New("probe timed out")

Types

type OptionFunc

type OptionFunc func(p *Prober) error

func WithClient

func WithClient(client *http.Client) OptionFunc

WithClient returns an OptionFunc which tells the Prober to use the specified client for probing.

func WithLogger

func WithLogger(logger *log.Logger) OptionFunc

WithLogger returns an OptionFunc which tells the Prober to use the specified logger.

type Prober

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

Prober is an object that polls and http URL and returns an error if it does not return 200 Ok within the specified timeout.

func New

func New(timeout, backoff time.Duration, options ...OptionFunc) (*Prober, error)

New creates a Prober that will check an endpoint every backoff seconds.

func (*Prober) Probe

func (p *Prober) Probe(url string) error

Probe repeatedly hits the specified url with a GET request every Prober.backoff, and blocks until a request returns 200, or Prober.timeout passes.