Alarm Message Format

string

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

Example value: exampleuniqueid

Comments on usage:

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.

string

The alarm's notification title (Notification subject in the Console form for creating and updating alarms). If not specified, then the alarm's display name is used.

Example value using dynamic variables: {{severity}} alarm triggered at {{timestamp}}

Example value (alarm's display name): High CPU Utilization

string

The alarm's configured message body (Alarm body in the Console form for creating and updating alarms). Null if not specified.

Example value using dynamic variables: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

Example value (text): Follow runbook at http://example.com/runbooks

string

The reason for sending the notification message.

Valid values: See Message Types.

Example value: OK_TO_FIRING

string

The highest severity level of the listed alarms.

Valid values: CRITICAL, ERROR, WARNING, and INFO

long

The evaluation timestamp, in milliseconds since epoch time.

Example value: 1684337663852

string

The evaluation timestamp, in ISO-8601 format.

Example value: 2023-05-17T15:34:23.852Z

array of objects

List of alarms related to this notification message.

For example values, see child parameters in the following table, Alarm Metadata.

int

The version of the alarm message format.

Example value: 1.5

string

The alarm OCID .

Example value: ocid1.alarm.oc1..exampleuniqueID

string

The alarm state.

Valid values: OK, FIRING

string

The alarm severity level.

Valid values: CRITICAL, ERROR, WARNING, INFO

string

The metric namespace.

Example value: oci_computeagent

string

The alarm's configured query, or MQL expression.

Example value: CpuUtilization[1m].mean() > 90

int

The number of metric streams represented in this notification message.

Example value: 3

array of objects

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

Example value:

array of objects

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

Example value:

string

Link to the alarm details page in the Console.

Example value: https://cloud.oracle.com/monitoring/alarms/ocid1.alarm.oc1.iad.exampleuniqueid?region=us-ashburn-1

string

The alarm's configured alarm summary (Alarm summary in the Console form for creating and updating alarms). If not configured, a system-generated message that summarizes the state is used.

Example value using dynamic variables: {{severity}} alarm triggered because threshold got breached due to {{metricValues}} at {{timestamp}}

The content of the system-generated message (used when alarm summary isn't configured) 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>

  Example:

  Alarm High CPU Utilization is in a FIRING state; because 4 metrics meet the trigger rule: CpuUtilization[1m].mean() >90, with a trigger delay of 1 minute

• 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>

string

Type of notification (grouped or split).

Valid values: Grouped messages across metric streams or Split messages per metric stream

• {{dedupekey}}
• {{{dedupekey}}}

• {{title}}
• {{{title}}}

• {{type}}
• {{{type}}}

See the child parameter severity in the following table, Alarm Metadata.

• {{timestampEpochMillis}}
• {{{timestampEpochMillis}}}

• {{timestamp}}
• {{{timestamp}}}

See the child parameters in the following table, Alarm Metadata.

• {{version}}
• {{{version}}}

• {{id}}
• {{{id}}}

• {{status}}
• {{{status}}}

• {{severity}}
• {{{severity}}}

• {{namespace}}
• {{{namespace}}}

• {{query}}
• {{{query}}}

• {{totalMetricsFiring}}
• {{{totalMetricsFiring}}}

• {{dimensions.<dimension-name>}}
• {{{dimensions.<dimension-name>}}}

<dimension-name> is the name of the dimension. For example, to reference the faultdomain dimension:

• {{dimensions.faultdomain}}
• {{{dimensions.faultdomain}}}

Example value:

Associated raw message content:

The dimension name must be valid for the dynamic variable to be rendered in the alarm message.

• {{metricValues}}
• {{{metricValues}}}

Example value:

Associated raw message content:

• {{alarmUrl}}
• {{{alarmUrl}}}

• {{alarmSummary}}
• {{{alarmSummary}}}

• {{notificationType}}
• {{{notificationType}}}

• Email (formatted): Dedupe key
• Slack: Dedupe key
• SMS: Omitted by default

• Email (formatted): Name
• Slack: Unlabeled, part of title
• SMS: Unlabeled, part of message

• Email (formatted): Body
• Slack: Unlabeled, part of title
• SMS: Omitted by default

• Email (formatted): Type
• Slack: Type
• SMS: Unlabeled, part of message

• Email (formatted): Time
• Slack: Time
• SMS: Unlabeled, part of message

See the child parameters in the following table, Alarm Metadata.

• Email (formatted): Alarm OCID
• Slack: Alarm OCID
• SMS: Omitted by default

• Email (formatted): State
• Slack: Status
• SMS: Omitted by default

• Email (formatted): Severity
• Slack: Severity
• SMS: Unlabeled, part of message

• Email (formatted): Query
• Slack: Query
• SMS: Omitted by default

• Email (formatted): Number of metrics breaching threshold
• Slack: Number of metric streams breaching threshold
• SMS: Omitted by default

• Email (formatted): Dimensions
• Slack: Dimensions
• SMS: Omitted by default

• Email (formatted): Metric values, ordered by dimension
• Slack: Metric values, ordered by dimension
• SMS: Omitted by default

• Email (formatted): View Alarm in Console
• Slack: Unlabeled, part of title
• SMS: Omitted by default

• Email (formatted): Alarm Summary (button at bottom of message)
• Slack: Omitted by default
• SMS: Omitted by default