health

Oct 17, 2023

Changes in this version

+ var CheckTimeoutErr = errors.New("check timed out")

type CheckResult

+ func (cr *CheckResult) UnmarshalJSON(data []byte) error

+ func (cr CheckResult) MarshalJSON() ([]byte, error)

type CheckerOption

+ func WithInfo(values map[string]interface{}) CheckerOption

type CheckerResult

+ Info map[string]interface{}

May 1, 2023

Changes in this version

type Check

+ DisablePanicRecovery bool

Jul 26, 2021

Changes in this version

type CheckerOption

+ func WithInterceptors(interceptors ...Interceptor) CheckerOption

Jul 24, 2021

Changes in this version

type Check

+ Interceptors []Interceptor

+ MaxContiguousFails uint

+ type CheckResult struct

+ Error *string

+ Status AvailabilityStatus

+ Timestamp *time.Time

type CheckState

+ ContiguousFails uint

+ Result error

type Checker

+ IsStarted func() bool

+ type CheckerOption func(config *checkerConfig)

+ func WithDisabledAutostart() CheckerOption

+ type CheckerResult struct

+ Details *map[string]CheckResult

+ Status AvailabilityStatus

+ type CheckerState struct

+ CheckState map[string]CheckState

+ Status AvailabilityStatus

+ type HandlerOption func(*handlerConfig)

+ func WithResultWriter(writer ResultWriter) HandlerOption

+ func WithStatusCodeDown(httpStatus int) HandlerOption

+ func WithStatusCodeUp(httpStatus int) HandlerOption

+ type Interceptor func(next InterceptorFunc) InterceptorFunc

+ type InterceptorFunc func(ctx context.Context, name string, state CheckState) CheckState

+ type JSONResultWriter struct

+ func NewJSONResultWriter() *JSONResultWriter

+ func (r *JSONResultWriter) Write(result *CheckerResult, w http.ResponseWriter, req *http.Request) error

+ type MiddlewareFunc func(ctx context.Context) CheckerResult

+ type ResultWriter interface

+ Write func(result *CheckerResult, w http.ResponseWriter, r *http.Request) error

Jul 18, 2021

Changes in this version

+ type AfterComponentCheckListener func(ctx context.Context, state CheckState) context.Context

+ type BeforeComponentCheckListener func(ctx context.Context, state CheckState) context.Context

+ type ComponentStatusListener func(ctx context.Context, state CheckState)

+ type StatusListener func(ctx context.Context, status AvailabilityStatus, state map[string]CheckState)

Jul 18, 2021

Changes in this version

+ func NewHandlerFunc(checker Checker) http.HandlerFunc

+ func NewHandlerFuncWithConfig(checker Checker, cfg HandlerConfig) http.HandlerFunc

+ func NewHandlerWithConfig(checker Checker, cfg HandlerConfig) http.Handler

+ func WithAfterCheckListener(listener AfterSystemCheckListener) option

+ func WithBeforeCheckListener(listener BeforeSystemCheckListener) option

+ func WithDisabledDetails() option

+ func WithStatusListener(listener SystemStatusListener) option

+ type AfterCheckListener func(ctx context.Context, state CheckState) context.Context

+ type AfterSystemCheckListener func(ctx context.Context, state map[string]CheckState) context.Context

+ type AvailabilityStatus string

+ const StatusDown

+ const StatusUnknown

+ const StatusUp

+ type BeforeCheckListener func(ctx context.Context, state CheckState) context.Context

+ type BeforeSystemCheckListener func(ctx context.Context, state map[string]CheckState) context.Context

type Check

+ AfterCheckListener AfterCheckListener

+ BeforeCheckListener BeforeCheckListener

+ MaxConsecutiveFails uint

+ MaxTimeInError time.Duration

+ StatusListener CheckStatusListener

+ type CheckState struct

+ ConsecutiveFails uint

+ FirstCheckStartedAt time.Time

+ LastCheckedAt *time.Time

+ LastFailureAt *time.Time

+ LastResult error

+ LastSuccessAt *time.Time

+ Status AvailabilityStatus

+ type CheckStatus struct

+ Error *string

+ Status AvailabilityStatus

+ Timestamp *time.Time

+ type CheckStatusListener func(ctx context.Context, state CheckState)

+ type Checker interface

+ Check func(ctx context.Context) SystemStatus

+ GetRunningPeriodicCheckCount func() int

+ Start func()

+ Stop func()

+ func NewChecker(options ...option) Checker

+ type HandlerConfig struct

+ DisableCheckerAutostart bool

+ StatusCodeDown int

+ StatusCodeUp int

+ type SystemStatus struct

+ Details *map[string]CheckStatus

+ Status AvailabilityStatus

+ type SystemStatusListener func(ctx context.Context, status AvailabilityStatus, state map[string]CheckState)

Jul 9, 2021

Changes in this version

+ func NewHandler(options ...option) http.Handler

Jul 8, 2021

Changes in this version

+ func New(options ...option) http.Handler

+ func StartPeriodicChecks(healthHandler http.Handler)

+ func StopPeriodicChecks(healthHandler http.Handler)

+ func WithBasicAuth(username string, password string, sendStatusOnAuthFailure bool) option

+ func WithCacheDuration(duration time.Duration) option

+ func WithCheck(check Check) option

+ func WithCustomAuth(sendStatusOnAuthFailure bool, authFunc func(r *http.Request) error) option

+ func WithDisabledCache() option

+ func WithManualPeriodicCheckStart() option

+ func WithMaxErrorMessageLength(length uint) option

+ func WithMiddleware(mw Middleware) option

+ func WithPeriodicCheck(refreshPeriod time.Duration, check Check) option

+ func WithTimeout(timeout time.Duration) option

+ type Check struct

+ Check func(ctx context.Context) error

+ FailureTolerance time.Duration

+ FailureToleranceThreshold uint

+ Name string

+ Timeout time.Duration

+ type Middleware func(next http.Handler) http.Handler