TopStack 文档

主题

告警中心 ​

告警规则 ​

告警规则用于定义在什么情况下触发告警。告警规则建立在【设备模型】之上，选中设备模型，点击【创建】按钮，弹出创建规则窗口，如下图所示：

img

img

参数说明

项目说明
规则名称告警规则名称，必填项。
规则描述告警规则的描述。
告警类型选择告警规则所属的告警类型，必填项。
触发方式告警规则的触发方式，必填项，详见触发方式说明。
区间值当触发方式为单点触发，且比较方式为“区间内”或“区间外”时有效。区间值的格式示例：[0,100]。
持续时长当满足触发条件后，持续一定的时间后才会触发告警，不填则默认实时触发。
死区值死区值可以防止由于测点值不断跨越比较值而产生的告警状态反复变化。
告警设备告警设备的范围：全部设备，勾选后该设备类型下所有设备都会应用此规则；指定设备，勾选后需要选择需要触发告警的设备；
时间条件告警规则触发的时间条件，不填则随时都可以触发；
设备联动告警触发后的设备联动，可以控制设备下发；
报警处理开启后可对报警信息进行报警确认及报警处理的操作；
启用取消勾选，则表示该告警规则不生效。

TIP

死区值可以防止由于测点值不断跨越比较值而产生的告警状态反复变化。例如：为电机工作温度设置告警，其低设置点为50，高设置点为70，死区为2。 如果该值介于50和70之间，则警报将激活，当值低于48或高于72时，警报才会被清除。

CAUTION

注意：死区和持续时长不能同时使用。

触发方式说明

触发方式说明
单点触发基于单个测点值设置触发条件。
通讯状态触发当设备通讯状态发生变化时触发告警。
公式触发以逻辑表达式的方式判断是否满足触发条件。
长时间不上传数据当测点数据长时间不更新时，触发告警。
长时间数据不变化当测点数据长时间不变化时，触发告警。

IMPORTANT

单点触发的特殊触发方式：

  • 持续上升：当检测到该测点在一定时间内持续上升超过一定数值时触发告警。
  • 持续下降：当检测到该测点在一定时间内持续下降超过一定数值时触发告警。
  • 数值偏差：当检测到测点值与比较值的差值大于偏差值时，触发告警。

指定告警设备

如果告警规则设置的是“指定设备”，可以点击“指定设备”按钮，在弹窗中勾选应用于该规则的设备。

img

批量导入 ​

当需要批量配置告警规则时，可以使用 excel 方式进行配置，批量导入告警规则。 点击【导入】按钮，弹出导入对话框，如下图所示：

image.png

在【导入对话框】中，点击【下载模板文件】，将 Excel 模板文件下载到本地。 image.png

在 Excel 文件中，我们按不同的触发方式分成了多个 Sheet 页，每个触发方式需要配置的字段有所区别。

大部分字段根据名称进行填写即可。

image.png

本文档只对几个特殊的字段进行说明：

  • 指定告警设备：如果设置为空，该规则应用到所属模型下的所有设备。如果需要指定设备，可以输入设备标识并用英文逗号（“,”）进行分隔。

  • 设备联动点位：输入需要进行联动输出的点位标识，只支持同模型下的点位标识 ，空表示不进行联动输出 。

告警推送 ​

通过创建通知规则，当发生告警，且满足通知规则中设置的条件时，向指定的通知组推送告警通知。

img

点击【创建】按钮，弹出创建通知规则窗口，如下图所示：

img

推送条件

当同时满足以下条件时推送告警通知：

  • 告警等级：不选择，表示所有告警等级。
  • 告警类型：不选择，表示所有告警类型。
  • 设备分组：触发告警的设备所属的分组。
  • 指定设备：触发告警的设备为指定设备时。
  • 设备标签：触发告警的设备标签满足设定的标签条件时。

通知模式

通知模式支持以下几种方式：

  • 简单通知：立即发出通知 。
  • 重复通知：立即发出通知，如果N分钟未恢复，则重新发出通知，最多通知M次。
  • 升级通知：立即发出通知，如果N分钟未恢复，则向另一个通知组发出通知。
  • 延迟通知：若告警产生N秒后仍未自动消除，则发送通知。

告警通知组 ​

告警通知组用于管理接收告警通知的用户。

当产生告警后，系统会根据推送规则向“通知组成员”推送告警通知。

可以创建多个通知组，每个通知组可以设置接收通知的方式和成员。

img

点击【创建】按钮，弹出创建通知组窗口，如下图所示：

img

钉钉机器人设置 ​

参考官方文档 创建自定义机器人获取签名密钥，安全设置请选择【加签】方式，并将用于签名的密钥复制出来。

img

点击完成，获取 Webhook 地址，已创建过的消息机器人可以参考官方文档 获取自定义机器人 Webhook 地址。Webhook 地址格式为：https://oapi.dingtalk.com/robot/send?access_token=xxxxxxxxxxxxxxxxx，红色文本的内容为认证密钥。

img

飞书机器人 ​

请参考官方文档 创建自定义机器人并获取 Webhook 地址。

飞书机器人的 Webhook 地址格式如下：https://open.feishu.cn/open-apis/bot/v2/hook/xxxxxxxxxxxxxxxxx，红色文本的内容为认证密钥。

安全设置请选择签名校验，并将用于签名的密钥复制出来。

img

企业微信机器人 ​

企业微信机器人只需要设置认证密钥，不需要签名密钥。

请参考官方文档创建消息机器人并获取 Webhook 地址。

企业微信机器人的 Webhook 地址格式如下：https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxxxxxxxxxxxxxxxx，红色文本的内容为认证密钥。

Telegram ​

Telegram（非正式简称TG或电报、纸飞机），是跨平台的即时通讯软件，支持用户相互交换加密与自毁消息，发送照片、影片等所有类型文件。官方提供手机版、桌面版和网页版等多种平台客户端。Topstack 支持通过消息机器人向 Telegram 的一个群组中发送消息通知。

使用 Telegram 发送消息通知，需要设置认证密钥和群组标识。

下面介绍下获取 Telegramp 认证密钥和群组标识的方法。

  1. 与 @BotFather 对话，发送指令 /start 开始，/newbot 申请一个新的 Bot 账号。

    图片

  2. 接着，BotFather 会要求你输入这个 Bot 的名字和 ID。创建完成后，BotFather 会同时给你一个 token，记住这个 token（这个 token 就是认证密钥）。

  3. 此时消息机器人已创建成功，接下来我们就要创建群组（Channel）用于接收消息通知，然后将把这个消息机器人（Bot）设置为 Channel 的管理员。

    图片image-20241121100437675

  4. 由于 Channel 是 private，我们需要获取这个 Channel 的 ID 来（群组标识），将 Channel 内的消息转发给 @JsonDumpBot 可以查看到 Channel ID。可以在 forward_from_chat中看到此 Channel 的 ID 是 -1001790411176，这个 Channel ID 就是我们要的群组标识。

    图片

告警记录 ​

告警引擎会根据用户设置告警规则对设备数据进行实时监测，当满足告警规则条件时会生成告警记录。TopStack 提供了告警记录查询页面，用户可以对告警记录进行检索。

image-20240726124302530