NewChecker creates a new Checker. The provided options will be used to modify its configuration. If the Checker was not yet started (see Checker.IsSta

WithCheck adds a new health check that contributes to the overall service availability status. This check will be triggered each time Checker.Check is

NewHandler creates a new health check http.Handler.

WithPeriodicCheck adds a new health check that contributes to the overall service availability status. The health check will be performed on a fixed s

WithTimeout defines a timeout duration for all checks. You can override this timeout by using the timeout value in the Check configuration. Default va

WithStatusListener registers a listener function that will be called whenever the overall/aggregated system health status changes (e.g. from "up" to "

Check runs all synchronous (i.e., non-periodic) check functions. It returns the aggregated health status (combined from the results of this executions

WithCacheDuration sets the duration for how long the aggregated health check result will be cached. By default, the cache TTL (i.e, the duration for h

BasicLogger is a basic logger that is mostly used to showcase this library.

GetRunningPeriodicCheckCount returns the number of currently running periodic checks.

WithChecks adds a list of health checks that contribute to the overall service availability status. These checks will be triggered each time Checker.C

WithDisabledAutostart disables automatic startup of a Checker instance.

WithMiddleware configures a middleware that will be used by the handler to pro- and post-process HTTP requests and health checks. Refer to the documen

IsStarted returns true, if the Checker was started (see Checker.Start) and is currently still running. Returns false otherwise.

Start will start all necessary background workers and prepare the checker for further usage.

Stop stops will stop the checker.

WithDisabledCache disabled the check cache. This is not recommended in most cases. This will effectively lead to a health endpoint that initiates a ne

WithDisabledDetails disables all data in the JSON response body. The AvailabilityStatus will be the only content. Example: { "status":"down" }. Enable

WithInfo sets values that will be available in every health check result. For example, you can use this option if you want to set information about yo

WithInterceptors adds a list of interceptors that will be applied to every check function. Interceptors may intercept the function call and do some pr

WithResultWriter is responsible for writing a health check result (see CheckerResult) into an HTTP response. By default, JSONResultWriter will be used

WithStatusCodeDown sets an HTTP status code that will be used for responses where the system is considered to be unavailable ("down"). Default is HTTP

WithStatusCodeUp sets an HTTP status code that will be used for responses where the system is considered to be available ("up"). Default is HTTP statu

Write writes a CheckerResult into a http.ResponseWriter in a format that the ResultWriter supports (such as XML, JSON, etc.). A ResultWriter is expect

BasicAuth is a middleware that removes check details (such as service names, error messages, etc.) from the HTTP response on authentication failure. A

BasicLogger is a basic logger that is mostly used to showcase this library.

Check implements Checker.Check. Please refer to Checker.Check for more information.

CustomAuth is a middleware that removes check details (such as service names, error messages, etc.) from the HTTP response on authentication failure.

FullDetailsOnQueryParam is a middleware that removes check details (such as service names, error messages, etc.) from the HTTP response unless the req

NewJSONResultWriter creates a new instance of a JSONResultWriter.

Start implements Checker.Start. Please refer to Checker.Start for more information.

WithInfoFunc sets functions that compute values to be added to every health check result. It works similarly to WithInfo, but allows dynamic computati

GetRunningPeriodicCheckCount implements Checker.GetRunningPeriodicCheckCount. Please refer to Checker.GetRunningPeriodicCheckCount for more informatio

IsStarted implements Checker.IsStarted. Please refer to Checker.IsStarted for more information.

MarshalJSON provides a custom marshaller for the CheckResult type.

Stop implements Checker.Stop. Please refer to Checker.Stop for more information.