Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/alexliesenfeld/health
/ types & classes
Types & classes
22 in github.com/alexliesenfeld/health
⨍
Functions
122
◇
Types & classes
22
↓ 1 callers
TypeAlias
AvailabilityStatus
AvailabilityStatus expresses the availability of either a component or the whole system.
check.go:139
Struct
Check
Check allows to configure health checks.
config.go:10
Struct
CheckResult
CheckResult holds a components health information. Attention: This type is converted from/to JSON using a custom marshalling/unmarshalling function (s
check.go:113
Struct
CheckState
CheckState represents the current state of a component check.
check.go:78
Interface
Checker
Checker is the main checker interface. It provides all health checking logic.
check.go:47
FuncType
CheckerOption
CheckerOption is a configuration option for a Checker.
config.go:48
Struct
CheckerResult
CheckerResult holds the aggregated system availability status and detailed information about the individual checks.
check.go:97
Struct
CheckerState
CheckerState represents the current state of the Checker.
check.go:70
Struct
HandlerConfig
handler.go:10
FuncType
HandlerOption
HandlerOption is a configuration option for a Handler (see NewHandler).
config.go:51
FuncType
Interceptor
Interceptor is factory function that allows creating new instances of a InterceptorFunc. The concept behind Interceptor is similar to the middleware p
check.go:131
FuncType
InterceptorFunc
InterceptorFunc is an interceptor function that intercepts any call to a components health check function.
check.go:135
Struct
JSONResultWriter
JSONResultWriter writes a CheckerResult in JSON format into an http.ResponseWriter. This ResultWriter is set by default.
handler.go:46
FuncType
Middleware
Middleware is factory function that allows creating new instances of a MiddlewareFunc. A MiddlewareFunc is expected to forward the function call to th
handler.go:24
FuncType
MiddlewareFunc
MiddlewareFunc is a middleware for a health Handler (see NewHandler). It is invoked each time an HTTP request is processed.
handler.go:28
Interface
ResultWriter
ResultWriter enabled a Handler (see NewHandler) to write the CheckerResult to an http.ResponseWriter in a specific format. For example, the JSONResult
handler.go:33
Struct
checkResult
check.go:35
Struct
checkerConfig
check.go:13
Struct
checkerMock
handler_test.go:18
Struct
defaultChecker
check.go:25
Struct
jsonCheckResult
check.go:40
Struct
resultWriterMock
handler_test.go:42