health

Documentation

Index

• type Checker
• type Checks
  • func New(opts *Options) *Checks
  • func (c *Checks) Liveness() http.HandlerFunc
  • func (c *Checks) Readiness() http.HandlerFunc
  • func (c *Checks) SetReady(isReady bool)
• type Options

Types

type Checker

type Checker interface {
	// Liveness returns a handler that returns 200 OK if the server is alive (running).
	Liveness() http.HandlerFunc

	// Readiness returns a handler that returns 200 OK if the server is ready to accept traffic
	// and 503 Service Unavailable if the server is not ready to serve traffic.
	Readiness() http.HandlerFunc

	// SetReady should automatically be set to true when the server is ready to accept traffic.
	SetReady(isReady bool)
}

Checker defines an interface that must be implemented by a health checker to determine if the router can currently accept traffic.

type Checks

type Checks struct {
	// contains filtered or unexported fields
}

func New

func New(opts *Options) *Checks

func (*Checks) Liveness

func (c *Checks) Liveness() http.HandlerFunc

Liveness returns a handler that returns 200 OK if the server is alive (running).

func (*Checks) Readiness

func (c *Checks) Readiness() http.HandlerFunc

Readiness returns a handler that returns 200 OK if the server is ready to accept traffic and 503 Service Unavailable if the server is not ready to serve traffic.

func (*Checks) SetReady

func (c *Checks) SetReady(isReady bool)

SetReady sets the readiness state to the given value

type Options

type Options struct {
	Logger *zap.Logger
}