healthcheck

Documentation

Index

• type HealthCheck
  • func New(state Status, options ...Option) *HealthCheck
  • func (hc *HealthCheck) Close() error
  • func (hc *HealthCheck) Get() Status
  • func (hc *HealthCheck) Ready()
  • func (hc *HealthCheck) Serve(port int) (*HealthCheck, error)
  • func (hc *HealthCheck) Set(state Status)
• type Option
  • func Logger(logger *zap.Logger) Option
• type Status
  • func (s Status) String() string

Types

type HealthCheck

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

HealthCheck provides an HTTP endpoint that returns the health status of the service

func New

func New(state Status, options ...Option) *HealthCheck

New creates a HealthCheck with the specified initial state.

func (*HealthCheck) Close

func (hc *HealthCheck) Close() error

Close stops the HTTP server

func (*HealthCheck) Get

func (hc *HealthCheck) Get() Status

Get the current status of this health check

func (*HealthCheck) Ready

func (hc *HealthCheck) Ready()

Ready is a shortcut for Set(Ready) (kept for backwards compatibility)

func (*HealthCheck) Serve

func (hc *HealthCheck) Serve(port int) (*HealthCheck, error)

Serve starts HTTP server on the specified port.

func (*HealthCheck) Set

func (hc *HealthCheck) Set(state Status)

Set a new health check status

type Option

type Option func(*HealthCheck)

Option is a functional option for passing parameters to New()

func Logger

func Logger(logger *zap.Logger) Option

Logger creates an option to set the logger. If not specified, Nop logger is used.

type Status

type Status int

Status represents the state of the service.

const (
	// Unavailable indicates the service is not able to handle requests
	Unavailable Status = iota
	// Ready indicates the service is ready to handle requests
	Ready
	// Broken indicates that the healthcheck itself is broken, not serving HTTP
	Broken
)

func (Status) String

func (s Status) String() string