health

Documentation

Index

• Constants
• Variables
• func ReportError(check Check, err error, attributes ...Attr)
• func ReportInternalError(check Check, err error, attributes ...Attr)
• func ReportOK(check Check, attributes ...Attr)
• func SetProvider(p Provider)
• type Attr
  • func ErrorAttr(err error) Attr
  • func StrAttr(key, value string) Attr
• type Check
  • func ZeroResourceBundle(bundleID string) Check
• type Deduplicator
  • func NewDeduplicator() *Deduplicator
  • func (d *Deduplicator) ReportError(check Check, err error, attrs ...Attr)
  • func (d *Deduplicator) ReportOK(check Check, attrs ...Attr)
  • func (d *Deduplicator) SetProvider(p Provider)
• type Provider

Constants

const (
	// BuildDatabrokerConfig checks whether the Databroker config was applied
	BuildDatabrokerConfig = Check("config.databroker.build")
	// CollectAndSendTelemetry checks whether telemetry was collected and sent
	CollectAndSendTelemetry = Check("zero.telemetry.collect-and-send")
	// StorageBackend checks whether the storage backend is healthy
	StorageBackend = Check("storage.backend")
	// XDSCluster checks whether the XDS Cluster resources were applied
	XDSCluster = Check("xds.cluster")
	// XDSListener checks whether the XDS Listener resources were applied
	XDSListener = Check("xds.listener")
	// XDSRouteConfiguration checks whether the XDS RouteConfiguration resources were applied
	XDSRouteConfiguration = Check("xds.route-configuration")
	// XDSOther is a catch-all for other XDS resources
	XDSOther = Check("xds.other")
	// ZeroBootstrapConfigSave checks whether the Zero bootstrap config was saved
	ZeroBootstrapConfigSave = Check("zero.bootstrap-config.save")
	// ZeroConnect checks whether the Zero Connect service is connected
	ZeroConnect = Check("zero.connect")
	// RoutesReachable checks whether all referenced routes can be resolved to this instance
	RoutesReachable = Check("routes.reachable")
)

const InternalErrorKey = "internal_error"

InternalErrorKey is the key used to indicate that a check failed due to some non-user facing error

Variables

var ErrInternalError = errors.New("internal error")

Functions

func ReportError

func ReportError(check Check, err error, attributes ...Attr)

ReportError reports that a check failed

func ReportInternalError

func ReportInternalError(check Check, err error, attributes ...Attr)

ReportInternalError reports that a check failed due to an internal error

func ReportOK

func ReportOK(check Check, attributes ...Attr)

ReportOK reports that a check was successful

func SetProvider

func SetProvider(p Provider)

SetProvider sets the health check provider

Types

type Attr

type Attr struct {
	Key   string
	Value string
}

Attr is a key-value pair that can be attached to a health check

func ErrorAttr

func ErrorAttr(err error) Attr

ErrorAttr creates a new error attribute, that is used to indicate that a check failed due to some non-user facing error

func StrAttr

func StrAttr(key, value string) Attr

StrAttr creates a new string attribute

type Check

type Check string

func ZeroResourceBundle

func ZeroResourceBundle(bundleID string) Check

ZeroResourceBundle checks whether the Zero resource bundle was applied

type Deduplicator

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

Deduplicator is a health check provider that deduplicates health check reports i.e. it only reports a health check if the status or attributes have changed

func NewDeduplicator

func NewDeduplicator() *Deduplicator

func (*Deduplicator) ReportError

func (d *Deduplicator) ReportError(check Check, err error, attrs ...Attr)

ReportError implements the Provider interface

func (*Deduplicator) ReportOK

func (d *Deduplicator) ReportOK(check Check, attrs ...Attr)

ReportOK implements the Provider interface

func (*Deduplicator) SetProvider

func (d *Deduplicator) SetProvider(p Provider)

type Provider

type Provider interface {
	ReportOK(check Check, attributes ...Attr)
	ReportError(check Check, err error, attributes ...Attr)
}

Provider is the interface that must be implemented by a health check reporter