prober

type Probe ¶

type Probe interface {
	Name() string
	Check(context.Context) error
}

Probe define a minimal set of methods that a probe should implement

type ProbeResult ¶

type ProbeResult struct {
	Name     string        `json:"name"`
	Healthy  bool          `json:"healthy"`
	Comment  string        `json:"comment"`
	Error    error         `json:"error"`
	Duration time.Duration `json:"duration"`
}

ProbeResult is the data structure used to retain the data fetched from a single probe

type Prober ¶

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

Prober entrypoint of the philae api. It will retain a set of probe and run checks when asked to

func NewProber(opts ...ProberOption) *Prober

func (p *Prober) AddProbe(probe Probe)

func (p *Prober) Check(ctx context.Context) *Result

func (p *Prober) CheckOneProbe(ctx context.Context, probeName string) *ProbeResult

type ProberError ¶

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

func (e *ProberError) AddError(name string, err error)

func (e *ProberError) Error() string

func (e *ProberError) IsEmpty() bool

type ProberOption ¶

type ProberOption func(p *Prober)

ProberOption is a function modifying some parameters of the Prober

func WithTimeout(d time.Duration) ProberOption

type Result ¶

type Result struct {
	Healthy bool           `json:"healthy"`
	Probes  []*ProbeResult `json:"probes"`
	Error   error          `json:"error"`
}

Result is the data structure used to retain the data fetched from a single run of each probes