haelu

type Definition struct {
	// Name is the unique identifier for this subsystem within the Monitor.
	Name Name

	// Status is the initial status for this subsystem. By default, a subsystem's
	// initial state is StatusGood. Use this field to set a different Status that
	// will have effect until the first time an update occurs.
	Status Status

	// NonCritical indicates how this subsystem affects the overall Monitor status. By
	// default, this field is false, which means that a subsystem is critical.
	//
	// A critical subsystem directly affects a Monitor's overall status. If any critical
	// subsystems are StatusWarn, the overall status will be StatusWarn. If any critical
	// subsystems are StatusBad, the overall status will be StatusBad.
	//
	// A noncritcal subsystem will never cause a Monitor to be StatusBad. If any noncritical
	// subsystem is NOT StatusGood, the overall status will be StatusWarn.
	NonCritical bool

	// Probe is an optional closure that interrogates this subsystem's state. A probe will be
	// called only if both (1) the Monitor has been started, and (2) the subsystem is not paused.
	//
	// If no Probe is specified, the only way to update a subsystem's state is via its Updater.
	Probe Probe

	// ProbeInterval is the time interval on which any Probe is invoked. If no Probe is set,
	// this field is ignored.
	ProbeInterval time.Duration

	// Metadata are optional name/value pairs to associate with this subsystem. A caller may
	// specify any values in this map to act as metadata for the subsystem.
	Metadata Metadata
}

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

type HandlerOption interface {
	// contains filtered or unexported methods
}

type HealthResponseCoder func(Status) int

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

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

type MonitorOption interface {
	// contains filtered or unexported methods
}

type MonitorState struct {
	// Status is the new overall status of the Monitor.
	Status Status `json:"status" yaml:"status"`

	// LastUpdate is the timestamp of the monitor's last update to any subsystem.
	// This will include updates that may not have changed the status.
	//
	// This timestamp will always be in UTC.
	LastUpdate time.Time `json:"lastUpdate" yaml:"lastUpdate"`

	// Subsystems is a snapshot of the state of each subsystem within
	// the Monitor.
	Subsystems Subsystems `json:"subsystems" yaml:"subsystems"`
}

type Name string

type Probe func(context.Context) (Status, error)

type ProbeFunc interface {
	~func() bool |
		~func(context.Context) bool |
		~func() error |
		~func(context.Context) error |
		~func() Status |
		~func(context.Context) Status |
		~func() (Status, error) |
		~func(context.Context) (Status, error)
}

type SelfBooler interface {
	// Status indicates the health status for this error. If this method returns false,
	// StatusBad is assumed. If this method returns true, StatusGood is assumed.
	// Note that this allows errors to indicate a healthy status.
	Status() bool
}

type SelfStatuser interface {
	// Status returns the health status for this error. Note that this allows
	// errors to indicate a healthy status.
	Status() Status
}

type Status uint8

type Subsystem struct {
	// Name is the unique identifier for this subsystem.
	Name Name `json:"name" yaml:"name"`

	// Status is the current status of this subsystem. When creating a
	// Monitor, this is the initial status.
	Status Status `json:"status" yaml:"status"`

	// LastUpdate is the UTC timestamp of the last status update to this subsystem.
	// This field is set to the current time upon creation. Only status updates
	// affect this timestamp. Pausing or disabling a subsystem does not update
	// this field.
	LastUpdate time.Time `json:"lastUpdate,omitempty" yaml:"lastUpdate"`

	// LastError is the error that occurred with the most recent status update, if any.
	// This field is ignored when creating a Monitor.
	LastError error `json:"lastError,omitempty" yaml:"lastError"`

	// NonCritical indicates whether this subsystem is noncritical, i.e. how it affects
	// the overall Monitor status.
	NonCritical bool `json:"nonCritical" yaml:"nonCritical"`

	// Metadata is the optional set of name/value pairs that were supplied when the
	// subsystem was defined.
	Metadata Metadata `json:"metadata,omitempty" yaml:"metadata,omitempty"`
}

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

type Updater interface {
	// Update supplies a possibly new status and an optional error that
	// occurred while checking the status or otherwise using the subsystem.
	Update(Status, error)
}