# 告警工具

# 概述

在小游戏运行中，出现异常或故障时，及时发现并解决问题是非常重要的。告警功能可以帮助开发者监控小游戏状态，及时发现并处理问题，保障小游戏运行的稳定性。

平台针对性能指标新增了异常监控，当指标出现异常波动时，会通过回调通知的方式将告警消息推送给开发者，同时我们还提供了告警状态扭转、屏蔽告警的功能，帮助开发者更好地管理告警信息。

# 使用流程

# 配置告警

1. 告警间隔：两次告警通知之间的时间间隔，以分钟为单位。例如，告警间隔为60分钟，则在第一次告警通知发送后的60分钟内，即使监控指标仍然达到告警条件，系统也不会再次发送告警通知。
2. 监控指标：要监控的系统指标，如小游戏内存异常退出率等。一个指标只对应一个告警，告警配置后不可修改监控的指标。
3. 监控算法：是否使用系统预设的算法判断触发告警，默认开启。如果没有开启监控算法，当前阶段，开发者不会收到任何异常告警。
4. 回调接口地址：在告警触发后，系统会向指定的接口地址发送告警通知。开发者需要提供一个可用的接口地址，用于接收告警通知。
5. 通知时间：一天中希望接收告警通知的时间段。

# 配置回调接口

首次配置告警前，需配置回调接口。回调接口配置长期有效，后续告警无需重复配置。

1. URL：回调地址，当告警触发后，系统会将告警信息发送到该地址。
2. Token：用于验证告警通知的令牌。当系统向回调地址发送告警信息时，会同时发送该令牌。需要对该令牌进行验证，确保告警信息来自于系统而非恶意攻击者。
3. EncodingAESKey：用于加密告警信息的密钥。当选择消息加密方式为安全模式时，系统会使用该密钥对告警信息进行加密。
4. 测试：测试接口配置是否可用。配置完成后点击下方模拟推送，系统会向回调地址发送一个GET请求，并携带query参数：

http://example.com/api?signature=e7da52f3a99d5ed1c682191ac2bc3d92d2e3504d&timestamp=1721877380&nonce=413573673&echostr=LAJZ09X2zKmj

测试通过的条件为：回调接口向系统返回echostr的内容。

# 发布回调配置

测试通过后，点击发布配置，回调设置才能生效。

# 启用告警

配置完成后在配置首页启用告警配置，启用后告警配置正式生效。若暂时不想监控该指标，可以关闭启用开关。

# 查看告警记录

告警记录页可以查看近期的告警记录。

点击单条告警的告警详情，可以查看异常发生时间、告警时间和被监控指标的具体值。

# 状态扭转

1. 每条告警都对应一个独立的状态，可以设置单条告警状态为“未处理”、“处理中”、“已处理”，标记告警的处理进展。
2. 可以对状态扭转的原因附加说明。
3. 在扭转告警状态的同时，也可以屏蔽告警。

# 屏蔽

1. 屏蔽与状态扭转不同，状态扭转以单条告警为单位，屏蔽以告警配置为单位，由同一个告警配置产生的告警共享一个屏蔽时间设置。
2. 设置屏蔽时间可以在一段时间内屏蔽告警通知，该段时间从设置屏蔽的时间开始，至设置的截止时间结束。
3. 可以对屏蔽的原因附加说明。

# 查看告警处理记录

状态扭转和屏蔽统称对告警的处理，告警处理记录可以点击告警记录页的处理记录按钮查看。

# 联系我们

如有任何问题、建议，欢迎扫码联系小助手咨询