普元数据开发平台 普元数据开发平台
产品介绍
安装部署
快速入门
操作指南
SDK开发指南
FAQ
  • 告警监控
  • 新建告警策略
  • 配置项说明
  • 编辑告警策略
  • 新建告警组
  • 编辑告警组
  • 告警记录
  • 搜索

# 告警监控

当用户完成数据开发并提交调度后,即可在作业调度界面中对作业流与任务进行管理运维操作,包括对作业流的执行运行、暂停、停止、重跑、删除等操作,其他还包括查看工作流详情、任务运行历史、任务间的上下游关系、任务执行实例等功能。

告警策略:目前支持的告警策略有 Email、Http、Script、WeChat

  • 如果需要使用 Email 进行告警,请在告警配置中创建告警策略,选择 Email 插件,并配置 Email 参数。
  • 如果需要使用 Http 接口进行告警,请在告警配置中创建告警策略,选择 Http 插件,并配置接口相关参数,包括:URL、请求方式(GET、POST)、请求头、请求体、内容字段、超时时间。
  • 如果需要使用 Script 进行告警,请在告警配置中创建告警策略,选择 Script 插件,并配置 Shell 脚本文件路径(目前只支持 Shell 类型的脚本)。
  • 如果需要使用到企业微信进行告警,请在告警配置中创建告警策略,选择 WeChat 插件,并配置企业微信参数。

告警组:用户在创建告警策略时的通知条件有三个选项,成功发、失败发,以及成功和失败都发。在执行完作业流或任务时,如果触发告警,调用告警策略发送方法会进行逻辑判断,将告警策略与任务状态进行匹配,匹配则执行该告警实例发送逻辑,不匹配则过滤。创建完告警策略后,需要同告警组进行关联,一个告警组可以使用多个告警策略。

新增告警配置

告警监控的功能主要有:

  • 新建告警策略
  • 编辑告警策略
  • 新建告警组
  • 编辑告警组
  • 告警记录
  • 搜索

# 新建告警策略

点击左侧菜单"告警配置",进入告警策略管理界面,点击【新建告警策略】按钮,弹出"新建告警策略"的弹窗。按照界面向导要求录入参数。

点击【确定】,完成新建操作。

点击【取消】,取消本次新建操作。

# 配置项说明

告警策略:目前支持的告警策略有 Email、Http、Script、WeChat,不同策略的配置项不同。

  1. Email:告警配置中创建告警策略,选择 Email 插件,并配置 Email 参数。
配置项 描述
告警策略名称 策略名称。
选择插件 选择 Email,表示用发 Email 通知执行结果。
收件人 接收执行结果的收件人邮箱地址。
抄送人 接收执行结果的抄送人邮箱地址。 多个抄送人时用英文逗号 , 进行分隔。
通知条件 三个选项:成功、失败、全部。
成功:表示执行成功发通知;
失败:表示执行失败发通知;
全部:表示执行成功和失败都发通知。
SMTP服务器 SMTP服务器地址,比如:smtp.exmail.qq.com。
SMTP端口 SMTP服务器的端口,默认是:25。
用户 登录邮箱的用户名,格式如:name@company.com
密码 登录邮箱的密码。
请求认证 选择“否”时无需输入用户、密码。
发件人 登录邮箱的发件人用户名,格式如:name@company.com
STARTTLS连接 有两个选项:
YES:表示使用 TLS 协议;NO:表示不使用 TLS 协议。
在邮件传输中,SMTP是一种常用的协议。SMTP服务器默认使用明文传输,在邮件传输过程中,邮件内容可能会被窃听和篡改。
可以使用STARTLS协议来加密邮件传输,保护邮件的安全性。
SSL连接 有两个选项:
YES:表示使用 SSL 连接;NO:表示不使用 SSL 连接。
SSL证书信任 提供了一种安全的通信方式,可以确保数据在传输过程中不被截获或篡改
内容展示类型 有四种展示类型:
text:只发文本;
table:只发表格;
attachment:只发附件;
table attachment:发文本和附件。

新增告警配置

  1. Http:在告警配置中创建告警策略,选择 Http 插件,并配置接口相关参数,包括:URL、请求方式(GET、POST)、请求头、请求体、内容字段、超时时间。
配置项 描述
告警策略名称 策略名称。
选择插件 选择 Http,表示调用 Http请求来通知执行结果。
通知条件 三个选项:成功、失败、全部。
成功:表示执行成功发通知;
失败:表示执行失败发通知;
全部:表示执行成功和失败都发通知。
URL 访问的 Http 连接URL,需要包含协议、Host、路径,如果是GET方法可以添加参数。
请求方式 有两个选项:GET、POST。GET:Http告警指将告警结果作为参数通过Http GET方法进行请求。
POST:Http告警指将告警结果作为BODY参数通过HttpPOST方法进行请求。
请求头 Http 请求的完整请求头,以 JSON 为格式。
请求体 Http 请求的完整请求体,以 JSON 为格式,GET方法不需要写该参数。
内容字段 放置本次告警告警信息的字段名称。
超时时间 Http 接口的执行超时时间。

GET Http告警配置示例:

新增告警配置

POST Http告警示例:

新增告警配置

  1. Script:在告警配置中创建告警策略,选择 Script 插件,并配置 Shell 脚本文件路径(目前只支持 Shell 类型的脚本)。

提示:选择 Script 告警时,请确保 Shell 脚本具备执行权限。

配置项 描述
告警策略名称 策略名称。
选择插件 选择 Script,表示用 Shell 脚本通知执行结果。
通知条件 三个选项:成功、失败、全部。
成功:表示执行成功发通知;
失败:表示执行失败发通知;
全部:表示执行成功和失败都发通知。
自定义参数 用户自定义的参数将被传入脚本执行。
脚本路径 脚本在服务器上的文件位置,比如:/home/dws/alertShell.sh,请注意脚本的读写权限与执行租户的关系,确保该脚本具备执行权限。
类型 目前只支持 Shell 类型的脚本。

新增告警配置

  1. WeChat:在告警配置中创建告警策略,选择 WeChat 插件,并配置企业微信参数。
配置项 描述
告警策略名称 策略名称。
选择插件 选择 WeChat,表示用企业微信通知执行结果。
通知条件 三个选项:成功、失败、全部。
成功:表示执行成功发通知;
失败:表示执行失败发通知;
全部:表示执行成功和失败都发通知。
企业ID 企业微信的 ID。
密钥 企业微信的秘钥。
群员 发给全部人员时用 @all。
应用ID或群聊ID 应用ID或群聊ID。
发送类型 有两种选项:APP/应用、GROUP CHAT/群聊。
内容展示类型 有两种展示类型:
text:只发文本;
markdown:只发markdown内容。

# 编辑告警策略

点击告警策略列表右侧的【编辑】按钮,弹出"告警策略详情"的弹窗。按照界面向导要求录入参数。

编辑告警策略

# 新建告警组

点击左侧菜单"告警组",进入告警组管理界面,点击【新建告警组】按钮,弹出"新建告警组"的弹窗。按照界面向导要求录入参数。

点击【确定】,完成新建操作。

点击【取消】,取消本次新建操作。

配置项 描述
告警组名称 告警组名称。
告警组配置 创建完告警实例后,需要同告警组进行关联,一个告警组可以配置多个告警策略。
告警组描述 描述该告警组的说明。

新增告警组

# 编辑告警组

点击告警组列表右侧的【编辑】按钮,弹出"告警组详情"的弹窗。按照界面向导要求录入参数。

新增告警组

# 告警记录

点击左侧菜单"告警记录",进入告警记录界面,列出了所有告警数据。

告警记录

告警记录

# 搜索

点击告警配置、告警记录列表右上方的【高级】按钮,输入搜索条件,点击【搜索】按钮,可以按照条件完成模糊查询,点击【重置】按钮,可以清空搜索条件。

新增告警配置

← 任务监控 运维中心 →