Alarm Properties

A list of configurable Alarm properties.

clear_query

An Op statement that clears the Alarm. This statement may be the opposite of the fire_query in simple configurations.

op>
high_cpu_alarm.clear_query = <clear_query>
op>
high_cpu_alarm.clear_query = (cpu_usage < 65 | sum(30)) >= 15.0

fire_query

An Op Metric query that must evaluate to a boolean value (i.e., true or false / 1 or 0) in order to raise the associated Alarm.

This property is automatically defined when creating an Alarm within the CLI:

op>
alarm high_cpu_alarm = <fire_query>
op>
alarm high_cpu_alarm = (cpu_usage > 65 | sum(30)) >= 15.0

metric_name

Set the monitored Metric associated with an Alarm using a custom resource_query.

To set the monitored metric_name via the CLI you must specify a valid Metric name based on the selected resource_type.

For example, applicable Metrics for host Resources include CPU, disk, and memory options such as:

op>
high_cpu_alarm.metric_name = "cpu_idle"
op>
high_cpu_alarm.metric_name = "disk_used"
op>
high_cpu_alarm.metric_name = "mem_free"
See the Metrics Overview for more details.

name

The name of the Alarm. This value must contain only alphanumeric or underscore characters, and must be globally unique.

op>
alarm name = <fire_query>

raise_for

Determines if the Alarm is triggered by individual Resources ("local") or aggregated Resources.

op>
high_cpu_alarm.raise_for = "local"

resource_query

An Op Command query that specifies which Resources may trigger the Alarm.

op>
high_cpu_alarm.resource_query = <resource_query>
op>
high_cpu_alarm.resource_query = host | .pod

resource_type

Defines the type of Resources displayed for this Alarm within the UI.

The string value must be one of: HOST, POD, or CONTAINER.

op>
high_cpu_alarm.resource_type = "HOST"
op>
high_cpu_alarm.resource_type = "POD"
op>
high_cpu_alarm.resource_type = "CONTAINER"