Notification E-mail Placeholders

This part of the guide describes the placeholders that can be used in the templates for the notification messages sent by e-mail in case of certain events. There are state and quality notification messages, summary report messages and detailed report messages. Each of them is described below. Along with the described placeholders, you can use the custom fields, if defined.

Host State Notifications

Host state notification placeholders can be used for notification messages that are sent when the host state changes. The following placeholders can be used:

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_IP%

the resolved IP address of the remote host;

%REMOTE_HOST_GROUP%

the group the remote host belongs to;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%STATE%

the current host state, either Up or Down;

%CONNECTION_STATUS%

the current connection status. It can be either 'lost', or 'restored'. For the 'lost' status, the reason for ping failure is added. If you do not want to see the reason, use the '%SHORT_CONNECTION_STATUS%' placeholder;

%SHORT_CONNECTION_STATUS%

the current connection status. It can be either 'lost', or 'restored'. The reason for ping failure is never added;

%CHANGE_TIME%

the date and time the connection status was changed at;

%OCCURRENCE%

the number of notification sent for this event (useful for recurring notifications);

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current time;

%DATE%

the current date;

%DATETIME%

the current date and time;

%UTC_OFFSET%

the current UTC offset;

%YEAR%

the current year.

In case of the On Connection Restore notification, you can use the following additional placeholders:

%OUTAGE_DURATION%

the duration of the outage that has ended;

%OUTAGE_START_TIME%

the start time of the outage that has ended;

%OUTAGE_END_TIME%

the end time of the outage that has ended.

Connection Quality Notifications

Connection quality notification placeholders can be used for notification messages that are sent when the connection quality changes. The following placeholders can be used:

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_IP%

the resolved IP address of the remote host;

%REMOTE_HOST_GROUP%

the resolved IP address of the remote host;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%QUALITY%

the current connection quality, one of the following: Good, Warning, Bad or Critical;

%CHANGE_TIME%

the date and time the connection status was changed at.

%OCCURRENCE%

the number of notification sent for this event (useful for recurring notifications);

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current time;

%DATE%

the current date;

%DATETIME%

the current date and time;

%UTC_OFFSET%

the current UTC offset;

%YEAR%

the current year.

Summary Report

For the e-mail messages, sent as summary reports you can use the following placeholders:

%REPORT_NAME%

the name of the generated report;

%REPORT_DESCRIPTION%

the description of the generated report;

%REPORT_TYPE%

the type of the generated report;

%REPORT_PERIOD%

the period the report is generated for;

%SUMMARY_TABLE%

the table with the summary information on hosts availability and ping performance;

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current time;

%DATE%

the current date;

%DATETIME%

the current date and time;

%UTC_OFFSET%

the current UTC offset;

%YEAR%

the current year.

Detailed Report

For the detailed report, the message body is generated for each host separately, and the header and footer are generated only once. So, the placeholders standing for any information on a single host can be used only wihin the message body. The following placeholders are available:

%REPORT_NAME%

the name of the generated report;

%REPORT_DESCRIPTION%

the description of the generated report;

%REPORT_TYPE%

the type of the generated report;

%REPORT_PERIOD%

the period the report is generated for;

%REMOTE_HOST_EXT%

the remote host being monitored, including the host label, if defined, and footnote sign, if required;

%REMOTE_HOST%

the remote host being monitored, including the host label, if defined;

%REMOTE_HOST_ADDRESS%

the address of the remote host being monitored;

%REMOTE_HOST_LABEL%

the label of the remote host being monitored;

%REMOTE_HOST_GROUP%

the group the remote host belongs to;

%REMOTE_HOST_DESCRIPTION%

the description of the remote host being monitored;

%ACTIVITY_TIME%

the time span the host was monitored for during the report period;

%PAUSE_TIME%

the time span the host monitoring was paused for during the report period;

%MIN_LATENCY%

the smallest value from all round-trip times of packets successfully delivered during the report period in milliseconds;

%MAX_LATENCY%

the largest value from all round-trip times of packets successfully delivered during the report period in milliseconds;

%AVG_LATENCY%

the arithmetic mean of all round-trip times of packets successfully delivered during the report period in milliseconds;

%LATENCY_DEVIATION%

the standard deviation from the average latency value for all round-trip times of packets successfully delivered during the report period in milliseconds;

%LATENCY_CV%

the percentage ratio of the latency deviation to the average latency calculated for all round-trip times of packets successfully delivered during the specified time period;

%UPTIME%

the percentage ratio of the host uptime to the whole non-pending time during the report period;

%OUTAGES_COUNT%

the number of outages that took place during the report period;

%UPTIME_INTERVAL%

a time span the connection to the host was up during the report period;

%DOWNTIME_INTERVAL%

a time span the connection to the host was down during the report period;

%SHORTEST_OUTAGE%

the shortest outage that took place during the report period;

%LONGEST_OUTAGE%

the longest outage that took place during the report period;

%PACKET_LOSS%

the percentage ratio of the number of lost packets to the number of packets being sent during the report period;

%LOST_PACKETS_COUNT%

the number of lost packets during the report period;

%DELIVERED_PACKETS_COUNT%

the number of delivered packets during the report period;

%MOS%

the mean opinion score, a well-established metric for obtaining the quality of VoIP based on the latency characteristics and packet loss percentage for all packets sent during the report period;

%GOOD_QUALITY_PERCENTAGE%

the percentage ratio of the time with good connection quality to the whole non-pending time during the report period;

%WARNING_QUALITY_PERCENTAGE%

the percentage ratio of the time with warning connection quality to the whole non-pending time during the report period;

%BAD_QUALITY_PERCENTAGE%

the percentage ratio of the time with bad connection quality to the whole non-pending time during the report period;

%CRITICAL_QUALITY_PERCENTAGE%

the percentage ratio of the time with critical connection quality to the whole non-pending time during the report period;

%GOOD_QUALITY_INTERVAL%

a time span the connection quality to the host was good during the report period;

%WARNING_QUALITY_INTERVAL%

a time span the connection quality to the host was warning during the report period;

%BAD_QUALITY_INTERVAL%

a time span the connection quality to the host was bad during the report period;

%CRITICAL_QUALITY_INTERVAL%

a time span the connection quality to the host was critical during the report period;

%UPTIME_COLOR%

the color used to draw the uptime box;

%PACKET_LOSS_COLOR%

the color used to draw the packet loss box;

%OUTAGES_COLOR%

the color used to draw the outages box;

%DEVIATION_COLOR%

the color used to draw the deviation box;

%CV_COLOR%

the color used to draw the CV box;

%AVERAGE_COLOR%

the color used to draw the average latency box;

%GOOD_QUALITY_COLOR%

the color used to draw the good quality box;

%WARNING_QUALITY_COLOR%

the color used to draw the warning quality box;

%BAD_QUALITY_COLOR%

the color used to draw the bad quality box;

%CRITICAL_QUALITY_COLOR%

the color used to draw the critical quality box;

%PERFORMANCE_INFO%

the information on performance calculated for the report period;

%STATE_INTERVALS_TABLE%

detailed information on host state intervals for the report period in a form of a table, where each row stands for the interval of the specific type;

%QUALITY_INTERVALS_TABLE%

detailed information on connection quality intervals for the report period in a form of a table, where each row stands for the interval of the specific type;

%EVENTS_TABLE%

detailed information on monitoring events taken place during the report period in a form of a table;

%MOS_RATING_IMAGE%

the content ID of the image for the 5-star rating representation of MOS (HTML message format only);

%STATISTICS_ANALYSIS_CHART%

the content ID of the image with latency and uptime chart (HTML message format only);

%INTERVALS_ANALYSIS_CHART%

the content ID of the image with state and quality chart (HTML message format only);

%LOCAL_HOST%

the machine name;

%RUNNING_PRODUCT%

the running program name;

%PRODUCT_VERSION%

the current version of the running program;

%TIME%

the current version of the running program;

%DATE%

the current date;

%DATETIME%

the current date and time;

%UTC_OFFSET%

the current UTC offset;

%YEAR%

the current year.