Oracle Cloud Infrastructure Documentation

Alarm Message Format

Monitoring includes parameters in alarm messages.

Parameters are listed in the order they appear in pretty JSON and raw formats of email messages. Associated labels for parameters in formatted email messages are indicated in parameter descriptions.

Alarm

Parameter Description Comments
dedupekey

string

Unique identifier of the alarm (grouped message), or of the metric stream in the alarm (split message).

For grouped messages (notificationType: Group notifications across metric streams), use dedupekey to group messages belonging to the same alarm.

For split messages (notificationType: Split messages per metric stream), use dedupekey to group messages belonging to the same alarm and same metric stream.

To deduplicate multiple occurrences of the same message, use dedupekey and timestamp together.

This parameter is labeled Dedupe key in formatted email messages and Slack messages.
title

string

The alarm's configured display name.

 This parameter is labeled Name in formatted email messages. This parameter is included in the title of Slack messages.
body

string

The alarm's configured message body. Null if not specified.

 This parameter is labeled Body in formatted email messages. This parameter appears without a label under the title in Slack messages.
type

string

The reason for sending the notification message. Valid values: See Message Types.

 This parameter is labeled Type in formatted email messages and Slack messages.
severity

string

The highest severity level of the listed alarms. Valid values: CRITICAL, ERROR, WARNING, and INFO
timestampEpochMillis

long

The evaluation timestamp, in milliseconds since epoch time.

timestamp

string

The evaluation timestamp, in ISO-8601 format.

This parameter is labeled Time in formatted email messages and Slack messages.
alarmMetaData

array of objects

List of alarms related to this notification message. See the following table, Alarm Metadata.
version

int

The version of the alarm message format.

Alarm Metadata

alarmMetaData Parameter Description Comments
id

string

The alarm OCID .

This parameter is labeled Alarm OCID in formatted email messages and Slack messages.
status

string

The alarm state. Valid values: OK, FIRING

 This parameter is labeled State in formatted email messages. Status in Slack messages.
severity

string

The alarm severity level. Valid values: CRITICAL, ERROR, WARNING, INFO

 This parameter is labeled Severity in formatted email messages and Slack messages.
namespace

string

The metric namespace.
query

string

The alarm's configured query, or MQL expression.

Example:

CpuUtilization[1m].mean() > 90

This parameter is labeled Query in formatted email messages and Slack messages.
totalMetricsFiring

int

The number of metric streams represented in this notification message.

 This parameter is labeled Number of metrics breaching threshold in formatted email messages, and Number of metric streams breaching threshold in Slack messages.
dimensions

array of objects

List of dimension key-value pairs that identify each metric stream. The list is limited to a hundred entries.

This parameter is labeled Dimensions in formatted email messages and Slack messages.
metricValues

array of objects

List of metric values for dimension key-value pairs (metric streams). The list is limited to a hundred entries.

This parameter is labeled Metric values, ordered by dimension in formatted email messages and Slack messages.
alarmUrl

string

Link to the alarm details page in the Console.

 This parameter is labeled View Alarm in Console (button at bottom of message) in formatted email messages, and is the linked title in Slack messages.
alarmSummary

string

System-generated message summarizing the alarm state.

The content of the message depends on notificationType:

  • For Grouped messages across metric streams:

    Alarm <alarm-name> is in a <alarm-state> state; because <number-of-metric-streams> metrics meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>

  • For Split messages per metric stream:

    Alarm <alarm-name> is in a <alarm-state> state; because the resources with dimensions listed below meet the trigger rule: "mql-expression", with a trigger delay of <number-of-minutes>

This parameter is labeled Alarm Summary (button at bottom of message) in formatted email messages
notificationType

string

Type of notification. Valid values: Grouped messages across metric streams or Split messages per metric stream

This parameter is labeled Notification type (button at bottom of message) in formatted email messages