Alert Notifications

Overview

Alert Notifications sends alerts to you when abnormal metrics or events are detected in your Agora RTC projects. You can receive the alerts through e-mails or API callbacks and take action accordingly.

Alert Notifications provides the following features:

• Predefined metrics that allow for easy alert creation.
• Support for sending alerts to multiple contacts through multiple channels.
• Automatic storage of the alert records for the last 7 days.
• Data synchronization with Call Inspector and Data Insights, so that you can easily dive into problem analysis.

Getting started

To access the Alert Notifications page, do the following:

1. Subscribe to a pricing plan to enable the Alert Notifications service.
2. Log in to Agora Console, and click Agora Analytics > Alert Notifications on the left navigation bar.

Alert rules

An alert rule consists of three parts: associated product, rule settings, and notification type.

This section introduces how to create, enable, edit, and delete an alert rule. It also provides parameter descriptions for alert callbacks.

Create an alert rule

To create an alert rule, do the following:

1. On the top of the page, click Alert rules.
2. In the upper-left corner, select a project from the dropdown menu.
3. In the upper-right corner, click the Create a rule button, and fill in the following information in the pop-up window:

Enable an alert rule

A newly created alert rule is disabled by default. To enable a rule, do the following:

1. On the top of the page, click Alert rules.
2. Find the rule you want to enable, click Enabled in the Operation column, and click OK in the pop-up window.

To enable a group of rules all at once, check the box next to the name of each rule, and click Enabled.

Edit an alert rule

To edit a rule, do the following:

1. On the top of the page, click Alert rules.

2. Find the rule you want to edit, and click Edit in the Operation column.

   If you did not create this rule, a pop-up window appears. Read the text, and click OK.

3. Make your changes, and click OK.

Delete an alert rule

To delete a rule, do the following:

1. On the top of the page, click Alert rules.
2. Find the rule you want to delete, and click Delete in the Operation column.
3. Read the text in the pop-up window, and click OK.

To delete a group of rules all at once, check the box next to the name of each rule, and then click Delete.

Alert callback parameters

If you create an alert callback for an alert rule, Agora sends requests to the URL you provide when the rule is triggered. Currently, the alert callback function has the following limitations:

• No authentication mechanism is supported, including HTTP authentication.
• If a request fails, Agora resends the request up to a maximum of two times. The timeout period for each request is two seconds.
• Agora sends a request whenever the alert rule is triggered.
• The outbound IP address of the alert callback API may change. You can do one of the following:
  • (Recommended) Open port 80 for your security group.
  • If opening port 80 is not an available option to you, contact Agora to get the outbound IP address. Note that when Agora changes the IP address, you need to make changes accordingly.

Alert information is sent to you through HTTP POST methods in JSON format. The following sections provide parameter descriptions and request examples for your reference.

Metric alert

If the alert granularity is set as Channel：

{
    "alertTime":"1631703720000", // The timestamp (seconds) when the alert is sent
    "timeZone":"UTC+8", // The timezone you set for the rule
    "projectName":"test", // Your Agora project name
    "cname":"d1********02", // The channel name
    "enContent":"video freeze rate≥85%", // Alert information（"cnContent" means Chinese, and "enContent" means English）
    "currentUserNum":"2", // The number of users in the channel
    "currentHostNum":"1", // The number of hosts in the channel
    "callId":"61********e5", // The call ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********e5", // The corresponding Call Inspector page
    "remark":"Video freeze" // The email note you set for the rule
}

If the alert granularity is set as User：

{
    "alertTime":"1631780400000", // The timestamp (seconds) when the alert is sent
    "timeZone":"UTC+8", // The timezone you set for the rule
    "projectName":"test", // Your Agora project name
    "cname":"97********e1", // The channel name
    "uid":"95****96", // The user ID
    "enContent":"video freeze rate≥10%", // Alert information（"cnContent" means Chinese, and "enContent" means English）
    "currentUserNum":"2", // The number of users in the channel
    "currentHostNum":"2", // The number of hosts in the channel
    "callId":"61********0e", // The call ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********0e", // The corresponding Call Inspector page
    "remark":"Video freeze" // The email note you set for the rule
}

Event alert

{
    "alertTime":"1631785450000",  // The timestamp (seconds) when the alert is sent
    "timeZone":"UTC+8", // The timezone you set for the rule
    "projectName":"test", // Your Agora project name
    "cname":"t****e", // The channel name
    "uid":"6****1", // The user ID
    "enContent":"no frame sending,no voice sending,no voice receiving,wifi congestion,system CPU utility too high",  // Alert information（"cnContent" means Chinese, and "enContent" means English）
    "currentUserNum":"100", // The number of users in the channel
    "currentHostNum":"1", // The number of hosts in the channel
    "callId":"61********f5", // The call ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********f5", // The corresponding Call Inspector page
    "remark":"Abnormal events" // The email note you set for the rule
}

Alert contacts

Alert contacts lists the contacts you have created for all alert rules. For an individual alert rule, only the contacts you add for the rule receive notifications when the rule is triggered.

This section introduces how to create, edit, and delete a contact.

Create a contact

To create a contact, do the following:

1. On the top of the page, click Alert contacts.
2. In the upper-right corner, click Create a contact.
3. Enter the contact's name and email address, and click Get the verification code.
4. Enter your verification code, and click OK.

Note the following limitations when creating a contact:

• Each email address can only be used to create one contact.
• An email address can request a verification code a maximum of five times per day.

Edit a contact

To edit a contact, do the following:

1. On the top of the page, click Alert contacts.
2. Find the contact, and click Edit below in the Operation column.
3. Make your changes in the pop-up window, and click OK.

Delete a contact

To delete a contact, do the following:

1. On the top of the page, click Alert contacts.
2. Find the contact, and click Delete in the Operation column.
3. Read the text in the pop-up window, and click OK.

To delete a group of contacts all at once, check the box next to the name of each contact, and then click Delete.

Alert records

Records of your alert notifications are saved for seven days.

This section introduces how to view and manage alert records.

View alert records

To view your alert records, do the following:

1. On the top of the page, click Alert records.
2. (Optional) Apply the following filters:
   • Project filter: Select a project from the dropdown menu in the upper-left corner.
   • Time filter: Select a start date and end data on the top.
   • Filter for alert granularity, alert level, or status: Click the corresponding funnel icon in the header row.

Manage alert records

To manage an alert record, do the following:

1. On the top of the page, click Alert records.
2. Find the record, and click the dropdown menu in the Status column:
   • If you have resolved the issue, select Resolved.
   • If the issue does not require action, select Ignored.
3. (Optional) To further analyze an alert record, click Call details to use the Call Inspector service.
4. (Optional) To adjust the rule corresponding to an alert record, click Edit Alert Rule, and make changes in the pop-up window.

To manage a group of alert records all at once, check the box in the first column for each record and click Mark as resolved, Mark as ignored, or Delete.