Jenkins基础教程（198）Jenkins维护之使用Disk Usage 插件：Jenkins磁盘空间告急？Disk Usage插件来救火！

每次Jenkins磁盘爆满，运维同学的内心都是崩溃的

一、Jenkins磁盘空间：为什么总是它先告急？

在深入探讨Disk Usage插件之前，我们首先需要明白一个问题：为什么Jenkins的磁盘空间总是那么快就被占满？

答案很简单：每一次构建都会产生数据。构建历史记录、构建日志、构建产物（artifacts）、依赖缓存等等，这些都是磁盘空间的"吃货大户"。随着项目的不断推进和构建任务的增加，Jenkins运行时可能会遇到磁盘空间不足的问题。

当Jenkins所在的服务器磁盘空间满时，会导致构建任务失败，影响项目的持续集成和部署。想象一下，正当团队急需一个关键构建包进行测试时，Jenkins却因磁盘空间不足而"罢工"，那种焦急与无奈，我相信很多开发者和运维人员都深有体会。

我曾经维护过一个Jenkins实例，短短三个月内磁盘使用量就从30%飙升到95%。最初我们试图通过手动清理来解决问题，但总是治标不治本。直到我们发现了Disk Usage插件，才真正从根源上解决了问题。

二、Disk Usage插件：你的Jenkins磁盘空间管家

什么是Disk Usage插件？

Disk Usage Plugin是Jenkins官方提供的一个插件，用于监控和统计Jenkins的磁盘使用情况。它可以全局统计所有项目的磁盘使用情况，也可以深入查看单个项目的磁盘占用细节。

简单来说，这个插件就像是给你的Jenkins配备了一个专业的"磁盘空间管家"，让你随时掌握磁盘空间的使用情况，及时发现潜在问题，避免磁盘爆满的尴尬局面。

安装Disk Usage插件

安装Disk Usage插件非常简单，只需要几个步骤：

1. 登录Jenkins管理界面，点击"系统管理" → "插件管理" → "可选插件"。
2. 在检索输入框中输入"disk"，检索到"disk-usage plugin"。
3. 选中并点击"直接安装"。

安装完成后，需要重启Jenkins以使插件生效。重启后，你会发现在Jenkins的主菜单中多了一个"Disk Usage"的菜单项。

三、Disk Usage插件使用详解

查看全局磁盘使用情况

点击Jenkins主菜单中的"Disk Usage"，即可进入磁盘使用情况统计页面。这里展示了Jenkins整体以及各个项目的磁盘使用情况，通常包括以下信息：

• Jenkins总磁盘使用量
• 各工作空间的磁盘使用量
• 各构建任务的磁盘使用量
• 各构建产物的磁盘使用量

这个页面提供了一个全局视角，让你快速识别出哪些项目或工作空间是磁盘空间的"消耗大户"。

查看项目级磁盘使用情况

要查看单个项目的磁盘使用情况，只需进入特定项目的详情页面，然后点击左侧菜单中的"Disk Usage"。这里会显示该项目各模块的磁盘使用统计，例如：

• 构建历史记录占用空间
• 构建产物占用空间
• 工作空间文件占用空间

通过分析这些数据，你可以判断是否需要清理该项目的旧构建记录或构建产物。

配置磁盘使用趋势图

Disk Usage插件还提供了一个很实用的功能——磁盘使用趋势图，可以直观展示项目磁盘使用的变化趋势。

启用这个功能的步骤如下：

1. 点击"系统管理" → "系统设置"，找到"Disk Usage配置"部分。
2. 选中"Show disk usage trend graph on the project page"选项。
3. 保存配置。

启用后，进入任何构建过至少两次的项目详情页，你都会看到一个磁盘使用趋势图，清晰展示每次构建后磁盘使用的变化情况。

四、实战演练：完整示例

下面，我将通过一个完整的示例，展示如何使用Disk Usage插件管理和优化Jenkins磁盘空间。

场景描述

假设我们有一个名为"web-app-demo"的Java Web应用项目，该项目每天会进行数十次构建。最近，团队发现Jenkins服务器磁盘空间使用率已超过85%，需要立即进行优化。

步骤1：识别磁盘使用大户

首先，我们通过Disk Usage插件找出磁盘空间的主要消耗者：

1. 登录Jenkins，点击主菜单中的"Disk Usage"。
2. 在磁盘使用情况页面，我们可以按照磁盘使用量对项目进行排序，找出占用空间最多的项目。

假设我们发现"web-app-demo"项目竟然占用了超过30GB的磁盘空间，这显然是不正常的。

步骤2：分析项目磁盘使用详情

接下来，我们深入分析"web-app-demo"项目的磁盘使用情况：

1. 进入"web-app-demo"项目页面。
2. 点击左侧菜单中的"Disk Usage"。

在项目磁盘使用详情页面，我们发现：

• 构建产物：占用15GB空间
• 构建历史记录：占用10GB空间
• 工作空间：占用5GB空间

很明显，构建产物和构建历史记录是磁盘空间的主要消耗者。

步骤3：制定清理策略

根据上面的分析，我们决定采取以下措施：

1. 配置自动清理旧构建：只保留最近15次的构建记录，更早的构建自动删除。
2. 优化构建产物：只保留必要的构建产物（如可执行jar包），删除中间产物和临时文件。
3. 定期清理工作空间：每次构建后自动清理工作空间。

步骤4：实施自动清理策略

配置自动清理旧构建

在Jenkins中，我们可以通过配置"Discard old builds"选项自动清理旧构建：

1. 进入"web-app-demo"项目的配置页面。
2. 找到"Discard old builds"部分，勾选该选项。
3. 配置保留策略：

• • Days to keep builds：7（保留7天的构建）
  • Max # of builds to keep：15（最多保留15次构建）
  • Days to keep artifacts：3（保留3天的构建产物）
  • Max # of builds to keep with artifacts：5（最多保留5次构建的产物）

这些配置可以根据项目的实际需求进行调整。如果磁盘空间足够，这4个选项设置为15就可以了（也就是两周 + 1天）。如果磁盘空间不足时，可以将这4个选项都设置为3。

使用Configuration Slicing插件批量配置

如果我们有多个Jenkins任务需要配置，逐个修改会非常费时费力。这时可以使用Configuration Slicing plugin来批量配置。

安装并重启Jenkins后：

1. 打开"Manage Jenkins" → "Configuration Slicing"。
2. 分别配置以下选项：

• • Discard Old Builds Slicer - Days to keep artifacts：3
  • Discard Old Builds Slicer - Days to keep builds：7
  • Discard Old Builds Slicer - Max # of builds to keep：15
  • Discard Old Builds Slicer - Max # of builds to keep with artifacts：5

配置完成后，所有Jenkins任务的对应设置都会被批量更新。

步骤5：验证优化效果

完成上述配置后，我们再次使用Disk Usage插件检查优化效果：

1. 等待几次新的构建完成后，再次查看"web-app-demo"项目的磁盘使用情况。
2. 观察磁盘使用趋势图，确认磁盘使用量是否呈下降趋势。

通常情况下，经过这样的优化，项目的磁盘占用会显著减少。在我们的示例中，"web-app-demo"项目的磁盘占用从30GB降低到了约5GB，效果非常明显。

五、Disk Usage插件与其他工具的结合使用

与Prometheus和Grafana集成

对于需要更专业监控的场景，我们可以将Jenkins的磁盘使用数据接入更专业的监控系统，如Prometheus和Grafana。

Jenkins自身可以通过promethus-plugin插件来暴露指标，可通过路径 http://JenkinsHost:JenkinsPort/prometheus/ 查看。其中包含了许多有用的磁盘相关指标，如：

• default_jenkins_disk_usage_bytes：Jenkins_HOME中一级文件夹的磁盘使用量（以字节为单位）
• default_jenkins_job_usage_bytes：Jenkins中每个作业的磁盘使用量（以字节为单位）
• default_jenkins_file_store_capacity_bytes：Jenkins使用的文件存储的总大小
• default_jenkins_file_store_available_bytes：Jenkins使用的文件存储中估计的可用空间

配置步骤大致如下：

1. Jenkins端：安装"Prometheus Plugin"，进入"Manage Jenkins" → "Configure System"，在"Prometheus" section启用插件并设置指标路径（默认/prometheus）。
2. Prometheus端：编辑prometheus.yml，添加Jenkins抓取任务，然后重启Prometheus生效。
3. Grafana端：添加Prometheus数据源，导入Jenkins官方面板，自定义展示CPU、内存、构建时长等指标。

与磁盘空间警报结合

除了使用Disk Usage插件可视化磁盘使用情况外，我们还可以配置磁盘空间警报，当磁盘空间不足时及时接收通知。

Jenkins提供了一个插件叫做Disk Usage Plugin（与本文介绍的是同一个插件），可以帮助我们监控Jenkins的磁盘使用情况，并在磁盘空间不足时发出警报。安装该插件后，在系统配置页面中配置警报阈值和警报接收人。当磁盘使用率超过阈值时，Jenkins将发送警报通知给指定的接收人。

六、Jenkins磁盘空间管理的其他技巧

除了使用Disk Usage插件外，还有一些其他方法可以帮助我们更好地管理Jenkins的磁盘空间：

1. 定期清理不必要的构建历史记录

Jenkins会保存每个构建的历史记录，包括构建结果、日志文件等。随着时间的推移，这些历史记录会占用大量的磁盘空间。我们可以定期清理不必要的构建历史记录，释放磁盘空间。

在Jenkins主界面上，选择"管理"菜单，然后点击"系统管理"选项。在系统管理页面中，找到"定期执行任务"选项，添加一个定期任务来删除指定时间之前的构建历史记录。

2. 清理插件和依赖库

Jenkins的插件和依赖库也会占用一定的磁盘空间。有时候，某些插件可能已经不再使用或者可以卸载，我们可以将其删除以释放空间。

在Jenkins主界面上，选择"管理"菜单，然后点击"插件管理"选项。在插件管理页面中，找到"已安装"选项卡，查看当前安装的插件列表。对于不再使用的插件，可以将其卸载以释放磁盘空间。

3. 使用外部存储

如果Jenkins服务器的磁盘空间有限，我们可以考虑使用外部存储来扩展Jenkins的存储容量。将Jenkins的工作目录和构建历史记录迁移到外部存储设备上，例如网络文件系统（NFS）或者云存储服务。这样可以在不影响Jenkins性能的情况下，增加其存储容量。

需要注意的是，在使用外部存储时，要特别关注数据安全和备份问题。

4. 优化构建任务配置

有时候，构建任务的配置也可能导致磁盘空间的浪费。我们可以检查每个构建任务的配置，确保没有不必要的文件或目录被纳入构建过程中。

例如，某些构建任务可能包含大量的测试报告或临时文件，这些文件可能不再需要被保留。通过优化构建任务的配置，可以减少磁盘空间的占用。

七、总结

Jenkins磁盘空间管理是每个Jenkins管理员都必须面对的重要任务。通过使用Disk Usage插件，我们可以轻松监控和分析Jenkins的磁盘使用情况，及时发现并解决磁盘空间问题。

本文详细介绍了Disk Usage插件的安装、配置和使用方法，并通过一个完整的示例展示了如何在实际项目中应用该插件优化磁盘空间。此外，我们还探讨了Disk Usage插件与其他工具（如Prometheus和Grafana）的集成，以及Jenkins磁盘空间管理的其他有用技巧。

记住，预防总比治疗来得容易。与其等到磁盘空间爆满才匆忙应对，不如提前部署Disk Usage插件，建立完善的磁盘空间监控和清理机制，确保Jenkins始终稳定运行。

希望本文能帮助你更好地管理和优化Jenkins磁盘空间，让你的持续集成流程更加顺畅高效！

附录：常用磁盘空间管理命令

虽然Disk Usage插件提供了很好的可视化界面，但在某些情况下，我们可能还需要通过命令行直接检查磁盘空间：

• 查看磁盘空间概览：df -h
• 查看Jenkins目录磁盘使用详情：du -sh $JENKINS_HOME/*
• 查找大文件：find $JENKINS_HOME -type f -size +100M -exec ls -lh {} \;
• 查看Jenkins进程状态：ps aux | grep jenkins
• 查看Jenkins端口监听：netstat -tuln | grep 8080（假设使用默认端口8080）

通过这些命令，我们可以更深入地了解磁盘空间的使用情况，找出潜在的问题根源。