health

package
v0.9.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 28, 2020 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL