Custom Alerts in Treblle
Custom Alerts in Treblle 3.0 allow you to stay informed about critical API events without sifting through endless logs. This feature lets you configure specific triggers, ensuring timely notifications for error spikes, performance issues, or unusual activities.
In this docs, we’ll cover:
- Setting up Custom Alerts.
- Configuring saved searches.
- Choosing notification channels.
- Examples of Custom Alerts.
Prerequisites
Before you begin, ensure you have:
- A Treblle account.
- Access to your project in the Treblle dashboard.
- Permissions to create and manage alerts.
Setting Up Custom Alerts
Steps to create a Saved Search
Saved searches allow you to define filters for specific API events.
1. Navigate to the Requests tab:
- Go to the Treblle dashboard and open the Requests tab.
2. Apply filters:
- Define the conditions you want to monitor.
For example, filter all POST
requests to /auth/register
.
3. Save the search:
- Click the Save button.
- Provide a meaningful name, such as
Auth Error Alerts
.
Configure a New Alert
1. Go to My Alerts:
- Open the My Alerts section in the Treblle dashboard.
2. Create a new alert:
-
Click New Alert and fill in the details:
- Alert Name: Choose a descriptive name.
- Saved Search: Select the saved search you created earlier.
- Frequency: Set how often notifications should be sent.
3. Choose notification channels:
-
Options include Email, Slack, or In-app notifications.
-
For Slack, add a webhook URL under API settings.
- For In-app notifications, you can see the alerts in the notifications section.
4. Assign recipients:
- You have the option to add up to five team members who should receive the alerts.