The Real-time Alarm function of Agora Analytics enables you to view users who have poor communication experiences, recognize abnormal categories and quality factors.

Statistics are updated every minute. You can query the statistics for the past 24 hours at maximum.

Getting started

  1. Contact support@agora.io to enable the Real-time Alarm function for your project.
  2. Log in to Agora Console. Click Agora Analytics on the left navigation bar.
  3. Select a project in the top-left corner.
  4. Click Auto Diagnosis and Real-time Alarm to view and analyze users having poor communication experiences.

Timeline

  • Specify a time frame: The default time frame is the past four hours. Drag the round icons on the timeline to specify a period to view, or use the shortcut buttons below the timeline.
  • Specify a moment: Drag the clock icon on the timeline to specify a moment to view.
    • Once you have dragged the icon, the Auto Update checkbox is deselected automatically.
    • If you drag the clock icon out of the specified time frame, the specified time frame extends following the clock icon.
  • Auto Update: Click Auto Update at the bottom left of the timeline to enable the page to update the statistics automatically.
You can set the time to your local time zone or UTC by setting it from the top of the front page in Agora Analytics.

Overview

Overview displays the real-time statistics of users experiencing poor communication experiences in a card view. The left side of the card shows the current value (or the value at the specified moment) of the metric, along with the ratio, maximum, average, and minimum values for that metric. The right side shows the per-minute statistics for a specified time frame as a line chart.

Metric Description
Users experiencing join delay Users who successfully join a channel but experience a delay. The ratio is the number of users experiencing channel-join delay against the total number of users who apply to join a channel.
Users experiencing audio freeze Users who experience an audio freeze during the call. The ratio is the number of users experiencing audio freezes against the total number of users in the channel.
Users experiencing video freeze Users who experience a video freeze during the call. The ratio is the number of users experiencing video freezes against the total number of users in the channel.

Distribution

Distribution displays the distribution of communication quality factors, along with the associated scale statistics for the specified time frame. Click All to expand the drop-down menu, and choose an abnormal category to view the distribution of corresponding quality factors and affected users. For a description of quality factors, see Factor ID.

Details

Details displays the statistics of users having poor communication experiences, including the following information:

  • Channel name
  • User ID
  • Abnormal sections
  • Abnormal categories
  • Issue descriptions
  • Issue sources
  • Quality factors

Search

  • Enter the channel name to search the statistics of all users who have poor communication experiences in the specified channel.
  • Enter the user ID to search the statistics of the specified user who has a poor communication experience.

Query time

Details displays the statistics of the specified time frame by default. To view the statistics of the current time (or a specified moment), click Within selected moment at the top right of the list.

Download

Click Download to download the statistics. You can download a maximum of 1,000 items.

Operation

Under Operation, click Details to view all call statistics of a specific user. For details, see Call Search.

You can view or download a maximum of 1,000 items.
Metric Description
Abnormal Sections The sections when users have poor user experiences, such as joining a channel and during the call.
Abnormal Categories The categories of abnormal issues users encounter, such as delay, freeze and crash.
Issue Descriptions The detailed descriptions of all abnormal issues, such as channel-join delay, video freeze and black screen.
Issue Sources The user causing the poor communication experience, such as the local user or the remote users.
Quality Factors The factors causing the poor communication experiences. See Factor ID for more information.

Key terms

This section describes the key terms used in Real-time Alarm. See Glossary for more information.

Channel

Every call or live broadcast occurs in a channel. If you imagine an app as a building, a channel is a room in the building.

Real-time Alarm does not count a channel by name, but by lifecycle. It counts a channel each time from the first user joining it to the last user leaving it.

User

Each user in the channel has a unique user ID.

Real-time Alarm counts a unique username in a unique channel as one user. If a real-life user joins one channel with multiple, different usernames, or joins different channels with one username, Real-time Alarm counts users in both situations as multiple users.

Poor communication experience

During a call, users may experience quality issues, such as audio freeze or video freeze, caused by various factors. Agora calls this as a poor communication experience. See Experience ID for more information.