开发一个jenkins插件

问题背景

在使用jenkins打包时,经常会遇到打包失败的问题,大多数情况下是代码编译错误。

但是现在很多大项目有非常多的插件,输出的日志也非常多,直接查看console非常费时间;现在需要将出错的日志筛选出来,并通知到开发,需要怎么办呢?

现有方案

问题很明确了,先看看jenkins是否已经有了这种功能呢?如果有了,咱们直接用起来就很美滋滋~

很快呀,就发现有个TextFinder插件,jenkins本身已经安装了,直接用起来就行

TextFinder

使用很简单,在任务配置里添加 构建后任务

然后添加筛选匹配规则即可,支持正则表达式

但是很快遇到了问题,如果有多个同样的匹配结果,仅输出第一条日志,马虎一点也能算解决了问题,但是本着知其所以然的精神,看了下源码 确实在搜索console日志时如果匹配到了就会快速返回结果!

arduino 复制代码
private static boolean checkPattern(
            Reader r, Pattern pattern, PrintStream logger, String header, boolean isConsoleLog) throws IOException {
        boolean logFilename = true;
        boolean foundText = false;
        try (BufferedReader reader = new BufferedReader(r)) {
            // Assume default encoding and text files
            String line;
            while ((line = reader.readLine()) != null) {
                /*
                 * Strip console logs of their console notes before searching; otherwise, we might
                 * accidentally match the search string in the encoded console note.
                 */
                if (isConsoleLog) {
                    line = ConsoleNote.removeNotes(line);
                }
                Matcher matcher = pattern.matcher(line);
                if (matcher.find()) {
                    if (logFilename) { // first occurrence
                        if (header != null) {
                            logger.println(header);
                        }
                        logFilename = false;
                    }
                    logger.println(line);
                    foundText = true;
                    /*
                     * When searching console output, return immediately as soon as the first hit is
                     * found; otherwise, we'll loop forever.
                     */
                    if (isConsoleLog) {
                        return true;
                    }
                }
            }
        }
        return foundText;
    }

另外的主要问题是想通知开发这个结果,也做不到,插件只会把匹配结果输出到console,另外还能标记成功或者失败,不能满足最初的设想功能。

那只能借鉴copy它来改一改了。

jenkins插件开发

直接参考官网文档即可,这里不做过多介绍了,主要分享实现的功能和大概思路。

  • 去掉仅匹配一次的限制,这个很简单,新建工程复制源码改下逻辑即可
  • 添加一个RunAction2来展示匹配的日志,能直接看到出错日志,减少搜索出错日志的时间
  • 将筛选出来的日志存到指定文件,添加shell脚本来读取文件并发通知给触发这次构建的开发同学(企微api)

遇到的问题

  • 如果导入demo工程出现问题,可以直接新建一个空的jenkins插件工程
  • 文件读写使用FilePath,可以看下jenkins的结构,因为插件是以服务的形式存在的,可能部署到不同节点,直接使用File在本地测试还行,部署到线上就不行了。
相关推荐
changxiang12 小时前
Jenkins备忘
运维·jenkins
未若君雅裁2 天前
日志采集与ELK:从本地日志到集中检索分析
运维·elk·jenkins
Dontla3 天前
CI/CD前世今生(持续集成、持续交付、持续部署、Jenkins、Github Actions)
ci/cd·github·jenkins
Java 码思客3 天前
【ElasticSearch从入门到架构师】第7章-聚合查询——实现数据统计与分析
大数据·elasticsearch·jenkins
逻极3 天前
Jenkins 从入门到精通:CI/CD自动化流水线实战
ci/cd·自动化·jenkins·devops
炸炸鱼.3 天前
Git+Jenkins实战(一):从零搭建自动化发布与回滚系统(附完整代码)
git·jenkins
无人生还别怕4 天前
搭建jenkins服务并接入openldap认证
运维·jenkins
Java 码思客4 天前
【ElasticSearch从入门到架构师】第3章:ES 核心基础概念(架构师必备底层认知)
大数据·elasticsearch·jenkins
X1A0RAN4 天前
Jenkins流水线日志彩色打印输出
运维·jenkins
炸炸鱼.5 天前
Git+Jenkins 基本使用:从入门到实战(知识点大全)
运维·git·jenkins