Skip to content

指标预警

应用指标预警功能,用于监控应用中图表的指标,当指标达到阈值条件时通知用户,让用户及时感知业务指标变化情况,调整业务策略。指标预警支持设置多条预警, 每条预警可自定义检测时间及预警频率。预警可通过邮件和 Webhook 两种方式通知用户。目前该功能在应用发布态下暂不开放。租户场景也支持指标预警,并且可以对平台方分享的应用设置指标预警。

设置指标预警

按下面的操作指导建立指标预警。

1.在指标预警界面,点击新建预警。

2.填写预警名称和预警条件。 选择预警指标所在的图表,设置预警规则。 每个图表可以设置多个预警规则,可以选择预警规则触发条件,设置满足任一规则时触发预警或满足全部规则时触发预警。

3.设置预警触发时间。

  • 设置指标检测频率,可按小时、天、周、月检测,也可以自定义检测频率。
  • 通知设定指当达到预警条件时通知用户次数,通知一次和一直通知。通知一次表示本次检测指标符合预警条件时通知用户,如果下次检测指标时还满足预警条件,则不通知用户。一直通知表示只要检测到指标符合预警条件就通知用户。
  • 异常处理指当检测任务发生异常时的任务处理情况,可以设置失败重试和失败暂停。失败重试表示任务失败后重新发起任务,根据重试间隔和重试次数来重启任务。失败暂停表示任务失败达到一定次数后,暂停该任务,并通知应用所有者。

模板变量

支持在消息内容的正文以及标题使用模板变量。

例子:

text
这是临时预警消息{{%%system.dashboard.url}}
支持的模板变量
变量名描述
system.app.title应用标题
system.app.url应用链接
system.today当前日期
system.app.share.url.pwd应用启用公开链接时,并且开启了需要访问密码选项时,将会使用公开链接的访问密码覆盖该模板变量。若是未开启公开链接、或者未开启需要访问密码,并且同时使用了该模板变量,那么将以提示文本替代
system.dashboard.title仪表盘标题
system.chart.title图表标题
system.alert.title预警条目标题
system.chart.data图表预览数据
仅Webhook推送方式支持的模板变量
变量名描述
system.dashboard.url仪表盘标题与仪表盘链接的组合文本

选择用户

飞书、钉钉、企业微信推送方式在选择系统内用户时,用户选择界面将会展示用户是否绑定了对应第三方应用的账号。

选择的系统内用户如果没有绑定对应第三方应用账号,任务执行时,将跳过该用户。用户组与组织架构中未绑定对应第三方应用账号的行为同上。

邮件通知

邮件通知是以邮件的形式通知仪表盘相关业务信息,在使用邮件通知时请先确认配置了SMTP服务。

  • 选择用户:填写邮件通知的系统用户。
  • 其他邮件地址:当收件人不是系统用户时,填写收件人邮箱地址。
  • 邮件内容:包括邮件标题、邮件正文、选择仪表盘。 邮件内容支持自定义纯文本、支持系统参数、应用参数和用户属性。
    • 系统参数有应用名称、应用 URL 和邮件推送日期。
    • 应用参数
    • 用户属性 下面示例展示使用各种参数及用户属性书写的邮件内容及邮件发送时的情况。
  • 高级配置:使用预警创建者的身份导出数据并生成消息内容、支持正文预览仪表盘图片、正文附加仪表盘链接、附加仪表盘数据(仪表盘分析的结果数据,以文件形式展示于邮件附件)。
  • 特殊配置:当邮件内容过大时发送提示邮件。

企业微信

企业微信方式是以企业微信消息的形式通知用户,并且支持在消息中添加仪表盘信息。 企业微信方式开启前需要在认证方式中进行令牌信息配置,请联系系统管理员进行配置(配置一次即可),否则会影响功能使用。

使用企业微信方式时,需要配置以下内容,包括:

  • 消息标题:必填,不超过100个字,支持使用参数信息。
  • 选择用户:选填, 选择系统内的用户。
  • 填写其他成员:选填,手动填写企业微信内用户的用户 id,支持输入多个用户,使用英文逗号隔开。企业微信userid 获取教程:教程链接
  • 消息内容:系统默认发送了固定的消息内容,支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
  • 高级配置:可以在消息中附加仪表盘快照图片和仪表盘链接等。

系统内用户、其他成员至少有一项不能为空。

飞书

飞书方式是在飞书 app 中以消息的形式通知用户,并且支持在消息中添加仪表盘信息。飞书方式开启前需要在认证方式 中进行令牌信息配置,请联系系统管理员进行配置(配置一次即可),否则会影响功能使用。

使用飞书方式时,需要配置以下内容,包括:

  • 消息标题:必填,不超过100个字,支持使用参数信息。
  • 选择用户:选填, 选择系统内的用户。
  • 填写其他成员:选填,手动填写飞书内用户的用户 id,支持输入多个用户,使用英文逗号隔开。飞书user_id 获取教程:教程链接
  • 消息内容:系统默认发送了固定的消息内容,支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
  • 高级配置:可以在消息中附加仪表盘快照图片和仪表盘链接。
  1. 系统内用户、其他成员至少有一项不能为空。
  2. 飞书的用户 id 存在三种类型,手动输入的user_id,需要类型是user_id的用户 id。如果用户 id 类型错误,将会导致推送结果出现异常。

钉钉

钉钉方式是在钉钉 app 中以消息的形式通知用户,并且支持在消息中添加仪表盘信息。钉钉方式开启前需要在认证方式 中进行令牌信息配置,请联系系统管理员进行配置(配置一次即可),否则会影响功能使用。

钉钉推送,除了认证所需的配置之外,还需要配置AgentId。

使用钉钉方式时,需要配置以下内容,包括:

  • 消息标题:必填,不超过100个字,支持使用参数信息。
  • 选择用户:选填, 选择系统内的用户。
  • 填写其他成员:选填,手动填写钉钉内用户的用户 id,支持输入多个用户,使用英文逗号隔开。钉钉userid 获取教程:教程链接
  • 消息内容:系统默认发送了固定的消息内容,支持用户自定义消息内容。自定义纯文本、支持系统参数、应用参数和用户属性。
  • 高级配置:可以在消息中附加仪表盘快照图片和仪表盘链接。
  1. 系统内用户、其他成员至少有一项不能为空。
  2. 由于钉钉消息限制,钉钉的附带仪表盘链接功能最多只能附带 6 个仪表盘的链接,若超出 6 个仪表盘,将在推送消息中附带提示内容。
  3. 由于钉钉消息限制,钉钉的消息中附加仪表盘快照图片功能最多只能附带 1 个仪表盘的图片,若在勾选该功能时,选择的仪表盘超出了 1 个,将在推送消息中附带提示内容。

Webhook

使用 Webhook 时,用户需要自定义消息请求方式及请求内容。

  • URL:系统向对应的 HTTP 地址发送请求,URL 后面可以拼接参数。
  • 请求方式:支持 GET、POST、PUT、DELETE 四种方式。
  • 请求头部和请求体:根据预警内容填写请求头部和请求体,请求头部和请求体中都可以携带预警信息。 示例中使用 POST 方式发送消息,在请求体中填写预警内容,通知用户处理。GET 方式的请求仅包含请求头部。

衡石分析平台使用手册