概述
北极星告警通知服务为开发者提供基于告警规则的告警服务,通过短信及邮件的方式通知客户融云 IM 及 RTC 服务的异常指标和事件,开发者可基于告警内容及时采取应对措施。
告警通知服务提供以下主要能力:
- 配置告警规则,基于规则进行告警。
- 支持通过短信及邮件方式通知联系人,最多可配置 20 个。
- 支持查看最近 30 天的告警记录。
使用限制
- 告警通知服务目前仅对专有云客户开放。
- 告警通知服务目前仅在新版开发者后台提供(域名
console.rongcloud.cn
)
专有云客户登录新开发者后台-北极星,即可看到告警通知相关菜单并使用相关功能。后续会逐渐对 IM 尊享版、旗舰版客户付费开放,敬请期待。
告警通知
告警规则
可创建多个告警规则,每条告警规则相对独立。目前支持告警规则目支持:
- Server API QPS 的告警规则配置,可针对全局 API 进行设定,也可以仅配置某个特定的 API 配置规则。
- Server API 错误码的告警规则配置,支持 HTTP 错误码、业务返回错误码到达设定次数时的告警通知。可选择全部 HTTP 错误码或全部业务返回错误码,也可指定某个特定的错误码配置规则。
- 消息量激增/激降的告警规则配置,支持针对上行、分发、下行单独配置,可配置与昨日同时段、上周同时段、环比上个时段,可选择增长、下降或异常波动三种场景配置规则。
创建规则
告警规则粒度到 appkey 维度,不同的 appkey 针对同一指标可配置不同的告警规则。
Server API 告警
- 告警名称:即告警规则名称,最多 30 个字符。
- 规则设置:支持针对 Server API 的 QPS、错误码两个场景进行配置。
- QPS:可设置全局或指定的某个 API 的 QPS 阈值。当 QPS 大于等于设定频率时触发告警。
- 错误码:可指定 HTTP 错误码或业务返回错误码,既可以选择全部错误码,也可选择某个指定的错误码,可设定累计出现次数的时间段,1 分钟或 1 小时。出现次数默认为 100 次,最高可调整为 10000 次。
- 告警间隔:同一规则在设定的告警间隔内不会重复发送告警通知,如规则设置为全局时,不同API在告警间隔内会多次触发。支持设置 1 分钟、5 分钟、30 分钟、1 小时、3 小时。
- 生效时间:即在设定的时间段内才会触发告警。
- 告警联系人:选择该条告警规则要通知的联系人,告警联系人可在告警联系人菜单下进行配置。
- 告警方式:可选择短信或邮件告警,支持多选。手机号和邮箱地址在配置告警联系人时添加。
消息量告警
- 告警名称:即告警规则名称,最多 30 个字符。
- 规则设置:可选择全部会话类型或指定的某个会话类型告警,针对上行、分发、下行进行监控,比较时段支持与昨日同时段、上周同时段、环比上个时段作为对比参照,可选择消息量增长、下降某个单一维度,也可选择异常波动选项,即无论增长还是下降,到达设定幅度后均会触发告警。
- 时段粒度:支持 1 小时和 1 分钟粒度。当选择较昨日同时段或较上周同时段时,时段粒度代表同一时刻跨度,如选择 5min,举例:今天7:00- 7:05 与昨天 7:00- 7:05 比较;当选择较上一时段时,时段粒度代表一个固定时间段,如选择 1h,表示相连的两个小时进行比较。
- 告警间隔:同一规则在设定的告警间隔内不会重复发送告警通知,如规则设置为全局时,不同API在告警间隔内会多次触发。支持设置 1 分钟、5 分钟、30 分钟、1 小时、3 小时。
- 生效时间:即在设定的时间段内才会触发告警。
- 告警联系人:选择该条告警规则要通知的联系人,告警联系人可在告警联系人菜单下进行配置。
- 告警方式:可选择短信或邮件告警,支持多选。手机号和邮箱地址在配置告警联系人时添加。
修改告警规则
找到对应告警规则,点击修改即可修改告警规则。
删除告警规则
找到对应告警规则,点击修改即可删除告警规则。删除的告警规则不可被找回,请慎重操作。
告警联系人
告警联系人隶属于当前组织,不按appkey区分,最多添加20个。
添加告警联系人
- 联系人姓名:即要通知的联系人姓名,最多支持 10 个字符。
- 手机号:告警规则触发后发送短信的手机号。
- 邮箱地址:告警规则被触发后发送邮件的邮箱地址。
修改/删除告警联系人
找到某个联系人,点击修改或删除进行相关操作。
告警记录
每次基于告警规则触发的告警,均以一条记录的形式在告警记录菜单进行展示。
- 告警时间:触发告警的具体时间。
- 告警内容:具体的触发告警的原因。
- 告警对象:该条告警通知的具体联系人姓名。
- 告警方式:以何种形式触发的告警。
- 操作:可查看该条告警记录是由哪个告警规则触发。