Create a metric alert

  1. Click and drag the Alerts Grid onto the View area.
  2. Open the View in the Viewer application or in the Preview mode in Studio.

Alert properties tab

To configure the alert, launch the wizard screen by clicking the New metric alert.

  1. Specify the title of the alert. It appears in the Alerts Grid as the alert title and can be used as a subject line in the email of the alert.
  2. Specify the severity of the alert. Select Critical to display this alert in a pop-up window. Select Important or Informational according to your needs.
  3. Enter the description for your alert.
  4. Frequency and Time Intervals:

    • Use Check for alerts every to specify the frequency to check alerts.

    • Use the Starting from field to specify the start date/time of the time interval.

      For example, if the "Starting from" date is set to 4/1/2016 12:00AM, the time interval for checking an alert is from 4/1/2016 to the current date. The time interval keeps growing.

    • To restrict the time to a specific length in time, select the Check backward check box and specify the length (in days, weeks, months, years, and so on).

      For example, if "Check backward" is selected and set to one week and "Check for alerts every" is set to one day, then the check is performed daily for an alert with the time interval from the current time to the past week. If the check backward period is older than the start from date/time, then the "start from date/time" is used as the "from date/time."

    • Select the Escalate unresolved message in to send the message to the recipients defined on Email options tab.

Condition tab

To set conditions for generating alerts based on metric values, you need to define what to compare (Operand) with what (Comparison). For the Operand, define the following information.

  1. Select the existing metric in the current project.
  2. Set the time interval to generate the alert. For example, if you set it to one hour, but Check for alerts every is set to one day, the messages are generated for every hour but only once a day. If the metric has a daily interval, then hourly values are not calculated. The interval should not be less than the metric interval.
  3. Select the Use only completed intervals check box to use only completed intervals. For example, the interval is set to "1 day" and "Starting from" is set to "2 PM" As the day is not yet finished and the data may change till midnight, you can select this check box to show only the data from previous completed days. If this check box is not selected, at 2 p.m. the data for the current day is shown for the period from 0.00 a.m. to 2 p.m.
  4. Select the dimension under Broken by to generate the alerts. If you do not select any dimension, the alerts are generated for the total data for each interval.
    You can compare the metric data to some fixed value, another metric, or the historic value for the same metric.
  5. Select the operator for the comparison.
  6. Select the basis for the comparison: Fixed value, Another metric, or Same metric, historic value.

    You do not have to set the margin for fixed value, because you can include the margin in the fixed value.

    The value for the comparison is calculated according to the following formula.

    Final value for comparison = CompareValue*(100 + Margin)/100

  7. Select the Automatically resolve the alert... check box to resolve the alert if a set of defined conditions is not satisfied. The messages are not returned for such alerts.

Do not send tab

Use this tab to set the conditions when the same messages should not be resent.

You can set the following conditions.

  • Time from the same alert less than: If this option is selected, the same alert is resent only after the defined term is over.

  • Until the same alert is resolved: The same message has not been yet resolved. If this option is selected, the next alert is generated only when the same alert is resolved.

  • Same alert was already issued: If this option is selected, regeneration of the alert happens only when the previous instance of this alert is removed under Admin Console > Alerts.

Visibility tab

Use this tab to set the recipients for the alerts. The alerts can either be sent to an email address or displayed within the Insight system. If the alerts are set to be shown to Insight users, you must define a role that allows alerts to be viewed. Users assigned with this role can see the alerts in the Alert Messages Grid (for all alerts) or in the pop-up window (for critical alerts).

  1. Select a role from the Roles for the new messages list to define who can view the new messages.
  2. Select a role from the Roles for escalated messages list to define who can view the escalated messages.

Email options tab

Use this tab to set up the email template in plain or rich text to receive the alerts by email. The following options are available.

Delivery option

  • Send each alert message in a separate email: Use this option to send each alert message in a separate email.

  • Add all recipients to "To" list: Select this check box to add all recipients to the "To" list.

Recipients

Use this group to define the following settings.

  • Recipients for new messages

  • Recipients for escalated messages

  • Recipients for resolved messages

You can send alert messages to several recipients using a comma or a semicolon to separate the email addresses. Also, you can send the alert messages to different recipients based on the required conditions. The procedure below covers the steps for resolved messages.

  1. In the Recipients group, click Advanced.

  2. On the Recipients for resolved messages screen, click Add new data.

  3. Select the required values from the list to set the condition and click OK on the list.

  4. Optional. You can select the Exclude check box instead of selecting multiple values.

  5. Add the Recipients respectively. Use semicolon to separate the email addresses.

  6. Click OK to save the changes.

Email subject and email body

You can select the values from the Add field to template list and click Insert to use them for the email subject and the email body template. A set of fields determines what information is reflected in the email.

Field name

Description

Title

Title of the alert.

Conditions

A set of conditions defined on the Conditions tab.

Description

Description of the alert set on the Alert properties tab.

Details

A set of conditions defined on the Conditions tab.

Message URL

A link to display the alert message in Insight Viewer. You can use this link to share the alert message and forward it.

Reason

Determines the reason why this alert message is sent. The value is assigned automatically. The following options are available: New, Resolved, Escalated.

Severity

The severity of the alert is defined on the Alert properties tab.

Status

Status of the alert is assigned automatically: Created, Correlated (assigned after alert escalation), and Resolved.

Viewer URL

A link to the root Viewer. You can set the URL in Admin Console > Options.

Web service configuration tab

Use the tab to make a web service call once an alert is triggered. Only the URL tab is required; the other fields are optional. By default, it sends an HTTP GET request. Select a template for the web service call configuration, which is created under the Remote Services on the Documents Tree.

Use the scrollbar to navigate within the form.

  1. Verify that you have a saved remote service document located under the Documents Tree > Remote Services in Studio.
  2. Web Service: Select the remote service document by clicking the ellipsis button. For example, AlertService.
  3. Add query string parameters: Add a number of query strings to pass as parameters with the web service call. Click the Add new parameter link to add them. For metric alerts, add the dimension value.
  4. Optional. Use the HTTP Headers tab to send data in the HTTP header.
  5. Optional. On the Data tab, use the Add field to data list to include the parameters in the service method response.
  6. Optional. Click Test to test the web service request.