AlarmSummary¶

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

Bases: object

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.

Attributes

`SEVERITY_CRITICAL`	A constant which can be used with the severity property of a AlarmSummary.
`SEVERITY_ERROR`	A constant which can be used with the severity property of a AlarmSummary.
`SEVERITY_INFO`	A constant which can be used with the severity property of a AlarmSummary.
`SEVERITY_WARNING`	A constant which can be used with the severity property of a AlarmSummary.
`alarm_summary`	Gets the alarm_summary of this AlarmSummary.
`compartment_id`	[Required] Gets the compartment_id of this AlarmSummary.
`defined_tags`	Gets the defined_tags of this AlarmSummary.
`destinations`	[Required] Gets the destinations of this AlarmSummary.
`display_name`	[Required] Gets the display_name of this AlarmSummary.
`evaluation_slack_duration`	Gets the evaluation_slack_duration of this AlarmSummary.
`freeform_tags`	Gets the freeform_tags of this AlarmSummary.
`id`	[Required] Gets the id of this AlarmSummary.
`is_enabled`	[Required] Gets the is_enabled of this AlarmSummary.
`is_notifications_per_metric_dimension_enabled`	Gets the is_notifications_per_metric_dimension_enabled of this AlarmSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this AlarmSummary.
`metric_compartment_id`	[Required] Gets the metric_compartment_id of this AlarmSummary.
`namespace`	[Required] Gets the namespace of this AlarmSummary.
`notification_title`	Gets the notification_title of this AlarmSummary.
`notification_version`	Gets the notification_version of this AlarmSummary.
`overrides`	Gets the overrides of this AlarmSummary.
`query`	[Required] Gets the query of this AlarmSummary.
`resource_group`	Gets the resource_group of this AlarmSummary.
`rule_name`	Gets the rule_name of this AlarmSummary.
`severity`	[Required] Gets the severity of this AlarmSummary.
`suppression`	Gets the suppression of this AlarmSummary.

Methods

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

SEVERITY_CRITICAL = 'CRITICAL'¶: A constant which can be used with the severity property of a AlarmSummary. This constant has a value of “CRITICAL”

SEVERITY_ERROR = 'ERROR'¶: A constant which can be used with the severity property of a AlarmSummary. This constant has a value of “ERROR”

SEVERITY_INFO = 'INFO'¶: A constant which can be used with the severity property of a AlarmSummary. This constant has a value of “INFO”

SEVERITY_WARNING = 'WARNING'¶: A constant which can be used with the severity property of a AlarmSummary. This constant has a value of “WARNING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this AlarmSummary.
display_name (str) – The value to assign to the display_name property of this AlarmSummary.
compartment_id (str) – The value to assign to the compartment_id property of this AlarmSummary.
metric_compartment_id (str) – The value to assign to the metric_compartment_id property of this AlarmSummary.
namespace (str) – The value to assign to the namespace property of this AlarmSummary.
query (str) – The value to assign to the query property of this AlarmSummary.
severity (str) – The value to assign to the severity property of this AlarmSummary. Allowed values for this property are: “CRITICAL”, “ERROR”, “WARNING”, “INFO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
destinations (list[str]) – The value to assign to the destinations property of this AlarmSummary.
suppression (oci.monitoring.models.Suppression) – The value to assign to the suppression property of this AlarmSummary.
is_enabled (bool) – The value to assign to the is_enabled property of this AlarmSummary.
is_notifications_per_metric_dimension_enabled (bool) – The value to assign to the is_notifications_per_metric_dimension_enabled property of this AlarmSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this AlarmSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this AlarmSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AlarmSummary.
overrides (list[oci.monitoring.models.AlarmOverride]) – The value to assign to the overrides property of this AlarmSummary.
rule_name (str) – The value to assign to the rule_name property of this AlarmSummary.
notification_version (str) – The value to assign to the notification_version property of this AlarmSummary.
notification_title (str) – The value to assign to the notification_title property of this AlarmSummary.
evaluation_slack_duration (str) – The value to assign to the evaluation_slack_duration property of this AlarmSummary.
alarm_summary (str) – The value to assign to the alarm_summary property of this AlarmSummary.
resource_group (str) – The value to assign to the resource_group property of this AlarmSummary.

alarm_summary¶

Gets the alarm_summary of this AlarmSummary. 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 list_alarms_status() get_alarm_history() and retrieve_dimension_states().

Returns:	The alarm_summary of this AlarmSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this AlarmSummary. The OCID of the compartment containing the alarm.

Returns:	The compartment_id of this AlarmSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this AlarmSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this AlarmSummary.
Return type:	dict(str, dict(str, object))

destinations¶

[Required] Gets the destinations of this AlarmSummary. A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a NotificationTopic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.

Returns:	The destinations of this AlarmSummary.
Return type:	list[str]

display_name¶

[Required] Gets the display_name of this AlarmSummary. 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

Returns:	The display_name of this AlarmSummary.
Return type:	str

evaluation_slack_duration¶

Gets the evaluation_slack_duration of this AlarmSummary. 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.

Returns:	The evaluation_slack_duration of this AlarmSummary.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this AlarmSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this AlarmSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this AlarmSummary. The OCID of the alarm.

Returns:	The id of this AlarmSummary.
Return type:	str

is_enabled¶

[Required] Gets the is_enabled of this AlarmSummary. Whether the alarm is enabled.

Example: true

Returns:	The is_enabled of this AlarmSummary.
Return type:	bool

is_notifications_per_metric_dimension_enabled¶

Gets the is_notifications_per_metric_dimension_enabled of this AlarmSummary. Whether the alarm sends a separate message for each metric stream. See Creating an Alarm That Splits Messages by Metric Stream. Example: true

Returns:	The is_notifications_per_metric_dimension_enabled of this AlarmSummary.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this AlarmSummary. The current lifecycle state of the alarm.

Example: DELETED

Returns:	The lifecycle_state of this AlarmSummary.
Return type:	str

metric_compartment_id¶

[Required] Gets the metric_compartment_id of this AlarmSummary. The OCID of the compartment containing the metric being evaluated by the alarm.

Returns:	The metric_compartment_id of this AlarmSummary.
Return type:	str

namespace¶

[Required] Gets the namespace of this AlarmSummary. The source service or application emitting the metric that is evaluated by the alarm.

Example: oci_computeagent

Returns:	The namespace of this AlarmSummary.
Return type:	str

notification_title¶

Gets the notification_title of this AlarmSummary. 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.

Returns:	The notification_title of this AlarmSummary.
Return type:	str

notification_version¶

Gets the notification_version of this AlarmSummary. 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.

Returns:	The notification_version of this AlarmSummary.
Return type:	str

overrides¶

Gets the overrides of this AlarmSummary. 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).

Returns:	The overrides of this AlarmSummary.
Return type:	list[oci.monitoring.models.AlarmOverride]

query¶

[Required] Gets the query of this AlarmSummary. 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()

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

resource_group¶

Gets the resource_group of this AlarmSummary. 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

Returns:	The resource_group of this AlarmSummary.
Return type:	str

rule_name¶

Gets the rule_name of this AlarmSummary. 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 alarm_override().

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

severity¶

[Required] Gets the severity of this AlarmSummary. The perceived type of response required when the alarm is in the “FIRING” state.

Example: CRITICAL

Allowed values for this property are: “CRITICAL”, “ERROR”, “WARNING”, “INFO”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

suppression¶

Gets the suppression of this AlarmSummary. The configuration details for suppressing an alarm.

Returns:	The suppression of this AlarmSummary.
Return type:	oci.monitoring.models.Suppression