framework

Documentation

Index

• Constants
• type Check
• type CheckResult

Constants

const STATUS_ERROR = "ERROR"

STATUS_ERROR means the result could not be obtained

const STATUS_FAIL = "FAIL"

STATUS_FAILS means the system is unacceptable for production operation

const STATUS_INFO = "INFO"

STATUS_INFO means the result is informational only

const STATUS_PASS = "PASS"

STATUS_PASS means the result falls within the production operational requirements

const STATUS_WARN = "WARN"

STATUS_WARNS means that the system is at risk for production operation

Types

type Check

type Check interface {
	Describe() string
	Run() <-chan []CheckResult
}

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

type CheckResult

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