check

Documentation

Index

• Constants
• type Check
• type Result
• type RunContext

Constants

const StatusError = "ERROR"

StatusError means the result could not be obtained

const StatusFail = "FAIL"

StatusFail means the system is unacceptable for production operation

const StatusInfo = "INFO"

StatusInfo means the result is informational only

const StatusPass = "PASS"

StatusPass means the result falls within the production operational requirements

const StatusWarn = "WARN"

StatusWarn means that the system is at risk for production operation

Types

type Check

type Check interface {
	Describe() string
	Run(context *RunContext) <-chan []Result
}

Check represent a single operation (API call, external program execution, etc.) that returns one or more result.

type Result

type Result struct {
	Title   string `json:"title"`
	Value   string `json:"value"`
	Status  string `json:"status"`
	Message string `json:"message"`
}

Result is the outcome of a particular check. A check may produce multiple results.

type RunContext

type RunContext struct {
	OutputStore output.Store
}

RunContext is container of other services available to checks within the context of a particular report run.