cronitor

Documentation

Index

• type Monitor
  • func New(url string) *Monitor
  • func (c *Monitor) Monitor(f func() error) error

Types

type Monitor

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

Monitor represents a Cronitor job monitor.

A Monitor with an empty URL behaves as a "no-op Monitor" and does not make HTTP requests.

func New

func New(url string) *Monitor

New creates a new Monitor with the given Cronitor telemetry URL. Panics if "net/url".Parse fails.

Passing the empty string will create a "no-op Monitor" that does not make any HTTP requests.

func (*Monitor) Monitor

func (c *Monitor) Monitor(f func() error) error

Monitor invokes f and communicates its state to Cronitor.

Monitor propagates errors related to setting the state, but in case f fails and setting the state fails, the state error is lost.