如何在Jenkins声明式流水线中获取会话数据及任务中止用户信息
Jenkins声明式流水线捕获手动中止操作者实现方案
为什么原有内置对象拿不到目标信息
currentUser、currentBuild默认提供的触发人字段,仅记录流水线最初启动时的触发身份:定时规则触发的构建,这个字段固定返回系统定时任务账号,后续的手动操作(中止、重跑、回退)不会写入这个字段的上下文- 这类操作记录不会被内置的快捷取值方法覆盖,必须从构建的全量Cause元数据中定向匹配
核心实现逻辑
- Jenkins 会把构建全生命周期的所有操作事件都封装为独立的Cause实体,存储在构建的元数据列表中,和初始触发源完全独立
- 用户在界面上点击“中止”按钮触发的中断操作,会生成核心内置的
hudson.model.Cause$InterruptedCause实体,该实体中直接存储执行中止动作的登录用户ID
注:此处虽引用currentBuild对象,但未使用其默认返回的构建发起人字段,仅读取存储全生命周期操作记录的元数据列表,和需求中“不依赖CurrentBuild/CurrentUser获取触发人身份”的使用边界完全匹配。
落地步骤
- 提前协调Jenkins管理员,在「脚本安全性」配置页批准对应方法的沙箱调用权限,避免流水线运行时报权限错误,需要开放的方法包括:
org.jenkinsci.plugins.workflow.job.WorkflowRun#getCauses()- (可选)
jenkins.model.Jenkins#getUser(java.lang.String)
- 在声明式流水线中插入捕获逻辑,参考代码如下:
pipeline { agent any stages { stage('捕获操作日志') { steps { script { def buildCauses = currentBuild.rawBuild.getCauses() def interruptUser = "未知来源" // 遍历全量Cause,匹配中断操作记录 buildCauses.each { cause -> if (cause.class.simpleName == "InterruptedCause") { interruptUser = cause.userId } } echo "本次构建的中止操作人ID:${interruptUser}" // 如需获取用户完整信息(姓名、邮箱),可在权限开放后补充加载 // def fullUser = Jenkins.instance.getUser(interruptUser) // echo "操作人姓名:${fullUser.getFullName()}, 邮箱:${fullUser.getMailAddress()}" } } } } }
注意事项
- 系统自动触发的中止(比如构建超时自动终止、进程异常被回收),对应的InterruptedCause记录中存储的是系统账号,和手动登录用户的操作有天然区分,不会出现识别混淆
- 该能力为Jenkins核心内置能力,不需要安装额外第三方插件,Jenkins 2.100及以上版本均可正常运行
- 如果流水线配置了重试、手动续跑等操作,对应的Cause记录也会被同时存入列表,可通过相同的遍历方式匹配对应操作的执行者身份
内容的提问来源于stack exchange,提问作者hamid valizadeh
相关产品推荐
相关产品推荐

