Apache DolphinScheduler Slack 告警插件配置指南从 Webhook 申请到消息发送原理【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler导读本文讲解如何在 Apache DolphinScheduler 中使用 Slack 告警插件把工作流执行失败、超时等告警事件实时推送到 Slack 频道。你将掌握从 Slack 侧创建 APP、申请 Incoming Webhooks 地址到在告警实例管理中配置插件参数再到理解插件底层发送逻辑参数校验、Markdown 表格转换、HTTP 重试的完整链路实现可落地的 Slack 告警接入方案。一、前置说明告警实例与插件的关系DolphinScheduler 的告警功能采用插件化设计Slack 是众多告警插件之一与钉钉、飞书、企业微信、Telegram 等并列。要使用 Slack 告警需在告警实例管理中创建一条告警实例并在插件下拉框中选择Slack填写相应配置。从源码结构看Slack 插件位于 dolphinscheduler-alert-slack 模块其pom.xml中通过plugin.namealert.slack/plugin.name声明插件标识并在打包时使用 maven-shade-plugin 生成独立可加载的插件 JAR。插件工厂类 SlackAlertChannelFactory.java 通过AutoService(AlertChannelFactory.class)注解实现自动注册使告警服务能够通过名称Slack发现并实例化该插件。注意不同 DolphinScheduler 版本的 UI 布局可能略有差异以下界面步骤以仓库docs/img/new_ui/dev/alert/目录中的截图为准。二、参数配置说明在告警实例管理中选择 Slack 插件后需要配置以下两个参数参数是否必填说明Webhook必填复制 Slack APP 的Incoming Webhooks地址填入形如https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX用户名Username必填发送人昵称已过时。由于 Slack 平台更新目前实际会使用 APP 名称作为发件人显示关于这两个参数的细节可以结合插件工厂与常量定义进一步确认在 SlackAlertChannelFactory.java 的params()方法中两个输入参数均被标记为setRequired(true)即 Webhook 与用户名在 UI 上都为必填项SlackParamsConstants.java 定义了这两个参数的内部 keywebHook与username分别对应界面上的$t(webhook)和$t(Username)在发送端 SlackSender.java 的构造函数中还会对参数做二次校验Webhook 为空、或地址不以https://hooks.slack.com/services/开头Preconditions.checkArgument抛出异常以及 botName 为空都会导致发送器构建失败。因此填错格式的 Webhook 地址将直接无法完成配置校验。三、如何获取 Webhook 地址Slack 的 Incoming Webhooks 是 Slack 官方提供的“入站消息”能力你不需要维护一个常驻的 Slack 机器人只需一个 URL即可把 JSON 格式的消息 POST 到指定频道。完整创建流程如下请参考 Slack 官方关于 Incoming Webhooks 的文档进行操作。3.1 新建一个 Slack APP打开 Slack API 的应用创建入口https://api.slack.com/apps/new新建一个 APP。这个 APP 将作为告警消息的发送主体其 APP 名称最终会显示为消息的发件人。3.2 激活 Incoming Webhooks 设置APP 创建完成后进入 APP 管理页面在左侧Feature功能栏目下找到Incoming Webhooks点击Activate Incoming Webhooks将其切换为ON开启。未激活前页面上不会出现新增 Webhook 的入口。3.3 创建一个 Incoming Webhook激活功能后点击Add New Webhook to Workspace创建一个新的 Incoming Webhook并选择该 Webhook 消息将要发送到的**频道Channel**或私聊会话。可以为一个 APP 创建多个 Webhook分别投递到不同频道。3.4 获取 Incoming Webhooks 地址创建完成后页面会显示该 Webhook 的 URL将其复制出来填入 DolphinScheduler 告警实例的 Webhook 字段即可。Incoming Webhooks地址的典型格式为https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX其中T...为工作区Workspace标识B...为机器人Bot标识末尾为访问令牌。该 URL 具备发送权限等同于凭据请妥善保管不要提交到公共仓库或泄露到日志中。四、告警消息发送的源码级原理配置完成后告警消息是如何从 DolphinScheduler 到达 Slack 频道的下面结合插件源码拆解整条调用链。4.1 告警入口SlackAlertChannel.process告警服务在触发告警时会调用 SlackAlertChannel.java 的process(AlertInfo)方法从AlertInfo中取出告警数据标题title、内容content与告警实例参数alertParams若参数为空直接返回失败结果Slack alert params is empty否则以参数构建SlackSender调用sendMessage(title, content)发送将 Slack 返回的响应与字符串ok比对ok.equals(response)一致则判定告警发送成功。4.2 发送核心SlackSender 的实现要点SlackSender.java 负责实际的 HTTP 请求几个关键实现细节值得注意请求方式使用 Apache HttpClient 构造HttpPost请求请求体为 JSONtext字段为标题attachments字段承载正文并以 UTF-8 编码发送到 Webhook 地址重试机制HttpClient 通过HttpServiceRetryStrategy.retryStrategy来自 alert-api 模块的dolphinscheduler.alert.api.HttpServiceRetryStrategy设置重试策略在 HTTP 请求失败时会按策略自动重试增强弱网环境下的投递可靠性异常兜底发送过程发生异常时记录 error 日志并返回字符串System Exception该返回值不会与ok相等因此上层会把异常场景判定为发送失败。4.3 结构化内容的 Markdown 表格转换Slack 的 Webhook 消息原生不支持表格展示而 DolphinScheduler 的部分告警内容如 SQL 查询结果是 JSON 数组结构。为此SlackSender.java 实现了generateMarkDownTable方法将内容按LinkedHashMap列表解析若行数超过MAX_SHOW_NUMBER 100见 SlackParamsConstants.java只截取前 100 行防止消息过长根据所有字段名与单元格值的最大长度进行等宽对齐构造带表头、分隔行与数据行的纯文本表格最终用一对包裹代码块样式放入 attachments 的 text 字段保证对齐效果在 Slack 客户端中完整呈现。也就是说当告警内容为 JSON 数组时Slack 频道里会收到排版工整的 Markdown 表格当内容为空时则只发送标题正文不附加表格。4.4 插件参数与校验的自动化测试佐证仓库中配套的单元测试可以佐证上述行为SlackAlertChannelFactoryTest.java 验证了插件名称固定为Slack、参数数量恰好为 2Webhook 与用户名且create()返回的确实是SlackAlertChannel实例SlackSenderTest.java 用示例 Webhook 地址https://hooks.slack.com/services/123456与Dolphinscheduler作为 botName 构造发送器并发起发送并断言返回结果不为ok测试环境无真实 Slack 服务属预期失败用于验证发送链路可正常走通。五、常见问题排查现象可能原因与处理建议告警实例保存时报参数校验错误Webhook 地址为空或地址不以https://hooks.slack.com/services/开头请重新复制 Slack 后台生成的完整地址告警记录显示发送失败非ok响应Webhook 已失效如 APP 被删除、频道被移除检查 Slack 后台该 Webhook 是否仍然有效发送报System Exception网络无法访问hooks.slack.com如代理、防火墙拦截或 Slack 服务不可用确认网络可达后重试插件内置的 HTTP 重试策略也会在部分失败场景下自动重试收到的消息发件人名称与配置的用户名不一致属于已知行为Slack 平台已改用 APP 名称作为发件人用户名参数已过时无需过度关注六、小结至此你已经可以完成 Slack 告警在 Apache DolphinScheduler 中的全流程接入在 Slack 侧创建 APP 并申请 Incoming Webhooks 地址在告警实例管理中创建 Slack 类型实例并填写 Webhook 与用户名随后将告警实例绑定到工作流或任务上即可在失败、超时等场景收到 Slack 通知。更进一步你还可以结合插件源码理解其参数校验、Markdown 表格转换与 HTTP 重试的实现细节便于在遇到问题时快速定位。相关参考路径插件源码dolphinscheduler-alert-slack插件测试dolphinscheduler-alert-slack/src/test界面截图docs/img/new_ui/dev/alert【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Apache DolphinScheduler Slack 告警插件配置指南：从 Webhook 申请到消息发送原理
Apache DolphinScheduler Slack 告警插件配置指南从 Webhook 申请到消息发送原理【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler导读本文讲解如何在 Apache DolphinScheduler 中使用 Slack 告警插件把工作流执行失败、超时等告警事件实时推送到 Slack 频道。你将掌握从 Slack 侧创建 APP、申请 Incoming Webhooks 地址到在告警实例管理中配置插件参数再到理解插件底层发送逻辑参数校验、Markdown 表格转换、HTTP 重试的完整链路实现可落地的 Slack 告警接入方案。一、前置说明告警实例与插件的关系DolphinScheduler 的告警功能采用插件化设计Slack 是众多告警插件之一与钉钉、飞书、企业微信、Telegram 等并列。要使用 Slack 告警需在告警实例管理中创建一条告警实例并在插件下拉框中选择Slack填写相应配置。从源码结构看Slack 插件位于 dolphinscheduler-alert-slack 模块其pom.xml中通过plugin.namealert.slack/plugin.name声明插件标识并在打包时使用 maven-shade-plugin 生成独立可加载的插件 JAR。插件工厂类 SlackAlertChannelFactory.java 通过AutoService(AlertChannelFactory.class)注解实现自动注册使告警服务能够通过名称Slack发现并实例化该插件。注意不同 DolphinScheduler 版本的 UI 布局可能略有差异以下界面步骤以仓库docs/img/new_ui/dev/alert/目录中的截图为准。二、参数配置说明在告警实例管理中选择 Slack 插件后需要配置以下两个参数参数是否必填说明Webhook必填复制 Slack APP 的Incoming Webhooks地址填入形如https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX用户名Username必填发送人昵称已过时。由于 Slack 平台更新目前实际会使用 APP 名称作为发件人显示关于这两个参数的细节可以结合插件工厂与常量定义进一步确认在 SlackAlertChannelFactory.java 的params()方法中两个输入参数均被标记为setRequired(true)即 Webhook 与用户名在 UI 上都为必填项SlackParamsConstants.java 定义了这两个参数的内部 keywebHook与username分别对应界面上的$t(webhook)和$t(Username)在发送端 SlackSender.java 的构造函数中还会对参数做二次校验Webhook 为空、或地址不以https://hooks.slack.com/services/开头Preconditions.checkArgument抛出异常以及 botName 为空都会导致发送器构建失败。因此填错格式的 Webhook 地址将直接无法完成配置校验。三、如何获取 Webhook 地址Slack 的 Incoming Webhooks 是 Slack 官方提供的“入站消息”能力你不需要维护一个常驻的 Slack 机器人只需一个 URL即可把 JSON 格式的消息 POST 到指定频道。完整创建流程如下请参考 Slack 官方关于 Incoming Webhooks 的文档进行操作。3.1 新建一个 Slack APP打开 Slack API 的应用创建入口https://api.slack.com/apps/new新建一个 APP。这个 APP 将作为告警消息的发送主体其 APP 名称最终会显示为消息的发件人。3.2 激活 Incoming Webhooks 设置APP 创建完成后进入 APP 管理页面在左侧Feature功能栏目下找到Incoming Webhooks点击Activate Incoming Webhooks将其切换为ON开启。未激活前页面上不会出现新增 Webhook 的入口。3.3 创建一个 Incoming Webhook激活功能后点击Add New Webhook to Workspace创建一个新的 Incoming Webhook并选择该 Webhook 消息将要发送到的**频道Channel**或私聊会话。可以为一个 APP 创建多个 Webhook分别投递到不同频道。3.4 获取 Incoming Webhooks 地址创建完成后页面会显示该 Webhook 的 URL将其复制出来填入 DolphinScheduler 告警实例的 Webhook 字段即可。Incoming Webhooks地址的典型格式为https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX其中T...为工作区Workspace标识B...为机器人Bot标识末尾为访问令牌。该 URL 具备发送权限等同于凭据请妥善保管不要提交到公共仓库或泄露到日志中。四、告警消息发送的源码级原理配置完成后告警消息是如何从 DolphinScheduler 到达 Slack 频道的下面结合插件源码拆解整条调用链。4.1 告警入口SlackAlertChannel.process告警服务在触发告警时会调用 SlackAlertChannel.java 的process(AlertInfo)方法从AlertInfo中取出告警数据标题title、内容content与告警实例参数alertParams若参数为空直接返回失败结果Slack alert params is empty否则以参数构建SlackSender调用sendMessage(title, content)发送将 Slack 返回的响应与字符串ok比对ok.equals(response)一致则判定告警发送成功。4.2 发送核心SlackSender 的实现要点SlackSender.java 负责实际的 HTTP 请求几个关键实现细节值得注意请求方式使用 Apache HttpClient 构造HttpPost请求请求体为 JSONtext字段为标题attachments字段承载正文并以 UTF-8 编码发送到 Webhook 地址重试机制HttpClient 通过HttpServiceRetryStrategy.retryStrategy来自 alert-api 模块的dolphinscheduler.alert.api.HttpServiceRetryStrategy设置重试策略在 HTTP 请求失败时会按策略自动重试增强弱网环境下的投递可靠性异常兜底发送过程发生异常时记录 error 日志并返回字符串System Exception该返回值不会与ok相等因此上层会把异常场景判定为发送失败。4.3 结构化内容的 Markdown 表格转换Slack 的 Webhook 消息原生不支持表格展示而 DolphinScheduler 的部分告警内容如 SQL 查询结果是 JSON 数组结构。为此SlackSender.java 实现了generateMarkDownTable方法将内容按LinkedHashMap列表解析若行数超过MAX_SHOW_NUMBER 100见 SlackParamsConstants.java只截取前 100 行防止消息过长根据所有字段名与单元格值的最大长度进行等宽对齐构造带表头、分隔行与数据行的纯文本表格最终用一对包裹代码块样式放入 attachments 的 text 字段保证对齐效果在 Slack 客户端中完整呈现。也就是说当告警内容为 JSON 数组时Slack 频道里会收到排版工整的 Markdown 表格当内容为空时则只发送标题正文不附加表格。4.4 插件参数与校验的自动化测试佐证仓库中配套的单元测试可以佐证上述行为SlackAlertChannelFactoryTest.java 验证了插件名称固定为Slack、参数数量恰好为 2Webhook 与用户名且create()返回的确实是SlackAlertChannel实例SlackSenderTest.java 用示例 Webhook 地址https://hooks.slack.com/services/123456与Dolphinscheduler作为 botName 构造发送器并发起发送并断言返回结果不为ok测试环境无真实 Slack 服务属预期失败用于验证发送链路可正常走通。五、常见问题排查现象可能原因与处理建议告警实例保存时报参数校验错误Webhook 地址为空或地址不以https://hooks.slack.com/services/开头请重新复制 Slack 后台生成的完整地址告警记录显示发送失败非ok响应Webhook 已失效如 APP 被删除、频道被移除检查 Slack 后台该 Webhook 是否仍然有效发送报System Exception网络无法访问hooks.slack.com如代理、防火墙拦截或 Slack 服务不可用确认网络可达后重试插件内置的 HTTP 重试策略也会在部分失败场景下自动重试收到的消息发件人名称与配置的用户名不一致属于已知行为Slack 平台已改用 APP 名称作为发件人用户名参数已过时无需过度关注六、小结至此你已经可以完成 Slack 告警在 Apache DolphinScheduler 中的全流程接入在 Slack 侧创建 APP 并申请 Incoming Webhooks 地址在告警实例管理中创建 Slack 类型实例并填写 Webhook 与用户名随后将告警实例绑定到工作流或任务上即可在失败、超时等场景收到 Slack 通知。更进一步你还可以结合插件源码理解其参数校验、Markdown 表格转换与 HTTP 重试的实现细节便于在遇到问题时快速定位。相关参考路径插件源码dolphinscheduler-alert-slack插件测试dolphinscheduler-alert-slack/src/test界面截图docs/img/new_ui/dev/alert【免费下载链接】dolphinschedulerApache DolphinScheduler is the modern data orchestration platform. Agile to create high performance workflow with low-code项目地址: https://gitcode.com/GitHub_Trending/dol/dolphinscheduler创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考