store

Documentation

Index

• type KeyedErrorHealthCheckSource
  • func NewKeyedErrorHealthCheckSource(checkType health.CheckType, checkMessage string) KeyedErrorHealthCheckSource
• type KeyedErrorSubmitter

Types

type KeyedErrorHealthCheckSource

type KeyedErrorHealthCheckSource interface {
	KeyedErrorSubmitter
	status.HealthCheckSource
}

KeyedErrorHealthCheckSource tracks errors by key to compute health status. Only entries with non-nil errors are stored. When computing health status, the KeyedErrorHealthCheckSource will return a health status with state HealthStateHealthy if it has no error entries. If it has any error entries, it will return a health status with the state set to HealthStateError and params including all errors by their keys.

func NewKeyedErrorHealthCheckSource

func NewKeyedErrorHealthCheckSource(checkType health.CheckType, checkMessage string) KeyedErrorHealthCheckSource

NewKeyedErrorHealthCheckSource creates a health messenger that tracks errors by keys to compute health status.

type KeyedErrorSubmitter

type KeyedErrorSubmitter interface {
	// Submit stores non-nil errors by the provided key in a map; keys of submitted nil errors are
	// deleted from the map.
	Submit(key string, err error)
}

KeyedErrorSubmitter is not intended to be implemented separately - it simply provides consumers the ability to scope a method argument, such as a constructor, to provide only the Submit functionality of the KeyedErrorHealthCheckSource.