health

Documentation

Overview

Package health provides an extended health status graph for Runtime.

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build(now time.Time) Report
  • func (b *Builder) Link(from, to string)
  • func (b *Builder) Set(n Node)
• type Edge
• type Node
• type Report
  • func (r Report) Dependents(name string) []string
  • func (r Report) Node(name string) (Node, bool)
  • func (r Report) Validate() []ValidationIssue
• type Status
• type ValidationIssue

Types

type Builder

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

Builder assembles a Report.

func NewBuilder

func NewBuilder() *Builder

NewBuilder creates a Builder.

func (*Builder) Build

func (b *Builder) Build(now time.Time) Report

Build computes overall status (worst-wins with lockdown/quarantine priority). Nodes and edges are sorted so identical runtime state produces identical JSON.

func (*Builder) Link

func (b *Builder) Link(from, to string)

Link adds a dependency edge.

func (*Builder) Set

func (b *Builder) Set(n Node)

Set adds or replaces a node.

type Edge

type Edge struct {
	From string `json:"from"`
	To   string `json:"to"`
}

Edge relates nodes (dependency). From depends on To.

type Node

type Node struct {
	Name    string            `json:"name"`
	Status  Status            `json:"status"`
	Message string            `json:"message,omitempty"`
	Attrs   map[string]string `json:"attrs,omitempty"`
}

Node is one node in the health graph.

type Report

type Report struct {
	Time    time.Time `json:"time"`
	Overall Status    `json:"overall"`
	Nodes   []Node    `json:"nodes"`
	Edges   []Edge    `json:"edges,omitempty"`
}

Report is a graph-oriented health snapshot.

func (Report) Dependents

func (r Report) Dependents(name string) []string

Dependents returns every node transitively affected when name becomes unavailable. Because Edge.From depends on Edge.To, the traversal follows reverse edges.

func (Report) Node

func (r Report) Node(name string) (Node, bool)

Node returns a named health node and whether it exists.

func (Report) Validate

func (r Report) Validate() []ValidationIssue

Validate checks node identity, dependency endpoints, self-dependencies, and cycles.

type Status

type Status string

Status is an extended health signal.

const (
	Healthy     Status = "healthy"
	Degraded    Status = "degraded"
	Unhealthy   Status = "unhealthy"
	Blocked     Status = "blocked"
	Unknown     Status = "unknown"
	Quarantined Status = "quarantined"
	LockedDown  Status = "locked-down"
)

type ValidationIssue

type ValidationIssue struct {
	Code    string `json:"code"`
	Node    string `json:"node,omitempty"`
	Message string `json:"message"`
}

ValidationIssue describes a structural problem in a health report.