cmk.graphing.v1.perfometers

class Closed(value)

Parameters:: value (int | float | str | Constant | WarningOf | CriticalOf | MinimumOf | MaximumOf | Sum | Product | Difference | Fraction) – A bound value

Example

>>> Closed(23.5)
Closed(value=23.5)

class Open(value)

Parameters:: value (int | float | str | Constant | WarningOf | CriticalOf | MinimumOf | MaximumOf | Sum | Product | Difference | Fraction) – A bound value

Example

>>> Open(23.5)
Open(value=23.5)

class FocusRange(lower, upper)

Parameters:

lower (Closed | Open) – A lower bound
upper (Closed | Open) – An upper bound

For metric that only can produce values between 0 and 100, but never smaller or larger ones, use Closed borders:

>>> FocusRange(Closed(0), Closed(100))
FocusRange(lower=Closed(value=0), upper=Closed(value=100))

For metrics that can create arbitrarily small or large numbers, but you expect them to be between -10 and +10 most of the time, use Open borders.

>>> FocusRange(Open(-10), Open(+10))
FocusRange(lower=Open(value=-10), upper=Open(value=10))

class Perfometer(*, name, focus_range, segments)

Istances of this class will only be picked up by Checkmk if their names start with perfometer_.

Parameters:

name (str) – An unique name
focus_range (FocusRange) – A focus range
segments (Sequence[str | Constant | WarningOf | CriticalOf | MinimumOf | MaximumOf | Sum | Product | Difference | Fraction]) – A list of metric names or objects

Example

>>> perfometer_name = Perfometer(
...     name="name",
...     focus_range=FocusRange(Closed(0), Closed(100)),
...     segments=["metric-name-1", "metric-name-2"],
... )

class Bidirectional(*, name, left, right)

Instances of this class will only be picked up by Checkmk if their names start with perfometer_.

Parameters:

name (str) – An unique name
left (Perfometer) – A perfometer which grows to the left
right (Perfometer) – A perfometer which grows to the right

Example

>>> perfometer_name = Bidirectional(
...     name="name",
...     left=Perfometer(
...         name="left",
...         focus_range=FocusRange(Closed(0), Closed(100)),
...         segments=["metric-name-1", "metric-name-2"],
...     ),
...     right=Perfometer(
...         name="right",
...         focus_range=FocusRange(Closed(0), Closed(50)),
...         segments=["metric-name-3"],
...     ),
... )

class Stacked(*, name, lower, upper)

Instances of this class will only be picked up by Checkmk if their names start with perfometer_.

Parameters:

name (str) – An unique name
lower (Perfometer) – A perfometer at the bottom
upper (Perfometer) – A perfometer on the top

Example

>>> perfometer_name = Stacked(
...     name="name",
...     lower=Perfometer(
...         name="lower",
...         focus_range=FocusRange(Closed(0), Closed(100)),
...         segments=["metric-name-1", "metric-name-2"],
...     ),
...     upper=Perfometer(
...         name="upper",
...         focus_range=FocusRange(Closed(0), Closed(50)),
...         segments=["metric-name-3"],
...     ),
... )