probe

Documentation

Index

• type Probe
  • func New(spyInterval, publishInterval time.Duration, publisher appclient.Publisher, ...) *Probe
  • func (p *Probe) AddReporter(rs ...Reporter)
  • func (p *Probe) AddTagger(ts ...Tagger)
  • func (p *Probe) AddTicker(ts ...Ticker)
  • func (p *Probe) Publish(rpt report.Report)
  • func (p *Probe) Start()
  • func (p *Probe) Stop()
• type Reporter
  • func ReporterFunc(name string, f func() (report.Report, error)) Reporter
• type Tagger
  • func NewTopologyTagger() Tagger
• type Ticker

Types

type Probe

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

Probe sits there, generating and publishing reports.

func New

func New(
	spyInterval, publishInterval time.Duration,
	publisher appclient.Publisher,
	noControls bool,
) *Probe

New makes a new Probe.

func (*Probe) AddReporter

func (p *Probe) AddReporter(rs ...Reporter)

AddReporter adds a new Reported to the Probe

func (*Probe) AddTagger

func (p *Probe) AddTagger(ts ...Tagger)

AddTagger adds a new Tagger to the Probe

func (*Probe) AddTicker

func (p *Probe) AddTicker(ts ...Ticker)

AddTicker adds a new Ticker to the Probe

func (*Probe) Publish

func (p *Probe) Publish(rpt report.Report)

Publish will queue a report for immediate publication, bypassing the spy tick

func (*Probe) Start

func (p *Probe) Start()

Start starts the probe

func (*Probe) Stop

func (p *Probe) Stop()

Stop stops the probe

type Reporter

type Reporter interface {
	Name() string
	Report() (report.Report, error)
}

Reporter generates Reports.

func ReporterFunc

func ReporterFunc(name string, f func() (report.Report, error)) Reporter

ReporterFunc uses a function to implement a Reporter

type Tagger

type Tagger interface {
	Name() string
	Tag(r report.Report) (report.Report, error)
}

Tagger tags nodes with value-add node metadata.

func NewTopologyTagger

func NewTopologyTagger() Tagger

NewTopologyTagger tags each node with the topology that it comes from. It's kind of a proof-of-concept tagger, useful primarily for debugging.

type Ticker

type Ticker interface {
	Name() string
	Tick() error
}

Ticker is something which will be invoked every spyDuration. It's useful for things that should be updated on that interval. For example, cached shared state between Taggers and Reporters.