Class Alarm

The properties that define an alarm. For information about alarms, see Alarms Overview.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.

Inheritance

object

Alarm

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Models

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class Alarm

Properties

AlarmSummary

Declaration

[JsonProperty(PropertyName = "alarmSummary")]
public string AlarmSummary { get; set; }

Property Value

Type Description

Type	Description
string	Customizable alarm summary (`alarmSummary` alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.

string

Customizable alarm summary (alarmSummary alarm message parameter). Optionally include dynamic variables. The alarm summary appears within the body of the alarm message and in responses to {@link #listAlarmsStatus(ListAlarmsStatusRequest) listAlarmsStatus} {@link #getAlarmHistory(GetAlarmHistoryRequest) getAlarmHistory} and {@link #retrieveDimensionStates(RetrieveDimensionStatesRequest) retrieveDimensionStates}.

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. Example: High CPU usage alert. Follow runbook instructions for resolution.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the alarm.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations": {"CostCenter": "42"}}

Destinations

Declaration

[Required(ErrorMessage = "Destinations is required.")]
[JsonProperty(PropertyName = "destinations")]
public List<string> Destinations { get; set; }

Property Value

Type	Description
List<string>	A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a {@link NotificationTopic}. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.

Remarks

Required

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name for the alarm. It does not have to be unique, and it's changeable. This value determines the title of each alarm notification. Example: High CPU Utilization

Remarks

Required

EvaluationSlackDuration

Declaration

[JsonProperty(PropertyName = "evaluationSlackDuration")]
public string EvaluationSlackDuration { get; set; }

Property Value

Type	Description
string	Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period.

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the alarm.

Remarks

Required

IsEnabled

Declaration

[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }

Property Value

Type	Description
bool?	Whether the alarm is enabled. Example: true

Remarks

Required

IsNotificationsPerMetricDimensionEnabled

Declaration

[JsonProperty(PropertyName = "isNotificationsPerMetricDimensionEnabled")]
public bool? IsNotificationsPerMetricDimensionEnabled { get; set; }

Property Value

Type	Description
bool?	When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Alarm.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
Alarm.LifecycleStateEnum?	The current lifecycle state of the alarm. Example: DELETED

Remarks

Required

MessageFormat

Declaration

[JsonProperty(PropertyName = "messageFormat")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Alarm.MessageFormatEnum? MessageFormat { get; set; }

Property Value

Type Description

Type	Description
Alarm.MessageFormatEnum?	The format to use for alarm notifications. The formats are: `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only.

Alarm.MessageFormatEnum?

The format to use for alarm notifications. The formats are:

RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format.
PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only.
ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only.

MetricCompartmentId

Declaration

[Required(ErrorMessage = "MetricCompartmentId is required.")]
[JsonProperty(PropertyName = "metricCompartmentId")]
public string MetricCompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment containing the metric being evaluated by the alarm.

Remarks

Required

MetricCompartmentIdInSubtree

Declaration

[JsonProperty(PropertyName = "metricCompartmentIdInSubtree")]
public bool? MetricCompartmentIdInSubtree { get; set; }

Property Value

Type	Description
bool?	When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true

Type

Description

bool?

When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.
Example: true

Namespace

Declaration

[Required(ErrorMessage = "Namespace is required.")]
[JsonProperty(PropertyName = "namespace")]
public string Namespace { get; set; }

Property Value

Type	Description
string	The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent

Remarks

Required

NotificationTitle

Declaration

[JsonProperty(PropertyName = "notificationTitle")]
public string NotificationTitle { get; set; }

Property Value

Type	Description
string	Customizable notification title (`title` alarm message parameter). Optionally include dynamic variables. The notification title appears as the subject line in a formatted email message and as the title in a Slack message.

NotificationVersion

Declaration

[JsonProperty(PropertyName = "notificationVersion")]
public string NotificationVersion { get; set; }

Property Value

Type	Description
string	The version of the alarm notification to be delivered. Allowed value: `1.X` The value must start with a number (up to four digits), followed by a period and an uppercase X.

Overrides

Declaration

[JsonProperty(PropertyName = "overrides")]
public List<AlarmOverride> Overrides { get; set; }

Property Value

Type	Description
List<AlarmOverride>	A set of overrides that control evaluations of the alarm. Each override 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`).

PendingDuration

Declaration

[JsonProperty(PropertyName = "pendingDuration")]
public string PendingDuration { get; set; }

Property Value

Type Description

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". 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

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".
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

Query

Declaration

[Required(ErrorMessage = "Query is required.")]
[JsonProperty(PropertyName = "query")]
public string Query { get; set; }

Property Value

Type Description

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: `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)`

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: `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)

Remarks

Required

RepeatNotificationDuration

Declaration

[JsonProperty(PropertyName = "repeatNotificationDuration")]
public string RepeatNotificationDuration { get; set; }

Property Value

Type	Description
string	The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D. Default value: null (notifications are not re-submitted). Example: PT2H

Resolution

Declaration

[JsonProperty(PropertyName = "resolution")]
public string Resolution { get; set; }

Property Value

Type	Description
string	The time between calculated aggregation windows for the alarm. Supported value: `1m`

ResourceGroup

Declaration

[JsonProperty(PropertyName = "resourceGroup")]
public string ResourceGroup { get; set; }

Property Value

Type	Description
string	Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet

RuleName

Declaration

[JsonProperty(PropertyName = "ruleName")]
public string RuleName { get; set; }

Property Value

Type	Description
string	Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see {@link #alarmOverride(AlarmOverrideRequest) alarmOverride}.

Severity

Declaration

[Required(ErrorMessage = "Severity is required.")]
[JsonProperty(PropertyName = "severity")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Alarm.SeverityEnum? Severity { get; set; }

Property Value

Type	Description
Alarm.SeverityEnum?	The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL

Remarks

Required

Suppression

Declaration

[JsonProperty(PropertyName = "suppression")]
public Suppression Suppression { get; set; }

Property Value

Type	Description
Suppression	The configuration details for suppressing an alarm.

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z

Remarks

Required

TimeUpdated

Declaration

[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z

Remarks

Required