Alarm Message Format
Look up parameters that appear in alarm messages sent by Monitoring. Review parameter descriptions and example values, dynamic variables, and default appearance in formatted messages.
Parameters are listed in the order they appear in pretty JSON and raw formats of email messages.
Parameters in Alarm Messages
The following tables describe parameters in alarm messages and provide example values.
Alarm
Alarm parameter | Description and example value |
---|---|
dedupekey |
string Unique identifier of the alarm (grouped message), or of the metric stream in the alarm (split message). Example value: Comments on usage: For grouped messages ( For split messages ( To deduplicate multiple occurrences of the same message, use |
title |
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: Example value (alarm's display name): |
body |
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: Example value (text): |
type |
string The reason for sending the notification message. Valid values: See Message Types. Example value: |
severity |
string The highest severity level of the listed alarms. Valid values: |
timestampEpochMillis |
long The evaluation timestamp, in milliseconds since epoch time. Example value: |
timestamp |
string The evaluation timestamp, in ISO-8601 format. Example value: |
alarmMetaData |
array of objects List of alarms related to this notification message. For example values, see child parameters in the following table, Alarm Metadata. |
version |
int The version of the alarm message format. Example value: |
Alarm Metadata
Alarm parameter | Description and example value |
---|---|
id |
string The alarm OCID . Example value: |
status |
string The alarm state. Valid values: |
severity |
string The alarm severity level. Valid values: |
namespace |
string The metric namespace. Example value: |
query |
string The alarm's configured query, or MQL expression. Example value: |
totalMetricsFiring |
int The number of metric streams represented in this notification message. Example value: |
dimensions |
array of objects List of dimension key-value pairs that identify each metric stream. The list is limited to a hundred entries. Example value: { "instancePoolId": "Default", "resourceDisplayname": "oke-0", "faultDomain": "FAULT-DOMAIN-1", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-2", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-2", "faultDomain": "FAULT-DOMAIN-3", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-1", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" }, { "instancePoolId": "Default", "resourceDisplayname": "oke-1", "faultDomain": "FAULT-DOMAIN-2", "resourceId": "ocid1.instance.oc1.iad.exampleid", "availabilityDomain": "sOZD:US-ASHBURN-AD-3", "imageId": "ocid1.image.oc1.iad.exampleid", "region": "us-ashburn-1", "shape": "VM.Standard.E3.Flex" } |
metricValues |
array of objects List of metric values for dimension key-value pairs (metric streams). The list is limited to a hundred entries. Example value: [{"CpuUtilization[1m].mean()":"92"},{"CpuUtilization[1m].mean()":"95"},{"CpuUtilization[1m].mean()":"93"}]
|
alarmUrl |
string Link to the alarm details page in the Console. Example value: |
alarmSummary |
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: The content of the system-generated message (used when alarm summary isn't configured) depends on
|
notificationType |
string Type of notification (grouped or split). Valid values: |
Dynamic Variables
The following tables list dynamic variables available for each parameter.
Use the indicated dynamic variable to render the value of a parameter in alarm messages.
HTML escaping occurs for the primary (shorter) dynamic variable. For example, when you use the primary dynamic variable {{title}}
for the title
parameter value alarm for successRate < 0.99
, the <
character is rendered as <
.
To disable HTML escaping, use the secondary (longer) dynamic variable. For example, when you use the secondary dynamic variable {{{title}}}
for the title
parameter value alarm for successRate < 0.99
, the <
character is preserved.
Alarm
Alarm parameter | Dynamic variables* |
---|---|
dedupekey |
|
title |
|
body |
(none) |
type |
|
severity |
See the child parameter |
timestampEpochMillis |
|
timestamp |
|
alarmMetaData |
See the child parameters in the following table, Alarm Metadata. |
version |
|
*The primary (shorter) dynamic variable performs HTML escaping. The secondary (longer) dynamic variable preserves input characters.
Alarm Metadata
Alarm parameter | Dynamic variables* |
---|---|
id |
|
status |
|
severity |
|
namespace |
|
query |
|
totalMetricsFiring |
|
dimensions |
<dimension-name> is the name of the dimension. For example, to reference the
Example value: FAULT-DOMAIN-3 Associated raw message content: "faultdomain":"FAULT-DOMAIN-3" The dimension name must be valid for the dynamic variable to be rendered in the alarm message. |
metricValues |
Example value: [{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}]
Associated raw message content: metricValues:[{CpuUtilization[1m].mean():92,disUtil[1m].mean():95}] |
alarmUrl |
|
alarmSummary |
|
notificationType |
|
*The primary (shorter) dynamic variable performs HTML escaping. The secondary (longer) dynamic variable preserves input characters.
Default Formatted Message Appearance
The following tables list default appearance of each alarm message parameter in formatted alarm messages.
Alarm
Alarm parameter | Default formatted message appearance |
---|---|
dedupekey |
|
title |
|
body |
|
type |
|
severity |
Omitted by default |
timestampEpochMillis |
Omitted by default |
timestamp |
|
alarmMetaData |
See the child parameters in the following table, Alarm Metadata. |
version |
Omitted by default |
Alarm Metadata
Alarm parameter | Default formatted message appearance |
---|---|
id |
|
status |
|
severity |
|
namespace |
Omitted by default |
query |
|
totalMetricsFiring |
|
dimensions |
|
metricValues |
|
alarmUrl |
|
alarmSummary |
|
notificationType |
Omitted by default |