监控与告警服务

数据监控

北极星 - 数据监控是为开发者提供的包含业务数据监控、API 监控的数据监控平台，可查看近 7 天的消息量、同时在线、服务端 API 请求量、QPS、请求成功率、错误码占比等相关数据。后续会陆续上线指定会话的消息量、指定聊天室活跃程度等更丰富的数据统计维度，致力于帮助开发者提前感知业务潜在风险，协助客户提前发现问题，降低因各类问题对客户业务产生的影响。

提示：开通【 北极星专业版】 后才可以使用“数据监控”相关功能，登录开发者后台-北极星，即可看到“数据监控”相关菜单并查看相关功能看板。

业务数据

消息数据

可查看近 7 天的单聊、群聊、聊天室、聊天室 KV、超级群的消息相关数据，消息数据为实时统计，数据延迟 5 分钟左右，同时支持根据消息类型筛选，包含：

• 总消息量：上行总消息量、分发总消息量、下行总消息量。
• 消息峰值：上行消息峰值、分发消息峰值、下行消息峰值。
• 消息量变化趋势：数据统计为 5 分钟粒度，每 5 分钟 1 个点，可查看上行、分发、消息量趋势；每个五分钟的消息量为该 5 分钟产生的消息总量。

同时在线

• “同时在线类型”选择“全部”可查看近 7 天的全部用户的同时在线峰值趋势。
• “同时在线类型”选择“仅聊天室”可查看近 7 天的聊天室用户的同时在线峰值趋势。
• 数据统计为 1 分钟粒度，每 5 分钟 1 个点，图表展示该 5 分钟内的 1 分钟粒度峰值。
• 同时在线为实时统计，数据延迟 5 分钟左右。

提示

全部用户同时在线统计依赖客户连接，当用户数量较少时，可能存在某个时段没有新客户连接的情况，因此服务端没有触发数据统计，会存在一定程度的误差。

API 监控

实时统计

API 监控页面可查看近 7 天的有实际调用的 API 的 QPS 情况，并且服务端 API 实时统计数据延迟 5 分钟左右。

• 左侧展示该 App Key 在当前检索的时间段内有实际调用的所有服务端 API 及该接口的请求成功率。
• 点击某个对应 API，展示该接口在当前查询时段的 QPS 及错误码分布。
• 图表中会标注接口当前在融云开发者后台设定的频率值，当 QPS 有频繁超过设定频率的情况时，您可以在开发者后台调整对应接口的调用频率，详情查看频率限制。

错误码统计

可查看过去 7 天的服务端 API 的错误码占比情况，包含 HTTP 错误码占比及业务状态错误码占比统计。

1、错误码统计数据非实时统计，每日统计 1 次，无法查询当天的 API 错误码分布。

2、点击饼图中某个错误码，可查看产生该错误码的具体服务端 API。

3、点击某个服务端 API，可查看该 API 产生对应错误码的时间分布情况。

请求量统计

可查看过去 7 天有实际调用的服务端 API 的每日请求量统计数据。该统计数据非实时统计，每日统计 1 次，次日生成，无法查询当天的 API 请求量统计数据。

告警通知

告警通知服务为开发者提供基于告警规则的告警服务，通过短信及邮件的方式通知客户融云 IM 及 RTC 服务的异常指标和事件，开发者可基于告警内容及时采取应对措施。

告警通知服务提供以下主要能力：

• 配置告警规则，基于规则进行告警。
• 可选监控指标：服务端 API QPS、服务端错误码、消息量同环比、消息量绝对值（目前只支持聊天室）。
• 支持通过短信及邮件方式通知联系人，最多可配置 20 个。
• 支持查看最近 30 天的告警记录。

提示

购买北极星专业版后，才可以看到告警通知相关菜单，免费版不支持。

告警规则

可创建多个告警规则，每条告警规则相对独立。目前支持告警规则目支持：

• Server API QPS 的告警规则配置，可针对全局 API 进行设定，也可以仅配置某个特定的 API 配置规则。
• Server API 错误码的告警规则配置，支持 HTTP 错误码、业务返回错误码到达设定次数时的告警通知。可选择全部 HTTP 错误码或全部业务返回错误码，也可指定某个特定的错误码配置规则。
• 消息量激增/激降的告警规则配置，支持针对上行、分发、下行单独配置，可配置与昨日同时段、上周同时段、环比上个时段，可选择增长、下降或异常波动三种场景配置规则。

创建规则
告警规则粒度到 Appkey 维度，不同的 Appkey 针对同一指标可配置不同的告警规则。

Server API 告警规则配置

• 告警名称：即告警规则名称，最多 30 个字符。
• 规则设置：目前支持对 Server API QPS、Server API 错误码两个指标进行监控。
  1、QPS：可设置全局或指定的某个 API 的 QPS 阈值。当 QPS 大于等于设定频率时触发告警。
  2、错误码：可指定 HTTP 错误码或业务返回错误码，既可以选择全部错误码，也可选择某个指定的错误码，可设定累计出现次数的时间段，1 分钟或 1 小时。出现次数默认为 100 次，最高可调整为 10000 次。
• 告警间隔：同一规则在设定的告警间隔内不会重复发送告警通知，如规则设置为全局时，不同API在告警间隔内会多次触发。支持设置 1 分钟、5 分钟、30 分钟、1 小时、3 小时。
• 生效时间：即在设定的时间段内才会触发告警。
• 告警联系人：选择该条告警规则要通知的联系人，告警联系人可在告警联系人菜单下进行配置。
• 告警方式：可选择如下通知方式。
  1、短信：手机号在配置告警联系人时添加。
  2、邮件：邮箱地址在配置告警联系人时添加。
  3、Webhook： 请在您需要通知的IM群组中创建自定义机器人，然后将该机器人 Webhook 地址配置到融云后台。

消息量同环比告警规则配置

• 告警名称：即告警规则名称，最多 30 个字符。
• 规则设置：可选择全部会话类型或指定的某个会话类型告警，针对上行、分发、下行进行监控，比较时段支持与昨日同时段、上周同时段、环比上个时段作为对比参照，可选择消息量增长、下降某个单一维度，也可选择异常波动选项，即无论增长还是下降，到达设定幅度后均会触发告警。
• 时段粒度：支持 1 小时和 1 分钟粒度。当选择较昨日同时段或较上周同时段时，时段粒度代表同一时刻跨度，如选择 5min，举例：今天 7:00- 7:05 与昨天 7:00- 7:05 比较；当选择较上一时段时，时段粒度代表一个固定时间段，如选择 1h，表示相连的两个小时进行比较。
• 告警间隔：同一规则在设定的告警间隔内不会重复发送告警通知，如规则设置为全局时，不同 API 在告警间隔内会多次触发。支持设置 1 分钟、5 分钟、30 分钟、1 小时、3 小时。
• 生效时间：即在设定的时间段内才会触发告警。
• 告警联系人：选择该条告警规则要通知的联系人，告警联系人可在告警联系人菜单下进行配置。
• 告警方式：可选择如下通知方式。
  1、短信：手机号在配置告警联系人时添加。
  2、邮件：邮箱地址在配置告警联系人时添加。
  3、Webhook： 请在您需要通知的 IM 群组中创建自定义机器人，然后将该机器人 Webhook 地址配置到融云后台。

消息量绝对值告警

• 告警名称：即告警规则名称，最多 30 个字符。
• 规则设置：选择“消息量”，“消息量绝对值”（目前只支持对聊天室会话的消息量进行监控告警）。
  1、需要选择需要监控的会话范围，支持对“全部聊天室”监控，也支持对“指定聊天室”监控。
  2、需要选择需要监控的消息流转节点，您可选择：“上行”、“分发”或“下行”。
  3、需要选择需要监控的消息类型，支持对“全部消息类型”进行监控，或对融云内置消息进行监控、或填写您需要监控的“自定义消息类型”名称。
  4、需要填写您需要告警的消息量的阈值。

规则限制

• 修改告警规则：找到对应告警规则，点击修改即可修改告警规则。
• 删除告警规则：找到对应告警规则，点击修改即可删除告警规则。删除的告警规则不可被找回，请慎重操作。
• 时段粒度：5 分钟 ，不可改。
• 告警间隔：同一规则在设定的告警间隔内不会重复发送告警通知，如规则设置为全局时，不同 API 在告警间隔内会多次触发。支持设置 1 分钟、5 分钟、30 分钟、1 小时、3 小时。
• 生效时间：即在设定的时间段内才会触发告警。
• 告警联系人：选择该条告警规则要通知的联系人，告警联系人可在告警联系人菜单下进行配置。
• 告警方式：可选择如下通知方式。
  1、短信：手机号在配置告警联系人时添加。
  2、邮件：邮箱地址在配置告警联系人时添加。
  3、Webhook：请在您需要通知的IM群组中创建自定义机器人，然后将该机器人 Webhook 地址配置到融云后台。

告警联系人

告警联系人隶属于当前组织，不按 Appkey 区分，最多添加 20 个。

添加告警联系人

• 联系人姓名：即要通知的联系人姓名，最多支持 10 个字符。
• 手机号：告警规则触发后发送短信的手机号。
• 邮箱地址：告警规则被触发后发送邮件的邮箱地址。

修改/删除告警联系人

找到某个联系人，点击修改或删除进行相关操作。

告警记录

每次基于告警规则触发的告警，均以一条记录的形式在告警记录菜单进行展示。

• 告警时间：触发告警的具体时间。
• 告警内容：具体的触发告警的原因。
• 告警对象：该条告警通知的具体联系人姓名。
• 告警方式：以何种形式触发的告警。
• 操作：可查看该条告警记录是由哪个告警规则触发。

s

---