跳到主要内容
版本: Dev

告警实例

触发告警前提条件
  1. 只适用于 FlinkSQL,FlinkJar 任务
  2. 作业为已发布状态
  3. 满足告警策略,且该告警策略关联了告警模板

目前Dinky支持的告警方式有:

  • 钉钉告警 : WebHook
  • 企业微信告警 : 包含 应用(支持配置代理url) 群聊
  • 飞书告警 : WebHook
  • 邮箱告警 : 通过邮件发送报警通知
  • 短信告警 : 通过短信发送报警通知,目前支持 阿里云短信 和 腾讯云短信
  • Http告警 : 通过Http Url 发送报警通知

报警实例列表

alert_instance_list

参数解读

公共配置项

字段说明是否必填默认值示例
名称告警实例名称,需要唯一
类型WeChat(App/群聊)
DingTalk
FeiShu
Email
Http
Sms(阿里云/腾讯云)
是否启用已启用
已禁用
注意:禁用后报警实例不能被告警组所关联, 且关联的报警组下的该实例无法发送告警信息
true

钉钉

字段说明是否必填默认值示例
WebHook 地址钉钉机器人地址
关键词自定义关键词,当创建机器人时指定了关键词策略时才生效Dinky
密令钉钉机器人密令,当创建机器人时指定了加签策略时才生效
是否启用代理是否启用代理false
代理地址代理地址,仅当启用代理时生效
代理端口代理端口,仅当启用代理时生效
用户名代理用户名,仅当启用代理时生效
密码代理密码,仅当启用代理时生效
是否@所有人是否@所有人false
手机号码手机号码,支持多个,按需添加 ,未启用@全部时必填

说明: 自定义机器人发送消息时,在“被@手机号”里面的人员收到该消息时,会有@消息提醒。

钉钉-开发者文档

企业微信

微信企业应用配置

alert_instance_wechat_app

字段说明是否必填默认值示例
发送方式发送方式,支持应用和群聊,此为 App
企业Id企业Id,需要联系管理员获取
密令应用的密令,需要联系管理员获取
代理ID代理ID,需要联系管理员获取
企微发送地址企微发送地址,默认为:https://qyapi.weixin.qq.com/cgi-bin 可以支持代理url,如:https://ip:port/cgi-bin
是否@所有人是否@所有人false
@用户当启用@所有人时,此处填写企业微信用户名,可以联系管理员获取/自行查看个人信息

说明: @所有人与被@用户可相互切换

微信企业群聊配置

create_wechat_chat_alert

字段说明是否必填默认值示例
WebHook 地址WebHook 地址
关键词自定义关键词,当创建机器人时指定了关键词策略时才生效
密令应用的密令,需要联系管理员获取
是否@所有人是否@所有人false
@用户当启用@所有人时,此处填写企业微信用户名,可以联系管理员获取/自行查看个人信息

说明: @所有人与被@用户可相互切换

其中发送方式分别对应企微文档:

应用-开发者文档
群聊-开发者文档

飞书

create_feishu_alert

字段说明是否必填默认值示例
WebHook 地址飞书机器人地址
关键词自定义关键词,当创建机器人时指定了关键词策略时才生效Dinky
密令钉钉机器人密令,当创建机器人时指定了加签策略时才生效
是否启用代理是否启用代理false
代理地址代理地址,仅当启用代理时生效
代理端口代理端口,仅当启用代理时生效
用户名代理用户名,仅当启用代理时生效
密码代理密码,仅当启用代理时生效
是否@所有人是否@所有人false
@用户当启用@所有人时,此处填写飞书用户名

说明: @所有人与被@用户可相互切换

飞书-自定义机器人接入开发文档

邮箱

字段说明是否必填默认值示例
邮箱地址邮箱地址
邮件服务器Port邮件服务器端口
发送者昵称发送者昵称
收件人邮箱收件人邮箱
抄送人邮箱抄送人邮箱
是否开启邮箱验证是否开启邮箱验证false
邮箱用户名邮箱用户名
邮箱密码邮箱密码 ,注意:部分邮箱需要自行获取授权码而非密码
开启tls证书开启tls证书false
开启SSL开启SSL证书false
受信任域如果开启了SSL,必填(一半情况和邮箱服务器保持一致即可)stmp.126.com

短信

公共配置项

字段说明是否必填默认值示例
短信服务商短信服务商,支持阿里云和腾讯云
AccessKeyIdAccessKeyId
AccessKeySecretAccessKeySecret
短信签名短信签名,阿里云可以使用默认的签名,腾讯云需要自行申请
短信模版ID短信模版ID,自行申请
权重告警权重1
重试间隔时间重试间隔时间,单位秒5
最大重试次数最大重试次数5
请求地址请求地址
阿里云使用:dysmsapi.aliyuncs.com
腾讯云使用sms.tencentcloudapi.com
阿里云使用:dysmsapi.aliyuncs.com
腾讯云使用sms.tencentcloudapi.com
地域信息地域信息,以实际情况选择
手机号码手机号码

阿里云

同 公共配置项

腾讯云

仅列出差异项

字段说明是否必填默认值示例
SdkAppIdSdkAppId
请求超时时间请求超时时间

说明: 短信服务商目前支持阿里云和腾讯云,短信模版ID需要自行在短信服务商申请,部分差异字段自行查找相关文档及其值

短信开发文档

Http

字段说明是否必填默认值示例
请求方式请求方式,支持POST
请求地址请求地址
请求头请求头 , 以列表形式填写
内容字段在http请求中,请求体(body)内被替换为告警消息的字段,如果涉及多层嵌套字段,请使用json path表达式,例如 text.markdown.content
标题字段在http请求中,请求体(body)内被替换为标题内容的字段,如果涉及多层嵌套字段,请使用json path表达式,例如 markdown.title,如果不填写,则标题默认拼接在内容字段中
请求体支持json格式