health

Documentation

Index

• type Module
  • func New(net net.Module) *Module
  • func (m *Module) Check(ctx context.Context) (status Status, messages []string, err error)
• type Status
  • func (s Status) String() string

Types

type Module

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

Module exposes the health api.

func New

func New(net net.Module) *Module

New creates a new net module.

func (*Module) Check

func (m *Module) Check(ctx context.Context) (status Status, messages []string, err error)

Check returns the current health status and any messages related to the status.

type Status

type Status int

Status represents the node's health status.

const (
	// Unspecified is an unknown or empty status.
	Unspecified Status = iota
	// Ok specifies the node is healthy
	Ok
	// Degraded specifies there are problems with the node health.
	Degraded
	// Error specifies there was an error when determining node health.
	Error
)

func (Status) String

func (s Status) String() string