Class AlarmOverride
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
)
Inherited Members
Namespace: Oci.MonitoringService.Models
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class AlarmOverride
Properties
Body
Declaration
[JsonProperty(PropertyName = "body")]
public string Body { get; set; }
Property Value
Type | Description |
---|---|
string | 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.
|
PendingDuration
Declaration
[JsonProperty(PropertyName = "pendingDuration")]
public string PendingDuration { get; set; }
Property Value
Type | Description |
---|---|
string | 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".
|
Query
Declaration
[JsonProperty(PropertyName = "query")]
public string Query { get; set; }
Property Value
Type | Description |
---|---|
string | 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:
|
RuleName
Declaration
[JsonProperty(PropertyName = "ruleName")]
public string RuleName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly description for this alarm override. Must be unique across all |
Severity
Declaration
[JsonProperty(PropertyName = "severity")]
[JsonConverter(typeof(StringEnumConverter))]
public Alarm.SeverityEnum? Severity { get; set; }
Property Value
Type | Description |
---|---|
Alarm.SeverityEnum? | The perceived severity of the alarm with regard to the affected system.
|