Managing Alerts

Overview

This guide walks you through creating, viewing, editing, and deleting alerts from the Alerts dashboard. The UI uses a modal with a two-step Stepper form to guide you through basic settings and webhook configuration.

Creating a New Alert

Prerequisites

• You must belong to at least one project to assign an alert using Select Project.
• A webhook must be configured if you want the alert to send external notifications. Configure webhooks under Settings > Webhooks before using them.

Steps to Create

1. Click on the Create New button in the top-right of the Alerts dashboard.
2. In the modal, on the first step (Basic connection):
   • Enter a value in the Alert Name field (Alert Name).
   • Use Select Project to choose the project this rule applies to.
   • Set the Deduplication Period using the number input and unit selector (Minutes / Hours).
   • Build trigger conditions with the Filters section using field, operator, and value rows.
   • Click Next to proceed.
3. On the second step (Webhook Config):
   • Choose a webhook from Select Webhook (clearable and searchable).
   • If your webhook template contains variables, provide values for each variable shown.
   • Click Create to save the alert.

Example sequence:
1. Click `Create New`
2. Fill `Alert Name` and `Select Project`
3. Add Filters: `level` `eq` `error`
4. Set Deduplication: `5` `Minutes`
5. Click `Next`, choose `Webhook`, fill template variables
6. Click `Create`

Tip: Use descriptive Alert Name values that include scope and severity, e.g. Payments-Service - High Latency (Warning).

Required Fields

• Alert Name: A descriptive name shown in the alerts list.
• Select Project: The single project scope for the rule (required in the form).
• Filters: At least one filter is recommended to avoid broad matches.

Viewing Alerts

Alerts List

• The main Alerts page shows a card-style list of alerts with the alert title and action icons.
• Each alert card has two action icons: Edit (pencil) and Delete (trash).
• Use the pagination control at the bottom-right to navigate across pages.

Filtering Options

The primary filtering mechanism when composing an alert is the Filter Builder inside the modal. It supports multiple rules.

Filter	Description
field	The JSON path or field name to evaluate (e.g. level, data.amount, context.userId)
operator	Comparison operator: = (eq), != (ne), contains, >, >=, <, <=
value	The value to compare against (string or number)

Search Functionality

There is no text search box on the alerts list. Use clear naming conventions and pagination to find alerts quickly.

Editing Alerts

To Edit an Alert

1. Click the Edit (pencil) icon on the alert card you want to change.
2. The same modal used for creation opens populated with the alert's settings.
3. Update fields as needed across the two steps.
4. Click Update to save changes.

Warning: When editing webhook template variables, ensure you provide values for all required variables shown — otherwise the webhook payload may be incomplete.

Deleting Alerts

Steps to Delete

1. Click the Delete (trash) icon on the alert card.
2. A confirmation dialog will appear with Delete and Cancel choices.
3. Click Delete to permanently remove the alert, or Cancel to abort.

Note: This action cannot be undone.

Best Practices

Do's

• Use specific fields in Filters (e.g. data.duration) rather than broad fields like message.
• Set a sensible Deduplication Period to avoid alert storms.
• Provide clear Alert Name including project and intent.

Don'ts

• Don't create overly broad filters that match high-volume events without deduplication.
• Don't forget to test webhook templates in a staging project before using them in production.

Troubleshooting

Issue: Webhook variables not shown when selecting a webhook

Solution: Ensure the webhook you selected has body_template or headers that include template variables. If not, the form will display: No variables found in your template.

Issue: Alert Name is required validation error

Solution: Enter a non-empty value in the Alert Name field. The form validates title as required.

Frequently Asked Questions

How do I avoid duplicate notifications?

Set the Deduplication Period (minutes or hours) to a value that prevents repeated messages for the same event.

Can an alert target multiple projects?

Use the Select Project control; by default the modal uses single-project mode for alerts. If you need multi-project logic, consider creating similar alerts per project.