health

Documentation

Index

• func NewGrpcChecker(opts ...option) *grpcChecker
• func NewRestChecker(version, service string, opts ...option) *restChecker
• func WithCheck(name string, check check) option
• func WithInterval(interval time.Duration) option
• func WithTimeout(timeout time.Duration) option
• type Status
  • func (s Status) String() string

Functions

func NewGrpcChecker

func NewGrpcChecker(opts ...option) *grpcChecker

func NewRestChecker

func NewRestChecker(version, service string, opts ...option) *restChecker

func WithCheck

func WithCheck(name string, check check) option

func WithInterval

func WithInterval(interval time.Duration) option

func WithTimeout

func WithTimeout(timeout time.Duration) option

Types

type Status

type Status uint32

const (
	// Healthy is returned when the health check was successful
	Healthy Status = 0

	// Unhealthy is returned when the health check was unsuccessful
	Unhealthy Status = 1
)

func (Status) String

func (s Status) String() string