Class AlarmSummary

A summary of properties for the specified 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

AlarmSummary

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 AlarmSummary

Properties

AlarmSummaryProp

Declaration

[JsonProperty(PropertyName = "alarmSummary")]
public string AlarmSummaryProp { 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}.

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?	Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

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

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

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

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. 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() -----

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. 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()
-----

Remarks

Required

ResourceGroup

Declaration

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

Property Value

Type	Description
string	Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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

Type

Description

string

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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 AlarmSummary.SeverityEnum? Severity { get; set; }

Property Value

Type	Description
AlarmSummary.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.