Skip to content

高级配置

1. Webhook 端点模式

添加机器人时,插件支持两种 Webhook 地址配置方式:

模式说明适用场景
平台默认模式选择平台后只输入 TokenKey,插件自动拼接官方 Webhook官方 SaaS 地址,优先推荐
自定义 Webhook直接粘贴完整 Webhook URL已拿到完整地址、使用私有域名、历史配置迁移

选择平台后,机器人编辑器会自动切换输入提示、预览最终 Webhook,并记录对应协议类型。

TIP

Lark / 飞书 支持自定义域名,只要 Webhook 路径仍为 /open-apis/bot/v2/hook/{token}

不同平台的默认输入内容如下:

平台默认输入值自动拼接结果
Lark / 飞书机器人 Tokenhttps://open.larksuite.com/open-apis/bot/v2/hook/{token}https://open.feishu.cn/open-apis/bot/v2/hook/{token}
钉钉机器人 access_tokenhttps://oapi.dingtalk.com/robot/send?access_token={token}
企业微信群机器人 keyhttps://qyapi.weixin.qq.com/cgi-bin/webhook/send?key={key}

2. 安全策略

每个机器人都可配置以下安全策略:

策略说明
关键词(KEY)设定后,只有包含关键词的消息内容才会被正常发送,多个值使用逗号分隔。
签名密钥(SECRET)使用 HMAC-SHA256 对消息进行签名验证。需在机器人安全设置中获取密钥。
禁用 SSL 验证(NO_SSL)禁用 Java HTTP 客户端中的 SSL/TLS 证书验证。

NOTE

企业微信群机器人本身没有飞书 / 钉钉那种签名验签流程,但插件仍支持关键词校验与 SSL 控制等通用策略。

WARNING

禁用 SSL 验证会降低连接的安全性,可能导致中间人攻击等安全风险。建议仅在受控测试环境中使用此选项。

3. 重试配置

插件支持对发送失败的 Webhook 消息进行重试,每个机器人可单独配置。默认不开启。

字段类型默认值说明
enabledbooleanfalse是否启用重试
maxAttemptsint1最大尝试次数(包含首次发送)
initialDelayMslong500首次重试前的等待时间(毫秒)
maxDelayMslong5000重试等待时间上限(毫秒)
backoffMultiplierdouble2.0退避倍数(必须 >= 1.0)
jitterRatiodouble0.2等待时间抖动比例(0.0 ~ 1.0)

重试采用指数退避策略,每次重试的等待时间 = 上次等待 × backoffMultiplier,并叠加随机抖动以避免请求风暴。

高级选项(initialDelayMsmaxDelayMsbackoffMultiplierjitterRatio)默认折叠,点击「高级」可展开配置。

4. 消息语言

每个机器人可独立设置消息语言,影响内置卡片标题和默认模板的显示语言。

选项说明
中文使用简体中文显示内置消息
EN使用英文显示内置消息

NOTE

仅影响内置卡片标题与默认模板,自定义消息内容不做翻译。

4.1 平台消息能力差异

虽然插件对外统一暴露了消息模式,但不同平台底层支持能力并不完全相同:

平台重点支持
Lark / 飞书TEXTIMAGESHARE_CHATPOSTMARKDOWNCARD,以及 Freestyle 自定义 JSON 卡片
钉钉TEXTLINKMARKDOWNCARD
企业微信TEXTMARKDOWNCARD

企业微信的补充说明:

  • Freestyle 下更推荐使用默认卡片模式;如需精确控制消息结构,优先使用 PipelinewechatWork 步骤。
  • Pipeline 中传入 LINKPOST 时,插件会按 MARKDOWN 发送。
  • IMAGE 不是企业微信独立支持的消息类型;需要图片时,优先使用卡片 picUrltopImg.imgKey 中的外部图片 URL。
  • 企业微信卡片使用 template_card.news_notice 模板,不是飞书那种自由结构卡片。
  • 企业微信卡片图片需要可直接访问的 http/https 地址;如果未提供可用图片地址,插件会回退到默认 Jenkins 图片。
  • 企业微信卡片最多展示 3 个跳转按钮。

5. 代理配置

当 Jenkins 无法直连机器人 Webhook 地址时,可在全局配置中设置网络代理。

字段说明
enabled是否启用代理
type代理类型:HTTPSOCKS
host代理服务主机,如 127.0.0.1
port代理服务端口,如 1080

代理配置位于 Manage Jenkins -> Lark NoticeSystem Configuration 页面中的 代理 区域。

6. 详细日志

在全局配置的「日志」区域,可开启 启用详细日志 选项。

开启后,插件会在 Jenkins 系统日志中输出更详细的请求和响应信息,适用于排查消息发送失败等问题。

TIP

排查完毕后建议关闭详细日志,避免日志量过大。

7. 通知触发时机

在全局配置中可设置默认的通知触发时机,同时每个任务也可单独覆盖。

时机说明
构建开始(START)构建启动时触发
构建成功(SUCCESS)构建成功完成时触发
构建失败(FAILURE)构建失败时触发
构建不稳定(UNSTABLE)构建结果为不稳定时触发
构建中止(ABORTED)构建被手动或自动中止时触发
未构建(NOT_BUILT)构建未执行时触发

8. 配置导入导出

插件支持将全局配置导出为 JSON 文件,也可从 JSON 文件导入配置。此功能可用于:

  • 在多个 Jenkins 实例之间同步机器人配置
  • 备份和恢复配置
  • 通过脚本批量管理配置

配置快照包含所有机器人、安全策略、重试配置、代理设置等信息,导入时会校验数据格式版本。