health

Documentation

Index

• type Check
  • func NewCheck(gvr string) *Check
  • func (c Check) DeepCopyObject() runtime.Object
  • func (Check) GetObjectKind() schema.ObjectKind
  • func (c *Check) Inc(l Level)
  • func (c *Check) Set(l Level, v int64)
  • func (c *Check) Tally(l Level) int64
  • func (c *Check) Total(n int64)
• type Checks
• type Counts
• type Level
• type Message
• type Messages
• type Vital
• type Vitals

Types

type Check

type Check struct {
	Counts

	GVR string
}

Check tracks resource health.

func NewCheck

func NewCheck(gvr string) *Check

NewCheck returns a new health check.

func (Check) DeepCopyObject

func (c Check) DeepCopyObject() runtime.Object

DeepCopyObject returns a container copy.

func (Check) GetObjectKind

func (Check) GetObjectKind() schema.ObjectKind

GetObjectKind returns a schema object.

func (*Check) Inc

func (c *Check) Inc(l Level)

Inc increments a health metric.

func (*Check) Set

func (c *Check) Set(l Level, v int64)

Set sets a health metric.

func (*Check) Tally

func (c *Check) Tally(l Level) int64

Tally retrieves a given health metric.

func (*Check) Total

func (c *Check) Total(n int64)

Total stores a metric total.

type Checks

type Checks []*Check

Checks represents a collection of health checks.

type Counts

type Counts map[Level]int64

Counts tracks health counts by category.

type Level

type Level int

Level tracks health count categories.

const (
	// Unknown represents no health level.
	Unknown Level = 1 << iota

	// Corpus tracks total health.
	Corpus

	// S1 tracks series 1.
	S1

	// S2 tracks series 2.
	S2

	// S3 tracks series 3.
	S3
)

type Message

type Message struct {
	Level   Level
	Message string
	GVR     string
	FQN     string
}

Message represents a health message.

type Messages

type Messages []Message

Messages tracks a collection of messages.

type Vital

type Vital struct {
	Resource         string
	Total, OK, Toast int
}

Vital tracks a resource vitals.

type Vitals

type Vitals []Vital

Vitals tracks a collection of resource health.