Zulip Rundeck 集成实时接收作业执行状态通知的完整指南【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip本篇指南讲解如何在 Zulip 中接入 Rundeck 入站 Webhook 集成将 Rundeck 作业Job的启动、成功、失败与超时执行等状态通知实时推送到 Zulip 的指定主题Topic中。读完本文你将掌握从 Rundeck 界面配置 Webhook、理解消息渲染规则主题与正文的生成逻辑、验证端到端链路的完整方法并能读懂该集成的源码实现与测试用例。Rundeck 集成概览Rundeck 是面向运维场景的作业调度与自动化平台。通过本仓库自带的rundeck入站 Webhook 集成Rundeck 可以在作业执行的各个关键节点主动向 Zulip 推送一条结构化通知消息让团队成员无需登录 Rundeck 即可在 Zulip 中看到作业执行进度例如[Global Log Filter Usage](http://localhost:4440/project/welcome-project-community/job/show/...) execution #3 for welcome-project-community has started. :running:该集成以rundeck为标识在 Zulip 的集成注册表中注册见 zerver/lib/integrations.py归类于deployment部署类目用于辅助运维监控场景。消息由名为Rundeck的机器人账号发送通知会进入你预先指定的流Stream并按 Rundeck 作业名自动聚合到对应主题中。准备工作创建入站 Webhook在开始配置 Rundeck 之前需要先在 Zulip 中为 Rundeck 创建一个专用的入站 Webhook 机器人以获取调用凭据。登录 Zulip Web 界面进入**设置Settings**页面。依次进入Personal settings → Bots → Add a new bot。选择Incoming webhook作为机器人类型为其填写名称如Rundeck bot并选择接收通知的默认流。创建完成后复制页面展示的Bot API key。之后需要生成集成专用的 Webhook URL。Zulip 入站 Webhook 的通用 URL 格式为http://myhost/api/v1/external/rundeck?api_keyabcdefghstreamalertstopicqueries其中http://myhost是你的 Zulip 服务器地址rundeck为集成标识符对应仓库中的rundeckWebhook 模块api_key为上一步创建的 Incoming webhook 机器人密钥用于身份认证stream与topic为可选查询参数用于指定消息发送的目标流与主题若省略则使用机器人创建时绑定的默认流与主题。说明URL 中stream、topic的解析由typed_endpoint机制自动完成无需在集成视图代码中单独处理详见 docs/webhooks/incoming-webhooks-reference.md。在 Rundeck 中配置作业通知配置好 Zulip 侧的 Webhook URL 后接下来在 Rundeck Web 界面中将该 URL 挂接到具体作业的事件通知上登录你的 Rundeck Web 界面点击目标作业Job。点击Actions选择Edit this Job编辑该作业。切换到Notifications通知标签页。针对你想要接收通知的事件如作业启动、成功、失败等点击Add Notification添加通知。在通知类型中选择Send Webhook发送 Webhook将上一步生成好的 URL 粘贴到地址栏。关键参数确保 Payload 格式为JSON请求方法为POST然后点击Save保存。至此配置完成。当该作业发生已绑定的事件时Rundeck 会以 POST 方式向 Zulip 的/api/v1/external/rundeck端点发送 JSON 负载Zulip 随即在对应流/主题中生成通知消息。配置成功后的效果如下图所示Rundeck 机器人会在目标主题中发布一条包含作业链接与执行状态的富文本消息消息渲染规则主题与正文的生成逻辑Rundeck 集成接收到负载后会将其解析为“主题topic 正文body”两部分再发送。这一逻辑完整实现在 zerver/webhooks/rundeck/view.py具体由两个核心模板决定RUNDECK_MESSAGE_TEMPLATE {job_name} execution #{execution_id} for {project_name} {status}. :{emoji}: RUNDECK_TOPIC_TEMPLATE {job_name}主题Topic以作业名聚合主题直接取负载中的作业名称def get_topic(payload: WildValue) - str: return RUNDECK_TOPIC_TEMPLATE.format( job_namepayload[execution][job][name].tame(check_string) )这意味着同一 Rundeck 作业的所有状态通知启动、成功、失败、超时都会聚合到 Zulip 中同一个主题下形成一条连续的执行时间线不同作业则自动分流到各自主题互不干扰。正文Body四类状态的语义化渲染正文渲染函数get_body从负载中提取作业名、作业链接、执行 ID、执行链接、项目名与状态再根据状态值对文案进行语义化润色Rundeck 状态 (execution.status)触发场景Zulip 消息中的文案表情符号runningtriggerstart作业开始执行has started:running:runningtriggeravgduration作业执行超过平均时长is running long:time_ticking:scheduled作业已排程并开始has started:running:succeeded作业执行成功has succeeded:check:failed作业执行失败has failed:cross_mark:对应的源码分支如下if status failed: message_data[status] has failed message_data[emoji] cross_mark if status succeeded: message_data[status] has succeeded message_data[emoji] check if status running: if payload[trigger].tame(check_string) avgduration: message_data[status] is running long message_data[emoji] time_ticking else: message_data[status] has started message_data[emoji] running if status scheduled: message_data[status] has started message_data[emoji] running其中值得注意的两点设计超时告警running状态配合triggeravgduration时消息文案变为is running long并附带:time_ticking:表情用于提示作业执行时长已超过其平均时长对应负载中的execution.job.averageDuration字段消息即链接作业名与执行 ID 分别链接到 Rundeck 的作业详情页job.permalink与执行详情页execution.href团队成员可直接点击跳转排查无需在消息中堆砌长 URL。负载结构Rundeck 实际发送的 JSON 示例集成视图通过payload[execution][...]与payload[trigger]读取字段因此 Rundeck 发送的 JSON 负载必须包含这些层级。仓库中的 5 个 fixture 文件提供了真实负载样本位于 zerver/webhooks/rundeck/fixtures/start.json作业启动triggerstartstatusrunningsuccess.json作业成功statussucceededfailure.json作业失败statusfailedduration.json作业超时triggeravgdurationstatusrunningscheduled_start.json排程作业启动statusscheduled以start.json为例负载核心结构如下节选{ trigger: start, status: running, executionId: 3, execution: { id: 3, href: http://localhost:4440/project/welcome-project-community/execution/show/3, status: running, project: welcome-project-community, executionType: user, user: admin, date-started: { unixtime: 1680847933368, date: 2023-04-07T06:12:13Z }, job: { id: a0296d93-4b10-48d7-8b7d-86ad3f603b85, averageDuration: 2354, name: Global Log Filter Usage, group: Basic Examples/Basic Workflows, project: welcome-project-community, href: http://localhost:4440/api/42/job/a0296d93-4b10-48d7-8b7d-86ad3f603b85, permalink: http://localhost:4440/project/welcome-project-community/job/show/a0296d93-4b10-48d7-8b7d-86ad3f603b85 }, description: env (Using env command we can extract a lot of keys/values :-)) [... 2 steps], serverUUID: a14bc3e6-75e8-4fe4-a90d-a16dcc976bf6 } }集成视图实际消费的字段包括trigger顶层触发类型用于区分start与avgduration场景execution.id执行 ID整型渲染为#{execution_id}execution.href执行详情页链接execution.status执行状态字符串running/scheduled/succeeded/failedexecution.project所属项目名execution.job.name作业名同时用于主题与正文execution.job.permalink作业详情页链接。所有字段在 view.py 中通过tame(check_string)/tame(check_int)做类型校验字符串字段必须存在且为字符串、execution.id必须为整数否则请求会被拒绝。端到端验证测试用例与手工测试自动化测试仓库为该集成编写了完整的测试套件位于 zerver/webhooks/rundeck/tests.py。测试类RundeckHookTests继承自WebhookTestCase覆盖 5 种负载场景并通过content_typeapplication/x-www-form-urlencoded模拟 Rundeck 的 POST 请求。例如成功场景的期望消息为expected_message [Global Log Filter Usage](http://localhost:4440/project/welcome-project-community/job/show/a0296d93-4b10-48d7-8b7d-86ad3f603b85) execution [#3](http://localhost:4440/project/welcome-project-community/execution/show/3) for welcome-project-community has succeeded. :check:而scheduled_start场景则验证了排程作业statusscheduled的渲染期望消息为[Global Log Filter Usage](https://rundeck.com/project/myproject/job/show/a0296d93-4b10-48d7-8b7d-86ad3f603b85) execution [#12](https://rundeck.com/project/myproject/execution/follow/12) for myproject has started. :running:注意该场景中execution.href指向execution/follow/12执行跟踪页且所有测试的主题均为作业名Global Log Filter Usage印证了“同作业同主题”的聚合行为。手工验证配置完成后可在 Rundeck 中手动运行一次作业然后在 Zulip 的目标流中检查是否出现 Rundeck 机器人发送的消息主题是否为作业名正文是否包含作业名、执行编号与项目名且状态文案与表情符号符合上表作业名与执行编号是否可点击跳转到 Rundeck 对应页面。若未收到消息请依次检查Webhook URL 中api_key是否正确、Rundeck 通知事件是否勾选、Payload 格式是否为 JSON、请求方法是否为 POST以及 Zulip 服务器日志中是否出现/api/v1/external/rundeck的请求记录正常成功返回200。小结Zulip 的 Rundeck 集成以极低的配置成本打通了「作业调度系统 → 团队聊天」的通知链路接入简单仅需在 Zulip 创建 Incoming webhook 机器人再在 Rundeck 作业通知中选择 Send Webhook 并填入 JSON POST 的 URL信息密度高一条消息即包含作业名、执行编号、项目名、状态及两级跳转链接语义清晰通过:running:、:check:、:cross_mark:、:time_ticking:四种表情符号让状态一目了然超时场景还有专门的is running long文案便于追溯同作业通知自动聚合到同一主题配合 view.py 中模板与 tests.py 中的期望消息任何状态的渲染行为都清晰可查。如果你希望进一步了解 Zulip 入站 Webhook 的通用 URL 规范与开发模式可参阅 docs/webhooks/incoming-webhooks-reference.md若想从零实现一个类似的 Webhook 集成docs/webhooks/incoming-webhooks-walkthrough.md 提供了完整的开发演练。【免费下载链接】zulipZulip server and web application. Open-source team chat that helps teams stay productive and focused.项目地址: https://gitcode.com/GitHub_Trending/zu/zulip创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考