Documentation
¶
Index ¶
Constants ¶
const (
// NoDiagnosticInfo is used when a check does not have diagnostic information to show.
NoDiagnosticInfo = ""
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Fail ¶
type Fail struct {
Error error
}
Fail is the check outcome for checks that fail or encounter errors.
func (Fail) GetDiagnostics ¶
GetDiagnostics implements outcomes.Outcome.
func (Fail) GetOutcomeType ¶
GetOutcomeType implements outcomes.Outcome.
type Info ¶
type Info struct {
Diagnostics string
}
Info is the check outcome for checks that cannot be categorized as pass or fail, but instead simply give information about the status of the mesh/its components. These checks show dynamically-generated diagnostic information to the user to provide more context. Ex: check whether a pod participates in an SMI TrafficSplit or not, if yes - output the name of the TrafficSplit
func (Info) GetDiagnostics ¶
GetDiagnostics implements outcomes.Outcome.
func (Info) GetOutcomeType ¶
GetOutcomeType implements outcomes.Outcome.
type Outcome ¶
type Outcome interface {
// GetOutcomeType returns the type of the check outcome: pass/fail/info/unknown.
GetOutcomeType() string
// GetDiagnostics returns detailed diagnostics that were dynamically-generated during the check.
// Diagnostics may include details about a test failure or information about the mesh/its components
GetDiagnostics() string
// GetError returns the error which common.Runnable{}.Run() returned.
GetError() error
}
Outcome is the printable context returned from a check (common.Runnable).
type Pass ¶
type Pass struct {
Msg string
}
Pass is for check outcomes that are successful and do not have diagnostic information to show.
func (Pass) GetDiagnostics ¶
GetDiagnostics implements outcomes.Outcome.
func (Pass) GetOutcomeType ¶
GetOutcomeType implements outcomes.Outcome.
type Unknown ¶
type Unknown struct{}
Unknown is the outcome type that occurs when the check did not have a conclusive result
func (Unknown) GetDiagnostics ¶
GetDiagnostics implements outcomes.Outcome.
func (Unknown) GetOutcomeType ¶
GetOutcomeType implements outcomes.Outcome.
Source Files