health

package
Version: v0.0.0-...-c2105a4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

README

health

This module enables a simple health check endpoint. By default it will listen on port 8080.

Syntax

health [ADDRESS]

Optionally takes an address; the default is :8080. The health path is fixed to /health. The health endpoint returns a 200 response code and the word "OK" when CoreDNS is healthy. It returns a 503. health periodically (1s) polls middleware that exports health information. If any of the middleware signals that it is unhealthy, the server will go unhealthy too. Each middleware that supports health checks has a section "Health" in their README.

Examples

Run another health endpoint on http://localhost:8091.

health localhost:8091

Documentation

Overview

Package health implements an HTTP handler that responds to health checks.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Healther

type Healther interface {
	// Health returns a boolean indicating the health status of a middleware.
	// False indicates unhealthy.
	Health() bool
}

Healther interface needs to be implemented by each middleware willing to provide healthhceck information to the health middleware. As a second step the middleware needs to registered against the health middleware, by addding it to healthers map. Note this method should return quickly, i.e. just checking a boolean status, as it is called every second from the health middleware.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL