Alert Policies

Prev Next

Use an alert policy to get notified when a Scout's test results meet conditions that you define. A Scout can have one alert policy.

For example, you can create an alert policy that notifies you after a Scout fails three consecutive tests, or when a performance metric exceeds a threshold.

You can configure an alert policy while creating a Scout or add one later to an existing Scout.

ControlUp Academy Training Video

Watch the ControlUp Academy training video to learn more about alerts.

Alerts for Stopped Scouts

Alert policies are based on Scout test results. If a Scout cannot run, for example because its Custom Hive is down, use alerts for stopped Scouts instead. For more information, see Alerts for Stopped Scouts.

Configure an Alert Policy

You can open the alert policy settings in either of these ways:

  • When creating a Scout, configure the Scout details and select Next: Alert Policy.
  • For an existing Scout, open the Scout and select Alert Policy.

Use the alert policy settings to define:

  • What test results trigger the alert.
  • How many matching tests are required before a notification is sent.
  • How matching tests from multiple Hives are counted.
  • When you are notified again after the alert is triggered.
  • Where alert notifications are sent.

Set Alert Conditions

Alert conditions define the test results that trigger the alert. The available properties depend on the Scout type. For example, a Shell Scout can use properties such as Status or Exit Code, while a Ping Scout can use properties such as Ping or Last hop status.

In the Alert Policy window, under Conditions, select a property, operator, and value to define when the alert should trigger.

To combine conditions:

  • Select Add "and" condition when multiple conditions must be met together.
  • Select Add "or" condition when either group of conditions can trigger the alert.

For example, you can trigger an alert when Status is Failed and the test duration exceeds a value you specify.

Configure Alert Behavior

Expand Advanced Settings to fine-tune how the alert policy responds when test results meet the alert conditions.

Use these settings to:

Require Consecutive Matching Tests

In Consecutive tests meeting conditions before notification is sent, enter the number of consecutive tests that must meet the alert conditions before the notification is sent.

For example, set the value to 3 if you want to be notified only after three consecutive tests meet the conditions. A single failed test that recovers on the next run would not trigger the notification.

Choose How Tests From Multiple Hives Are Counted

If the Scout runs from multiple Hives, use From to control how matching tests from those Hives count toward the consecutive-test requirement.

  • Across all Hives: The required consecutive tests must come from the same Hive. For example, if the value is 3, London must meet the alert conditions three times in a row.
  • Any Hive: Matching tests can come from different Hives. For example, London can meet the conditions first, followed by Tokyo and then New York.

Use across all Hives when you want to identify a problem affecting a specific location. Use any Hive when matching results from different locations should contribute to the same alert.

Choose When to Be Notified Again

After an alert is triggered, use After that, notify me again to control when another notification is sent.

  • When test results return to normal: Receive the initial notification when the alert is triggered and another notification when the test results return to normal.
  • Every time conditions are met: Receive a notification every time a test matches the alert conditions, regardless of recovery.

Choose Notification Methods

In the Alert Policy window, under Notifications, choose where alert notifications are sent. You can configure one or more notification methods.

For example, you can send an email to your support team and also send a webhook to an external system.

Email

Select Email and add the email addresses that should receive the notifications.

Alert emails are sent from alerts@scoutbees.io.

For Shell Scouts, you can also select Attach shell output to alert emails to include the shell command output as a .txt attachment. Attachments can be up to 5 MB. Shell output larger than 5 MB is not attached.

Sensitive Information

Shell output may contain sensitive information and is sent to all email addresses configured for the alert.

Webhook

Select Webhook to send notifications to an HTTP endpoint.

Enter the Endpoint Address and select an Authentication Method. You can also select Add custom header or Add custom field to include additional information in the webhook.

For more information, see Webhooks for Synthetic Monitoring.

Integration

Select Integration to send alert notifications through a configured integration, and then select the integration from the list.

Firewall Requirements

Alert notifications are sent from a ControlUp cloud server. If the destination is restricted by a firewall, allow access from the required ControlUp IP addresses.

See IP Addresses Used for Alerts.

Track Alerts Without Notifications

Select Do not send notifications if you want ControlUp to track when the alert conditions are met without sending an email, webhook, or integration notification. Alert details are then available only through the Synthetic Monitoring API.

When you finish configuring the alert policy, select Next: Summary when creating a Scout, or Save when editing an existing alert policy.

Manage an Alert Policy

Open the Scout and select Alert Policy to manage its existing alert policy.

  • To edit the policy, change the required settings and select Save.
  • To stop the policy without deleting its configuration, select Disable. To use it again, open the policy and select Enable.
  • To delete the policy, select Remove, and then select Delete Alert. Deleted alert policies cannot be recovered.