AlarmOverride¶

class oci.monitoring.models.AlarmOverride(**kwargs)¶

Bases: object

Values to use for an independent evaluation of the alarm. You can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm’s base values (ruleName value of BASE)

Methods

__init__(**kwargs) Initializes a new AlarmOverride object with values from keyword arguments.

Attributes

`body`	Gets the body of this AlarmOverride.
`pending_duration`	Gets the pending_duration of this AlarmOverride.
`query`	Gets the query of this AlarmOverride.
`rule_name`	Gets the rule_name of this AlarmOverride.
`severity`	Gets the severity of this AlarmOverride.

__init__(**kwargs)¶

Initializes a new AlarmOverride object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

pending_duration (str) – The value to assign to the pending_duration property of this AlarmOverride.
severity (str) – The value to assign to the severity property of this AlarmOverride.
body (str) – The value to assign to the body property of this AlarmOverride.
rule_name (str) – The value to assign to the rule_name property of this AlarmOverride.
query (str) – The value to assign to the query property of this AlarmOverride.

body¶

Gets the body of this AlarmOverride. The human-readable content of the delivered alarm notification. Optionally include dynamic variables. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.

Example: High CPU usage alert. Follow runbook instructions for resolution.

Returns:	The body of this AlarmOverride.
Return type:	str

pending_duration¶

Gets the pending_duration of this AlarmOverride. The period of time that the condition defined in the alarm must persist before the alarm state changes from “OK” to “FIRING”. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to “FIRING”.

The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.

Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to “FIRING”.

The alarm updates its status to “OK” when the breaching condition has been clear for the most recent minute.

Example: PT5M

Returns:	The pending_duration of this AlarmOverride.
Return type:	str

query¶

Gets the query of this AlarmOverride. The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period. Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services.

Example of threshold alarm:

CpuUtilization[1m]{availabilityDomain=”cumS:PHX-AD-1”}.groupBy(availabilityDomain).percentile(0.9) > 85

Example of absence alarm:

CpuUtilization[1m]{availabilityDomain=”cumS:PHX-AD-1”}.absent()

Example of absence alarm with custom absence detection period of 20 hours:

CpuUtilization[1m]{availabilityDomain=”cumS:PHX-AD-1”}.absent(20h)

Returns:	The query of this AlarmOverride.
Return type:	str

rule_name¶

Gets the rule_name of this AlarmOverride. A user-friendly description for this alarm override. Must be unique across all ruleName values for the alarm.

Returns:	The rule_name of this AlarmOverride.
Return type:	str

severity¶

Gets the severity of this AlarmOverride. The perceived severity of the alarm with regard to the affected system.

Example: CRITICAL

Returns:	The severity of this AlarmOverride.
Return type:	str