health

Documentation

Index

• type Checker
• type Health
  • func Down(options ...Option) Health
  • func Of(status Status, options ...Option) Health
  • func OutOfService(options ...Option) Health
  • func Unknown(options ...Option) Health
  • func Up(options ...Option) Health
• type Option
  • func WithDetails(details map[string]any) Option
• type Status

Types

type Checker

type Checker interface {
	DoHealthCheck() (Health, error)
}

type Health

type Health interface {
	HealthStatus() Status
	Details() map[string]any
}

func Down

func Down(options ...Option) Health

func Of

func Of(status Status, options ...Option) Health

func OutOfService

func OutOfService(options ...Option) Health

func Unknown

func Unknown(options ...Option) Health

func Up

func Up(options ...Option) Health

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithDetails

func WithDetails(details map[string]any) Option

type Status

type Status int

const (
	StatusUnknown Status = iota + 1
	StatusUp
	StatusDown
	StatusOutOfService
)