server

Documentation

Index

• Constants
• func Handle(w http.ResponseWriter, req *http.Request)
• func Start() error

Constants

const (
	// ContentType is the media (MIME) type returned by the server.
	ContentType = "application/health+json"

	// Port is the default port for checking health over HTTP.
	Port = 9_999
)

Functions

func Handle

func Handle(w http.ResponseWriter, req *http.Request)

Handle serves a health response over HTTP. It supports the GET, HEAD and OPTIONS methods as well as content negotiation.

func Start

func Start() error

Start starts an HTTP server at 0.0.0.0:9999 serving health checks. Can be called multiple times but will only start one server.

Will block until the server is listening.