gocloud.dev: gocloud.dev/server/health Index | Files | Directories

package health

import "gocloud.dev/server/health"

Package health provides health check handlers.


Package Files


func HandleLive Uses

func HandleLive(w http.ResponseWriter, _ *http.Request)

HandleLive is an http.HandlerFunc that handles liveness checks by immediately responding with an HTTP 200 status.

type Checker Uses

type Checker interface {
    CheckHealth() error

Checker wraps the CheckHealth method.

CheckHealth returns nil if the resource is healthy, or a non-nil error if the resource is not healthy. CheckHealth must be safe to call from multiple goroutines.

type CheckerFunc Uses

type CheckerFunc func() error

CheckerFunc is an adapter type to allow the use of ordinary functions as health checks. If f is a function with the appropriate signature, CheckerFunc(f) is a Checker that calls f.

func (CheckerFunc) CheckHealth Uses

func (f CheckerFunc) CheckHealth() error

CheckHealth calls f().

type Handler Uses

type Handler struct {
    // contains filtered or unexported fields

Handler is an HTTP handler that reports on the success of an aggregate of Checkers. The zero value is always healthy.

func (*Handler) Add Uses

func (h *Handler) Add(c Checker)

Add adds a new check to the handler.

func (*Handler) ServeHTTP Uses

func (h *Handler) ServeHTTP(w http.ResponseWriter, _ *http.Request)

ServeHTTP returns 200 if it is healthy, 500 otherwise.


sqlhealthPackage sqlhealth provides a health check for a SQL database connection.

Package health imports 2 packages (graph) and is imported by 11 packages. Updated 2019-07-09. Refresh now. Tools for package owners.