canary

type Manifest ¶

type Manifest struct {
	Targets []Target
}

Manifest represents configuration data.

func GetManifest(url string) (manifest Manifest, err error)

type Measurement ¶

type Measurement struct {
	Target Target
	Sample Sample
	Error  error
}

Measurement reprents an aggregate of Target, Sample and error.

type Publisher ¶

type Publisher interface {
	Publish(Measurement) error
}

Publisher is the interface that adds the Publish method.

Pubilsh takes a Target, and Sample, and an error, and is expected to deliver that data somewhere.

type Sample ¶

type Sample struct {
	StatusCode int
	T1         time.Time
	T2         time.Time
}

Sample represents HTTP state from a given point in time.

func (s Sample) Latency() float64

type Sampler ¶

type Sampler interface {
	Sample(Target) (Sample, error)
}

A Sampler is an interface that provides the Sample method.

type Scheduler ¶

type Scheduler struct {
	Target  Target
	C       chan Measurement
	Sampler Sampler
	// contains filtered or unexported fields
}

Scheduler is capable of repeatedly measuring a given Target with a specific Sampler, and returns those results over channel C.

func (s *Scheduler) Start()

func (s *Scheduler) Stop()

type StatusCodeError ¶

type StatusCodeError struct {
	StatusCode int
}

StatusCodeError is an error representing an HTTP Status code of 400 or greater.

func (e StatusCodeError) Error() string

type Target ¶

type Target struct {
	URL  string
	Name string
}

Target represents the things that we are measureing.