Both email and web hooks allow you to use a any of the variables below in your templates by surrounding them with ‘$’ (i.e. $alarm.name$). When more than one value is present like for aggregate alarms, the result will be a newline (“\n”) separated string of values. See the bottom of this page for some example templates using variables.
Alarm Properties
| alarm.aggregate | true if alarm is an aggregate sensor alarm |
| alarm.condition | a string representation of the condition which will ring the alarm |
| alarm.consecutive_periods | the number of consecutive periods required to ring an alarm |
| alarm.date_fired | the date time the alarm rang |
| alarm.date_resolved | the date time the alarm resolved |
| alarm.disabled | true if the alarm is disabled |
| alarm.disabled_until | date time when the alarm will be re-enabled |
| alarm.edit_url | the url to the alarm’s edit page |
| alarm.element | the element (login time, latency, error, etc) that the alarm is set to watch |
| alarm.email_recipients | email recipients for the alarm |
| alarm.enabled | true if the alarm is enabled |
| alarm.name | name of the alarm |
| alarm.notes | user notes saved for the alarm |
| alarm.period | alarm period |
| alarm.state | the state of the alarm (either ‘ALARM’ or ‘OK’) |
| alarm.threshold_operator | the operator used to compare the current data packet to the alarm threshold (ie <, >, ==, etc) |
| alarm.threshold_value | the alarm’s threshold, the value at which the alarm will ring |
| alarm.url | the URL for the alarm’s details page |
| alarm.alert_id | unique id for the ring, can be used to link resolves to rings |
Alert Group Properties
| alarm.alert_group.name | the name of the alarm’s alert group |
Organizations Properties
| alarm.organization.name | the name of the organization that owns the alarm |
Sensors Properties
| alarm.sensors.count | the count of the total number of sensors that the alarm is applied to |
| alarm.sensors.enabled_count | the count of sensors that are enabled for this alarm |
| alarm.sensors.percent_affected | the percent of sensors that are in alert state for this alarm |
| alarm.sensors.affected_count | the count of sensors that are in alert state for this alarm |
| alarm.sensors.affected_ids | the id of each sensor in alert state that the alarm is applied to |
| alarm.sensors.affected_titles | the title of each sensor in alert state that the alarm is applied to |
| alarm.sensors.affected_types | the type of each sensor in alert state that the alarm is applied to |
| alarm.sensors.affected_id | the id of the sensor that caused the alarm to either fire or resolve |
| alarm.sensors.affected_title | the title of the sensor that caused the alarm to either fire or resolve |
| alarm.sensors.affected_type | the type of the sensor that caused the alarm to either fire or resolve |
| alarm.sensors.threshold_percent | the percent of sensors in alert state required to fire an aggregate alarm |
| alarm.sensors.titles | the title of each sensor that this alarm is applied to |
| alarm.sensors.types | the type of each sensor that the alarm is applied to |
| alarm.sensors.last_uploads | the percent of sensors in alert state required to fire an aggregate alarm |
User Properties
| alarm.user.email_address | the email address of the user that created this alarm |
Site Properties
| alarm.site.display_name | the display name of the site where the most recent alert has fired from |
| alarm.site.machine_name | the machine name of the site where the most recent alert has fired from |
Example Syntax
For an aggregate alarm:
Affected sensors: $alarm.sensors.percent_affected$ Affected sensor % threshold: $alarm.sensors.threshold_percent$% Enabled sensors: $alarm.sensors.enabled_count$ of $alarm.sensors.count$ Condition: $alarm.condition$ Timestamp: $alarm.date_fired$ State: $alarm.state$ URL: $alarm.url$ Edit URL: $alarm.edit_url$ Analysis: Resolving alarm: $alarm.sensors.percent_affected$ ($alarm.sensors.affected_count$ of $alarm.sensors.count$) sensors are in the alarm state, which is below the configured threshold of $alarm.sensors.threshold_percent$%. Sensors Still In Alarm State: $alarm.sensors.affected_titles$
For a per-sensor alarm:
Sensor: $alarm.sensors.affected_titles$ Condition: $alarm.condition$ Timestamp: $alarm.date_fired$ State: $alarm.state$ URL: $alarm.url$ Edit URL: $alarm.edit_url$ Analysis: CloudReady Monitor Alarm "$alarm.name$" for sensor "$alarm.sensors.affected_titles$" has entered the $alarm.state$ state for the element $alarm.element$. The sensor uploaded data at: "$alarm.sensor.last_uploads". Alarm Details: Name: $alarm.name$ Element: $alarm.element$ Condition: $alarm.condition$ Timestamp: $alarm.date_fired$ Sensor Details: Title: $alarm.sensors.titles$ Type: $alarm.sensors.types$