checks

Documentation

Index

• Constants
• func RegisterCheck(c Check)
• func RegisterSearchChecks()
• type Aggregate
• type Check
  • func Checks() []Check
  • func GetCheck(name string) Check
• type CheckBundleFunc
• type CheckFuncBuilder
  • func (b CheckFuncBuilder) Build() CheckBundleFunc
• type CheckHostFunc
• type Result
  • func (r Result) IsHostSet() bool
• type Results
  • func DefaultAggregate(results Results) Results
  • func (r Results) OKs() Results
  • func (r Results) Problems() Results
  • func (r Results) Status() Status
  • func (r Results) Undefined() Results
• type SearchCheck
• type Status

Constants

const (
	// SUndefined means that the check wasn't performed successfully.
	SUndefined Status = "UNDEFINED"
	// SOK means that the bundle passed the check.
	SOK = "OK"
	// SProblem means that the bundle failed to pass the check.
	SProblem = "PROBLEM"
)

Functions

func RegisterCheck

func RegisterCheck(c Check)

RegisterCheck registers a new check to make it discoverable for consumers.

func RegisterSearchChecks

func RegisterSearchChecks()

Types

type Aggregate

type Aggregate func(results Results) Results

Aggregate aggregates check results produced by CheckMaster, CheckAgents, and CheckPublicAgents functions.

type Check

type Check struct {
	Name           string          `yaml:"name"`           // Required
	Description    string          `yaml:"description"`    // Required
	Cure           string          `yaml:"cure"`           // Required
	OKSummary      string          `yaml:"okSummary"`      // Optional
	ProblemSummary string          `yaml:"problemSummary"` // Optional
	Run            CheckBundleFunc // Required
}

Check checks some aspect of the DC/OS cluster analyzing its diagnostics bundle. Checks can be registered in the check registry with the registerCheck function.

func Checks

func Checks() []Check

Checks Returns all registered checks.

func GetCheck

func GetCheck(name string) Check

GetCheck returns check by name.

type CheckBundleFunc

type CheckBundleFunc func(bundle.Bundle) Results

type CheckFuncBuilder

type CheckFuncBuilder struct {
	CheckMasters      CheckHostFunc // At least one of
	CheckAgents       CheckHostFunc // the Collect... functions
	CheckPublicAgents CheckHostFunc // are required
	Aggregate         Aggregate     // Implement if the default is not sufficient
}

CheckFuncBuilder helps to create map/reduce-like checks.

func (CheckFuncBuilder) Build

func (b CheckFuncBuilder) Build() CheckBundleFunc

Build returns a check function Run.Check

type CheckHostFunc

type CheckHostFunc func(bundle.Host) Result

CheckHostFunc checks an individual host.

type Result

type Result struct {
	Status Status
	Value  interface{}
	Host   bundle.Host
}

Result represents check result.

func (Result) IsHostSet

func (r Result) IsHostSet() bool

type Results

type Results []Result

func DefaultAggregate

func DefaultAggregate(results Results) Results

Default implementation of the Aggregate function.

func (Results) OKs

func (r Results) OKs() Results

func (Results) Problems

func (r Results) Problems() Results

func (Results) Status

func (r Results) Status() Status

func (Results) Undefined

func (r Results) Undefined() Results

type SearchCheck

type SearchCheck struct {
	Check                `yaml:",inline"`
	FileTypeName         bundle.FileTypeName `yaml:"fileTypeName"`         // Required
	ErrorPattern         string              `yaml:"errorPattern"`         // Required
	CurePattern          string              `yaml:"curePattern"`          // Optional
	IsErrorPatternRegexp bool                `yaml:"isErrorPatternRegexp"` // Optional, default is false
	IsCurePatternRegexp  bool                `yaml:"isCurePatternRegexp"`  // Optional, default is false
	Max                  int                 `yaml:"max"`                  // Optional, default is 0
	FailIfNotFound       bool                `yaml:"failIfNotFound"`       // Optional, default false
	// contains filtered or unexported fields
}

SearchCheck is a check which searches for the specified string in the the specified files. If the pattern is found more than Max times, the check is considered problematic.

type Status

type Status string

Status defines possible check outcomes.