results

Documentation

Index

• type Manager
  • func NewManager(updates chan Update) Manager
• type Result
  • func (r Result) String() string
  • func (r Result) ToPrometheusType() float64
• type Update

Types

type Manager

type Manager interface {
	// Get returns the cached result for the endpoint.
	Get(endpointID string) (Result, bool)
	// Set sets the cached result for the endpoint.
	Set(endpointID string, result Result)
	// Remove clears the cached result for the endpoint.
	Remove(endpointID string)
}

Manager provides a probe results cache and channel of updates.

func NewManager

func NewManager(updates chan Update) Manager

NewManager creates and returns an empty results manager.

type Result

type Result int

Result is the type for probe results.

const (
	// Unknown is encoded as -1 (type Result)
	Unknown Result = iota - 1

	// Success is encoded as 0 (type Result)
	Success

	// Failure is encoded as 1 (type Result)
	Failure
)

func (Result) String

func (r Result) String() string

func (Result) ToPrometheusType

func (r Result) ToPrometheusType() float64

ToPrometheusType translates a Result to a form which is better understood by prometheus.

type Update

type Update struct {
	EndpointID string
	Result     Result
}

Update is an enum of the types of updates sent over the Updates channel.