Alerts

Alerts are a way to keep your team in the loop as to what is happening on your app. Below is a description of the common components of Alerts, and more specific parameters are included in subsequent sections. To get started, visit app.highlight.io/alerts. The basic parameters for an alert look like the following image:

Picking a Source

This input allows you to create alerts based on sessions, errors, logs, traces, or metrics all in one single form. It is backed by the same data used on the search experiences.

Functions

Functions allow for more powerful alerts from simple counts to percentiles of data. These percentile alerts are typically used on the duration of traces to alert when the latency is high.

Filters

Add filters to filter out any unwanted data from be used in the alert evaluation, exactly like the search experiences. For more information on how to best utilize search, please visit our Search docs.

Cooldown

Avoid over alerting by adding a cooldown time. After the initial notification, additional alert notifications will not be sent for this amount of time. If the alert is still in an alert state after the cooldown, another notification will be sent to your added channels.

Distinct Alerts

You can create multiple alerts based on a key in the data to allow more granular alerting. In the example above, the service_name is used to group the data and send an alert distinct to the service. In the example, the "all" and "frontend" services would be notified of an "alert", while the "private-graph" service would not.

Notifications

An alert can be sent to the following channels:

• Slack
• Discord
• Microsoft Teams
• Email
• Webhooks

If your workspace has not yet integrated with one of the channels you are trying to add, you will be redirected to set up the appropriate integration. Once an alert has been created or updated with a channel, a test notification will be sent notifying that it is now being used in a Highlight alert.

Webhook Notifications

All alerts can route notifications to webhooks via a HTTP POST JSON payload. Learn more about configuring webhooks.