result

package

v0.4.2 Latest Latest Go to latest Published: May 25, 2023 License: GPL-2.0 Imports: 4 Imported by: 14

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NETWAYS/go-check

Links

Open Source Insights

Documentation ¶

Overview ¶

result tries to

Index ¶

func WorstState(states ...int) int
type Overall
type PartialResult
- func (o *PartialResult) AddSubcheck(subcheck PartialResult)
- func (s *PartialResult) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func WorstState ¶

func WorstState(states ...int) int

Determines the worst state from a list of states

Helps combining an overall states, only based on a few numbers for various checks.

Order of preference: Critical, Unknown, Warning, Ok

Types ¶

type Overall ¶

type Overall struct {
	Summary string

	Outputs []string // Deprecate this in a future version
	// contains filtered or unexported fields
}

So, this is the idea: A check plugin has a single Overall (singleton) Each partial thing which is tested, gets its own subcheck The results of these may be relevant to the overall status in the end or not, e.g. if a plugin tries two different methods for something and one suffices, but one fails, the whole check might be OK and only the subcheck Warning or Critical.

Example (WithSubchecks) ¶

var overall Overall

example_perfdata := perfdata.Perfdata{Label: "pd_test", Value: 5, Uom: "s"}
pd_list := perfdata.PerfdataList{}
pd_list.Add(&example_perfdata)

subcheck := PartialResult{
	State:    check.OK,
	Output:   "Subcheck1 Test",
	Perfdata: pd_list,
}

overall.AddSubcheck(subcheck)
overall.AddOK("bla")

fmt.Println(overall.GetOutput())

Output:

states: ok=1
[OK] bla
\_ [OK] Subcheck1 Test
|pd_test=5s

func (*Overall) Add ¶

func (o *Overall) Add(state int, output string)

Add State explicitely Hint: This will set stateSetExplicitely to true

Example ¶

overall := Overall{}
overall.Add(check.OK, "One element is good")
overall.Add(check.Critical, "The other is critical")

fmt.Printf("%#v\n", overall)

Output:

result.Overall{oks:1, warnings:0, criticals:1, unknowns:0, Summary:"", stateSetExplicitely:true, Outputs:[]string{"[OK] One element is good", "[CRITICAL] The other is critical"}, partialResults:[]result.PartialResult(nil)}

func (*Overall) AddCritical deprecated

func (o *Overall) AddCritical(output string)

Deprecated: Will be removed in a future version, use Add() instead

func (*Overall) AddOK deprecated

func (o *Overall) AddOK(output string)

Deprecated: Will be removed in a future version, use Add() instead

func (*Overall) AddSubcheck ¶ added in v0.4.0

func (o *Overall) AddSubcheck(subcheck PartialResult)

func (*Overall) AddUnknown deprecated

func (o *Overall) AddUnknown(output string)

Deprecated: Will be removed in a future version, use Add() instead

func (*Overall) AddWarning deprecated

func (o *Overall) AddWarning(output string)

Deprecated: Will be removed in a future version, use Add() instead

func (*Overall) GetOutput ¶

func (o *Overall) GetOutput() string

Example ¶

overall := Overall{}
overall.Add(check.OK, "One element is good")
overall.Add(check.Critical, "The other is critical")

fmt.Println(overall.GetOutput())

Output:

states: critical=1 ok=1
[OK] One element is good
[CRITICAL] The other is critical

func (*Overall) GetStatus ¶

func (o *Overall) GetStatus() int

Example ¶

overall := Overall{}
overall.Add(check.OK, "One element is good")
overall.Add(check.Critical, "The other is critical")

fmt.Println(overall.GetStatus())

Output:

2

func (*Overall) GetSummary ¶

func (o *Overall) GetSummary() string

nolint: funlen

type PartialResult ¶ added in v0.4.0

type PartialResult struct {
	State  int
	Output string

	Perfdata perfdata.PerfdataList
	// contains filtered or unexported fields
}

func (*PartialResult) AddSubcheck ¶ added in v0.4.0

func (o *PartialResult) AddSubcheck(subcheck PartialResult)

func (*PartialResult) String ¶ added in v0.4.0

func (s *PartialResult) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL