告警通知

告警通知简介

水晶球的告警通知服务对声网 RTC 项目的异常指标和事件提供告警。你可以通过邮件、接口回调等多种方式接收告警通知，及时采取应对措施。

功能概述

告警通知服务提供以下功能：

• 基于预定义指标配置告警。
• 支持通过多种渠道发送告警通知给多个联系人。
• 存储最近 7 天的告警历史。
• 与水晶球的通话调查、数据洞察服务共享数据，方便深入调查问题。

如何开通

请联系 sales@agora.io 开通告警通知服务和咨询计费。

告警规则

告警规则包含关联产品、规则配置、通知方式三个组成部分。

本节介绍告警规则的常用操作，并提供告警回调的参数说明。

创建告警规则

参考如下步骤创建告警规则：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知，然后在页面上方点击告警规则。

2. 在页面左上方的下拉菜单中选择需要创建告警规则的项目。

3. 点击页面右上角的创建规则，在创建告警规则弹窗中配置以下信息：

   配置项	说明	限制
   关联项目	当前告警规则适用的 RTC 项目。	一条规则只能有一个关联项目。
   规则名称	自定义名称。	同一关联项目下的规则名称必须唯一。
   告警类型	支持以下两种： 指标告警：在指标数值高于或低于阈值时告警。 事件告警：在特定事件出现时告警。	/
   告警粒度	支持以下两种： 频道：在频道发生异常情况时告警。 用户：在用户遇到异常情况时告警。	对于事件告警，告警粒度只能设为用户。
   规则描述	由逻辑关系、指标或事件、计算周期、持续周期、比较关系、阈值或布尔值组成。 例如：指标为音频卡顿率、计算周期为 20s 周期、持续周期为持续 2 个周期、比较关系为 >=、阈值为 10%，代表的含义为：每 20 秒统计一次音频卡顿率数据，如果音频卡顿率连续两次大于等于 10%，则触发告警。 如果需要监控多个指标或多个事件，可以添加多条规则。多条规则之间的关系可以设置为“与”和“或”。	最多添加 20 条规则。
   沉默周期	已针对某条规则发送告警通知后，如果在沉默周期内再次触发同一告警规则，将不会发送告警通知。同一告警规则指的是告警粒度和规则描述的配置都相同。	/
   生效时间	只有生效时间内发生的异常情况才会触发告警规则。	/
   规则范围	支持以下三种： 全部用户或全部频道。 自定义名单：频道或用户名单，每条数据之间需要换行。 自定义正则表达式：例如，将规则应用到所有以 “aa” 开头的频道，正则表达式可设为 “aa.*”。	/
   高级过滤条件	在规则描述的基础上，增加过滤条件可以提高告警的准确度。点击设置高级过滤条件，可以修改或关闭默认设置。	/
   告警级别	包括 Critical、Warning、Info 三个级别。	/
   告警方式	支持以下两种： 邮箱：所选告警联系人的对应邮箱。 企业微信机器人：企业微信机器人回调。	每个声网控制台账户一天最多发送累计 500 封的告警通知邮件。例如：某条告警规则在一天内触发了 20 次，有两个告警联系人，则累计发送了 40 封邮件。
   邮件备注	告警通知邮件中的备注信息。	告警方式设为邮箱时，该配置项才会出现。
   企业微信机器人	企业微信机器人的 webhook 地址。	告警方式设为企业微信机器人时，该配置项才会出现。
   告警联系人	接收告警通知的对象。	一条规则最多可以选 5 个告警联系人。
   告警语言	告警通知内容的语言。	/
   告警时区	告警通知内容中显示的时区。	/
   告警回调	接收告警通知的可访问的公网 URL。你可以参考告警回调参数，基于接收到的告警通知做进一步的处理。	详见告警回调参数。

启用告警规则

新创建的告警规则默认不会启用。参考如下步骤启用告警规则：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知 > 告警规则，然后在页面上方点击告警规则。
2. 选择需要启用的告警规则，点击操作下面的启用，在弹窗中点击确定。

启用告警规则支持批量操作。

修改告警规则

参考如下步骤修改告警规则：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知 > 告警规则，然后在页面上方点击告警规则。

2. 选择需要修改的告警规则，点击操作下面的编辑。

   如果这条规则是由他人创建的，你会看到一个弹窗。阅读弹窗信息，然后点击确定。

3. 在弹窗中修改配置信息，修改完后点击确定。

删除告警规则

参考如下步骤删除告警规则：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知 *> *告警规则，然后在页面上方点击告警规则。
2. 找到需要删除的告警规则，点击操作下面的删除。
3. 阅读弹窗信息，点击确定。

删除告警规则支持批量操作。

告警回调参数

在告警规则被触发时，告警回调会将通知消息发送到你提供的 URL 地址。告警回调目前具有以下限制：

• 没有认证机制，暂不支持 HTTP 认证。
• 告警推送失败最多重试 2 次，每次推送请求的超时等待时间为 2 秒。
• 告警规则每次被触发时，均会推送告警通知到回调服务接口。
• 水晶球告警回调 API 的出方向 IP 可能发生变化，声网建议：
  • 在安全组上配置 80 端口全放通策略。
  • 如果无法配置 80 端口全放通，声网可以向您提供告警服务出方向 IP，但会存在 IP 切换的可能性，需要你配合做生产切换。

告警回调通过 HTTP 的 POST 请求发送 JSON 格式的数据，参数说明和示例如下。

指标告警

告警粒度为频道：

{
    "alertTime":"1631703720000", //发送告警通知的时间戳，单位为秒
    "timeZone":"UTC+8", //你在规则中设置的时区
    "projectName":"test", //RTC 项目名称
    "cname":"d1********02", //频道名称
    "enContent":"video freeze rate≥85%", //告警信息（cnContent代表中文，enContent 代表英文）
    "currentUserNum":"2", //频道当前在线用户数
    "currentHostNum":"1", //频道当前在线主播数
    "callId":"61********e5", //通话 ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********e5", //对应通话调查页面的链接
    "remark":"email note" //你在规则中设置的邮件备注
}

告警粒度为用户：

{
    "alertTime":"1631780400000", //发送告警通知的时间戳，单位为秒
    "timeZone":"UTC+8", //你在规则中设置的时区
    "projectName":"test", // RTC 项目名称
    "cname":"97********e1", //频道名称
    "uid":"95****96", //用户 ID
    "enContent":"video freeze rate≥10%", //告警信息（cnContent代表中文，enContent 代表英文）
    "currentUserNum":"2", //频道当前在线用户数
    "currentHostNum":"2", //频道当前在线主播数
    "callId":"61********0e", //通话 ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********0e", //对应通话调查页面的链接
    "remark":"email note" //你在规则中设置的邮件备注
}

事件告警

{
    "alertTime":"1631785450000",  // 发送告警通知的时间戳，单位为秒
    "timeZone":"UTC+8", //你在规则中设置的时区
    "projectName":"test", // RTC 项目名称
    "cname":"t****e", //频道名称
    "uid":"67****91", //用户 ID
    "enContent":"no frame sending,no voice sending,no voice receiving",  //告警信息（cnContent代表中文，enContent 代表英文）
    "currentUserNum":"100", //频道当前在线用户数
    "currentHostNum":"1", //频道当前在线主播数
    "callId":"61********f5", //通话 ID
    "url":"https://console.agora.io/analytics/call/qoe?id=61********f5", //对应通话调查页面的链接
    "remark":"" //你在规则中设置的邮件备注
}

告警联系人

所有告警规则的联系人都会列在告警联系人中。某条告警规则触发后，只有与其绑定的告警联系人会收到通知。

本节介绍如何创建、修改和删除告警联系人。

创建联系人

参考如下步骤创建告警联系人：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知 > 告警通知，然后在页面上方点击告警联系人。
2. 点击页面右上角的创建联系人。
3. 在弹窗中输入名字和邮箱。输入有效的邮箱地址后，点击获取验证码。
4. 输入验证码，点击确定，完成联系人的创建。

创建告警联系人时有以下限制：

• 一个邮箱只能用于创建一个联系人。
• 一个邮箱每天最多可以获取 5 次验证码。

编辑联系人

参考如下步骤编辑告警联系人：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知 > 告警通知，然后在页面上方点击告警联系人。
2. 找到需要修改的告警联系人，点击操作下面的编辑。
3. 在弹窗中修改信息，修改完后点击确定。

删除联系人

参考如下步骤删除告警联系人：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知，然后在页面上方点击告警联系人。
2. 找到需要修改的告警联系人，点击操作下面的删除。
3. 阅读弹窗信息，点击确定。

删除联系人支持批量操作。

告警历史

告警历史提供过去 7 天内所有告警规则的通知消息。

本节介绍如何查看和管理告警历史。

查看告警历史

参考如下步骤查看告警历史：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知，然后在页面上方点击告警历史。
2. （可选）添加以下筛选条件：
   • 按关联项目筛选：在页面左上方的下拉菜单中选择项目。
   • 按时间范围筛选：在页面上方选择开始日期和结束日期。
   • 按告警粒度、告警级别、状态筛选：在列表首行点击对应的漏斗图标。

管理告警历史

参考如下步骤管理告警历史：

1. 登录控制台，在左侧菜单栏中点击水晶球 > 告警通知，然后在页面上方点击告警历史。

2. 找到要处理的告警历史，点击状态下面的选择框，修改状态：

   • 如果对应的异常情况已经处理完毕，在下拉列表中选择已处理。

   • 如果没有出现对应的异常情况，在下拉列表中选择忽略。

3. （可选）如果某条告警历史需要进一步分析，可以点击操作下面的前往调查，跳转到对应的通话调查页面。

4. （可选）如果某条告警历史对应的告警规则需要修改，点击操作下面的调整规则，可以直接在弹窗中修改规则配置。

告警历史的状态修改和删除支持批量操作。