health

package

v1.9.1 Latest Latest Go to latest Published: Mar 20, 2021 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/davidsbond/pkg

Links

Open Source Insights

Documentation ¶

Overview ¶

Package health contains helpers for constructing health checks.

Index ¶

Variables
func AddCheck(name string, fn func() error)
func PerformCheck(ctx context.Context) error
func RegisterGRPCHealthServer(svr *grpc.Server) *health.Server
func ServeGRPC(ctx context.Context, svr *health.Server) error
func ServeHTTP(r *mux.Router)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrDown = errors.New("application down")

ErrDown is the error returned when an HTTP health check returns a non-200 status.

View Source

var Flags = flag.Flags{
	&flag.Boolean{
		Name:        "health-check-disabled",
		Usage:       "Disables the health check endpoint",
		EnvVar:      "HEALTH_CHECK_DISABLED",
		Destination: &disabled,
		Hidden:      true,
	},
}

Flags contains all command-line flags that can be used to configure health checks.

Functions ¶

func AddCheck ¶

func AddCheck(name string, fn func() error)

AddCheck adds a status check to the status status. If the provided function returns an error the check is deemed unhealthy.

func PerformCheck ¶

func PerformCheck(ctx context.Context) error

PerformCheck performs an HTTP health check on localhost:8081/__/health. It returns an error if the health check endpoint returns a non-200 status code.

func RegisterGRPCHealthServer ¶

func RegisterGRPCHealthServer(svr *grpc.Server) *health.Server

RegisterGRPCHealthServer registers a gRPC health server implementation onto the provided gRPC server.

func ServeGRPC ¶

func ServeGRPC(ctx context.Context, svr *health.Server) error

ServeGRPC periodically updates the status of the health server based on the result of the current health. If any components are marked as down, the status is changed to NOT_SERVING. This function blocks until the provided context is cancelled.

func ServeHTTP ¶

func ServeHTTP(r *mux.Router)

ServeHTTP adds the status check endpoint to the given router.

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL