Question

Jenkins有600多个插件，在真实系统中，我们习惯于安装大量插件。

有时，我们想删除一些插件以使系统更干净或用另一个成熟的插件（不同的名称）替换。

这需要确保没有人/没有工作使用这些插件或我需要通知他们。

在Jenkins系统的配置或某处有什么方法可以知道插件是否被任何作业使用？

更新2013 根据下面的答案，我维护简单的“插件：关键字”映射，如

plugin_keys = {
    "git":'scm class="hudson.plugins.git.GitSCM"',
    "copyartifact":"hudson.plugins.copyartifact.CopyArtifact",
        # and more      
}

从config.xml搜索插件关键字，可以通过jenkins remote API

获取所有信息（插件，作业，配置）

它对我有用。

更新2014.04.26 后来的jenkins版本，似乎config.xml被改为直接有插件名称

像

<com.coravy.hudson.plugins.github.GithubProjectProperty plugin="github@1.4">
<hudson.plugins.throttleconcurrents.ThrottleJobProperty plugin="throttle-concurrents@1.7.2">
<hudson.plugins.disk__usage.DiskUsageProperty plugin="disk-usage@0.18"/>
<scm class="hudson.plugins.git.GitSCM" plugin="git@1.4.1-SNAPSHOT">

因此，我只需检查plugin="<plugin name>"中的config.xml，再次有效

更新2014.05.05

请参阅gist jenkins-stats.py

中的完整脚本

更新2018.6.7

plugin usage plugin支持此功能（尚无REST API）

Answer 1

以下是查找该信息的两种方法。

最简单的可能是grep作业配置文件：

E.g。当你知道插件的类名（或包名）时（例如org.jenkinsci.plugins.unity3d.Unity3dBuilder）：

find $JENKINS_HOME/jobs/ -name config.xml -maxdepth 2 | xargs grep Unity3dBuilder

另一种方法是使用the scriptler plugin之类的东西，但是你需要更多关于构建中插件使用位置的信息。

import hudson.model.*
import hudson.maven.*
import hudson.tasks.*

for(item in Hudson.instance.items) {
    //println("JOB : "+item.name);
    for (builder in item.builders){
      if (builder instanceof org.jenkinsci.plugins.unity3d.Unity3dBuilder) {
        println(">>" + item.name.padRight(50, " ") + "\t UNITY3D BUILDER with " + builder.unity3dName);
      }
    }
  }
}

更新：这是一个小的scriplet脚本，可以让您轻松找到相关的类名。它肯定可以改进：

import jenkins.model.*;
import hudson.ExtensionFinder;

List<ExtensionFinder> finders = Jenkins.instance.getExtensionList(ExtensionFinder.class);

for (finder in finders) {
  println(">>> " + finder);
  if (finder instanceof hudson.ExtensionFinder.GuiceFinder) {
    println(finder.annotations.size());
    for (key in finder.annotations.keySet()) {
       println(key);
    }
  } else if (finder instanceof ruby.RubyExtensionFinder) {
    println(finder.parsedPlugins.size());
    for (plugin in finder.parsedPlugins) {
      for (extension in plugin.extensions) {
        println("ruby wrapper for " + extension.instance.clazz);
      }
    }
  } else if (finder instanceof hudson.cli.declarative.CLIRegisterer) {
    println(finder.discover(Jenkins.instance));
    for (extension in finder.discover(Jenkins.instance)) {
      println("CLI wrapper for " + extension.instance.class);
      // not sure what to do with those      
    }
  } else {
    println("UNKNOWN FINDER TYPE"); 
  }
}

（从我的原始listJenkinsExtensions提交到http://scriptlerweb.appspot.com的内联scriplet，似乎已经失效）

不要忘记备份！

Answer 2

我无法发表评论，因为我没有足够的声誉，但如果可以的话，我会指出coffeebreaks为accepted answer提供的小字体脚本提供的断开链接{可以在Internet Archive上找到{3}}，链接：

https://web.archive.org/web/20131103111754/http://scriptlerweb.appspot.com/script/show/97001

如果链接断开，这是脚本的内容：

import jenkins.model.*;
import hudson.ExtensionFinder;

List<ExtensionFinder> finders = Jenkins.instance.getExtensionList(ExtensionFinder.class);

for (finder in finders) {
  println(">>> " + finder);
  if (finder instanceof hudson.ExtensionFinder.GuiceFinder) {
    println(finder.annotations.size());
    for (key in finder.annotations.keySet()) {
       println(key);
    }
  } else if (finder instanceof ruby.RubyExtensionFinder) {
    println(finder.parsedPlugins.size());
    for (plugin in finder.parsedPlugins) {
      for (extension in plugin.extensions) {
        println("ruby wrapper for " + extension.instance.clazz);
      }
    }
  } else if (finder instanceof hudson.cli.declarative.CLIRegisterer) {
    println(finder.discover(Jenkins.instance));
    for (extension in finder.discover(Jenkins.instance)) {
      println("CLI wrapper for " + extension.instance.class);
      // not sure what to do with those      
    }
  } else {
    println("UNKNOWN FINDER TYPE"); 
  }
}

Answer 3

截至2018年初，有一个“插件使用插件”，它为您提供了一个很好的插件列表以及它们的使用位置。我们已经注意到，根据系统的不同，有时似乎并没有捕获所有插件，但它提供了一个非常可爱的插件列表以及与可扩展列表中特定插件相关的所有作业。

https://plugins.jenkins.io/plugin-usage-plugin

Answer 4

我写了这个参数化的Jenkins作业来搜索配置文件。您只需要知道插件在配置文件中生成了哪些标签，并将该标签的名称用作参数needle：

cd  $JENKINS_HOME
cd jobs
echo searching for $needle
find . -name config.xml -type f -exec grep $needle /dev/null {} \;

如何知道插件是否被jenkins中的任何作业使用

4 个答案: