-
Notifications
You must be signed in to change notification settings - Fork 70
/
DiskUsageUtil.java
534 lines (495 loc) · 23.2 KB
/
DiskUsageUtil.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
/*
* To change this template, choose Tools | Templates
* and open the template in the editor.
*/
package hudson.plugins.disk_usage;
import hudson.FilePath;
import hudson.Util;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.Action;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Node;
import hudson.remoting.Callable;
import hudson.tasks.Mailer;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.mail.Message.RecipientType;
import javax.mail.MessagingException;
import javax.mail.Transport;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import jenkins.model.Jenkins;
/**
*
* @author Lucie Votypkova
*/
public class DiskUsageUtil {
public static void addProperty(Item item){
if(item instanceof AbstractProject){
AbstractProject project = (AbstractProject) item;
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
if(property==null){
try {
property = new DiskUsageProperty();
project.addProperty(property);
} catch (IOException ex) {
Logger.getLogger(DiskUsageItemListener.class.getName()).log(Level.SEVERE, null, ex);
}
}
loadData(property);
}
if(item instanceof ItemGroup){
for(AbstractProject project : DiskUsageUtil.getAllProjects((ItemGroup<?>)item)){
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
if(property==null){
try {
property = new DiskUsageProperty();
project.addProperty(property);
} catch (IOException ex) {
Logger.getLogger(DiskUsageItemListener.class.getName()).log(Level.SEVERE, null, ex);
}
}
loadData(property);
}
}
}
private static void loadData(DiskUsageProperty property){
if(!property.getDiskUsage().getConfigFile().exists() || !property.getDiskUsage().isBuildsLoaded()){
property.getDiskUsage().loadFirstTime();
}
else{
property.loadDiskUsage();
}
}
public static Date getDate(String timeCount, String timeUnit){
if(timeUnit==null || !timeUnit.matches("\\d+") || !timeCount.matches("\\d+"))
return null;
int unit = Integer.decode(timeUnit);
int count = Integer.decode(timeCount);
return getDate(unit,count);
}
public static Date getDate(int unit, int count){
Calendar calendar = new GregorianCalendar();
calendar.set(unit, calendar.get(unit)-count);
return calendar.getTime();
}
public static String formatTimeInMilisec(long time){
if(time/1000<1){
return "0 seconds";
}
long inMinutes = time/60000;
long hours = inMinutes/60;
String formatedTime = "";
if(hours>0){
String unit = hours>1? "hours" : "hour";
formatedTime = hours + " " + unit;
}
long minutes = inMinutes - hours*60;
if(minutes>0){
String unit = minutes>1? "minutes" : "minute";
formatedTime = formatedTime+ " " + minutes+ " " + unit;
}
long seconds = (time/1000) - minutes*60 - hours*60*60;
if(seconds>0){
String unit = minutes>1? "seconds" : "second";
formatedTime = formatedTime+ " " + seconds+ " " + unit;
}
return formatedTime;
}
public static void sendEmail(String subject, String message) throws MessagingException{
DiskUsagePlugin plugin = Jenkins.getInstance().getPlugin(DiskUsagePlugin.class);
String address = plugin.getConfiguration().getEmailAddress();
if(address==null || address.isEmpty()){
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "e-mail addres is not set for notification about exceed disk size. Please set it in global configuration.");
return;
}
MimeMessage msg = new MimeMessage(Mailer.descriptor().createSession());
msg.setSubject(subject);
msg.setText(message, "utf-8");
msg.setFrom(new InternetAddress(Mailer.descriptor().getAdminAddress()));
msg.setSentDate(new Date());
msg.setRecipient(RecipientType.TO, new InternetAddress(address));
Transport.send(msg);
}
public static Long getSizeInBytes(String stringSize){
if(stringSize==null || stringSize.equals("-"))
return 0l;
String []values = stringSize.split(" ");
int index = getIndex(values[1]);
Long value = Long.decode(values[0]);
Double size = value * (Math.pow(1024, index));
return Math.round(size);
}
public static void controlAllJobsExceedSize() throws IOException{
DiskUsagePlugin plugin = Jenkins.getInstance().getPlugin(DiskUsagePlugin.class);
plugin.refreshGlobalInformation();
Long allJobsSize = plugin.getCashedGlobalJobsDiskUsage();
Long exceedJobsSize = plugin.getConfiguration().getAllJobsExceedSize();
if(allJobsSize>exceedJobsSize){
try {
sendEmail("Jobs exeed size", "Jobs exceed size " + getSizeString(exceedJobsSize) + ". Their size is now " + getSizeString(allJobsSize));
} catch (MessagingException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage plugin can not send notification about exceeting build size.", ex);
}
}
}
public static void controlorkspaceExceedSize(AbstractProject project){
DiskUsagePlugin plugin = Jenkins.getInstance().getPlugin(DiskUsagePlugin.class);
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
Long size = property.getAllWorkspaceSize();
if(plugin.getConfiguration().warnAboutJobWorkspaceExceedSize() && size>plugin.getConfiguration().getJobWorkspaceExceedSize()){
StringBuilder builder = new StringBuilder();
builder.append("Workspaces of Job " + project.getDisplayName() + " have size " + size + ".");
builder.append("\n");
builder.append("List of workspaces:");
for(String slaveName : property.getSlaveWorkspaceUsage().keySet()){
Long s = 0l;
for(Long l :property.getSlaveWorkspaceUsage().get(slaveName).values()){
s += l;
}
builder.append("\n");
builder.append("Slave " + slaveName + " has workspace of job " + project.getDisplayName() + " with size " + getSizeString(s));
}
try {
sendEmail("Workspaces of Job " + project.getDisplayName() + " exceed size", builder.toString());
} catch (MessagingException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage plugin can not send notification about exceeting build size.", ex);
}
}
}
public static List<String> parseExcludedJobsFromString(String jobs){
List<String> list = new ArrayList<String>();
String jobNames[] = jobs.split(",");
for(String name: jobNames){
name = name.trim();
Item item = Jenkins.getInstance().getItem(name);
if(item!=null && item instanceof AbstractProject)
list.add(name);
}
return list;
}
public static String getSizeString(Long size) {
if (size == null || size <= 0) {
return "-";
}
int floor = (int) getScale(size);
floor = Math.min(floor, 4);
double base = Math.pow(1024, floor);
String unit = getUnitString(floor);
return Math.round(size / base) + " " + unit;
}
public static double getScale(long number) {
if(number==0)
return 0;
return Math.floor(Math.log(number) / Math.log(1024));
}
public static int getIndex(String unit){
int index = 0;
if(unit.equals("KB"))
index = 1;
if(unit.equals("MB"))
index = 2;
if(unit.equals("GB"))
index = 3;
if(unit.equals("TB"))
index = 4;
return index;
}
public static String getUnitString(int floor) {
String unit = "";
switch (floor) {
case 0:
unit = "B";
break;
case 1:
unit = "KB";
break;
case 2:
unit = "MB";
break;
case 3:
unit = "GB";
break;
case 4:
unit = "TB";
break;
}
return unit;
}
public static boolean isSymlink(File f){
boolean symlink = false;
try{
Class<?> files = Thread.currentThread().getContextClassLoader().loadClass( "java.nio.file.Files" );
Class<?> path = Thread.currentThread().getContextClassLoader().loadClass( "java.nio.file.Path" );
Class<?> paths = Thread.currentThread().getContextClassLoader().loadClass( "java.nio.file.Paths" );
URI uri = new URI(f.getAbsolutePath());
Object filePath = paths.getMethod("get", URI.class).invoke(null, uri);
symlink = (Boolean) files.getMethod("isSymbolicLink", path).invoke(null, filePath);
}
catch(Exception e){
//not java 7, try native
try{
symlink = Util.isSymlink(f);
}
catch(NoClassDefFoundError error){
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage can not determine if file " + f.getAbsolutePath() + " is symlink.");
//native fails
}
catch (IOException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.SEVERE, null, ex);
}
}
return symlink;
}
public static Long getFileSize(File f, List<File> exceedFiles) throws IOException {
long size = 0;
if(!f.exists())
return size;
if (f.isDirectory() && !isSymlink(f)) {
File[] fileList = f.listFiles();
if (fileList != null) for (File child : fileList) {
if(exceedFiles.contains(child))
continue; //do not count exceeded files
if (!isSymlink(child)) size += getFileSize(child, exceedFiles);
}
else {
LOGGER.info("Failed to list files in " + f.getPath() + " - ignoring");
}
}
return size + f.length();
}
public static void calculateDiskUsageForProject(AbstractProject project) throws IOException{
if(DiskUsageProjectActionFactory.DESCRIPTOR.isExcluded(project))
return;
DiskUsagePlugin plugin = Jenkins.getInstance().getPlugin(DiskUsagePlugin.class);
List<File> exceededFiles = new ArrayList<File>();
Set<DiskUsageBuildInformation> informations = project.getAction(ProjectDiskUsageAction.class).getBuildsInformation();
for(DiskUsageBuildInformation information : informations){
exceededFiles.add(new File(Jenkins.getInstance().getBuildDirFor(project), information.getId()));
}
if(project instanceof ItemGroup){
List<AbstractProject> projects = getAllProjects((ItemGroup) project);
for(AbstractProject p: projects){
exceededFiles.add(p.getRootDir());
}
}
long buildSize = DiskUsageUtil.getFileSize(project.getRootDir(), exceededFiles);
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
if(property==null){
addProperty(project);
property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
}
Long diskUsageWithoutBuilds = property.getDiskUsageWithoutBuilds();
boolean update = false;
if (( diskUsageWithoutBuilds <= 0 ) ||
( Math.abs(diskUsageWithoutBuilds - buildSize) > 1024 )) {
property.setDiskUsageWithoutBuilds(buildSize);
update = true;
}
if(plugin.getConfiguration().warnAboutJobExceetedSize() && buildSize>plugin.getConfiguration().getJobExceedSize()){
try {
sendEmail("Job " + project.getDisplayName() + " exceeds size", "Job " + project.getDisplayName() + " has size " + getSizeString(buildSize) + ".");
} catch (MessagingException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage plugin can not send notification about exceeting job size.", ex);
}
}
if (update) {
property.saveDiskUsage();
}
}
public static void addBuildDiskUsageAction(AbstractBuild build){
BuildDiskUsageAction action = null;
for(Action a: build.getActions()){
if(a instanceof BuildDiskUsageAction){
action = (BuildDiskUsageAction) a;
break;
}
}
if(action == null){
build.addAction(new BuildDiskUsageAction(build));
try {
build.save();
} catch (IOException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
public static void calculateDiskUsageForBuild(String buildId, AbstractProject project)
throws IOException {
if(DiskUsageProjectActionFactory.DESCRIPTOR.isExcluded(project))
return;
DiskUsagePlugin plugin = Jenkins.getInstance().getPlugin(DiskUsagePlugin.class);
//Build disk usage has to be always recalculated to be kept up-to-date
//- artifacts might be kept only for the last build and users sometimes delete files manually as well.
long buildSize = DiskUsageUtil.getFileSize(new File(Jenkins.getInstance().getBuildDirFor(project), buildId), new ArrayList<File>());
// if (build instanceof MavenModuleSetBuild) {
// Collection<List<MavenBuild>> builds = ((MavenModuleSetBuild) build).getModuleBuilds().values();
// for (List<MavenBuild> mavenBuilds : builds) {
// for (MavenBuild mavenBuild : mavenBuilds) {
// calculateDiskUsageForBuild(mavenBuild);
// }
// }
// }
Collection<AbstractBuild> loadedBuilds = project._getRuns().getLoadedBuilds().values();
AbstractBuild build = null;
for(AbstractBuild b : loadedBuilds){
if(b.getId().equals(buildId)){
build = b;
addBuildDiskUsageAction(build);
}
}
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
if(property==null){
addProperty(project);
property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
}
DiskUsageBuildInformation information = property.getDiskUsageBuildInformation(buildId);
Long size = property.getDiskUsageOfBuild(buildId);
if (( size <= 0 ) || ( Math.abs(size - buildSize) > 1024 )) {
if(information!=null){
information.setSize(buildSize);
}
else{
if(build!=null){
information = new DiskUsageBuildInformation(buildId, build.getTimeInMillis(), build.getNumber(), buildSize);
property.getDiskUsageOfBuilds().add(information);
}
else{
//should not happen
AbstractBuild newLoadedBuild = (AbstractBuild) project._getRuns().getById(buildId);
information = new DiskUsageBuildInformation(buildId, newLoadedBuild.getTimeInMillis(), newLoadedBuild.getNumber(), buildSize);
property.getDiskUsageOfBuilds().add(information);
}
}
property.saveDiskUsage();
}
if(plugin.getConfiguration().warnAboutBuildExceetedSize() && buildSize>plugin.getConfiguration().getBuildExceedSize()){
try {
sendEmail("Build with id " + information.getNumber() + " of project " + project.getDisplayName() + " exceeds size", "Build with id " + information.getNumber() + " of project " + project.getDisplayName() + " has size " + getSizeString(buildSize) + ".");
} catch (MessagingException ex) {
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage plugin can not send notification about exceeting build size.", ex);
}
}
}
public static Long calculateWorkspaceDiskUsageForPath(FilePath workspace, ArrayList<FilePath> exceeded) throws IOException, InterruptedException{
Long diskUsage = 0l;
if(workspace.exists()){
try{
diskUsage = workspace.getChannel().callAsync(new DiskUsageCallable(workspace, exceeded)).get(Jenkins.getInstance().getPlugin(DiskUsagePlugin.class).getConfiguration().getTimeoutWorkspace(), TimeUnit.MINUTES);
}
catch(Exception e){
Logger.getLogger(DiskUsageUtil.class.getName()).log(Level.WARNING, "Disk usage fails to calculate workspace for file path " + workspace.getRemote() + " through channel " + workspace.getChannel(),e);
}
}
return diskUsage;
}
public static void calculateWorkspaceDiskUsage(AbstractProject project) throws IOException, InterruptedException {
if(DiskUsageProjectActionFactory.DESCRIPTOR.isExcluded(project))
return;
DiskUsageProperty property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
if(property==null){
addProperty(project);
property = (DiskUsageProperty) project.getProperty(DiskUsageProperty.class);
}
property.checkWorkspaces();
for(String nodeName: property.getSlaveWorkspaceUsage().keySet()){
Node node = null;
if(nodeName.isEmpty()){
node = Jenkins.getInstance();
}
else{
node = Jenkins.getInstance().getNode(nodeName);
}
if(node==null){
//probably does not exists yet
continue;
}
if(node.toComputer()!=null && node.toComputer().getChannel()!=null){
Iterator<String> iterator = property.getSlaveWorkspaceUsage().get(nodeName).keySet().iterator();
while(iterator.hasNext()){
String projectWorkspace = iterator.next();
FilePath workspace = new FilePath(node.toComputer().getChannel(), projectWorkspace);
if(workspace.exists()){
Long diskUsage = property.getSlaveWorkspaceUsage().get(node.getNodeName()).get(workspace.getRemote());
ArrayList<FilePath> exceededFiles = new ArrayList<FilePath>();
if(project instanceof ItemGroup){
List<AbstractProject> projects = getAllProjects((ItemGroup) project);
for(AbstractProject p: projects){
DiskUsageProperty prop = (DiskUsageProperty) p.getProperty(DiskUsageProperty.class);
if(prop==null){
prop = new DiskUsageProperty();
p.addProperty(prop);
}
prop.checkWorkspaces();
Map<String,Long> paths = prop.getSlaveWorkspaceUsage().get(node.getNodeName());
if(paths!=null && !paths.isEmpty()){
for(String path: paths.keySet()){
exceededFiles.add(new FilePath(node.getChannel(),path));
}
}
}
}
diskUsage = calculateWorkspaceDiskUsageForPath(workspace, exceededFiles);
if(diskUsage!=null && diskUsage>0){
property.putSlaveWorkspaceSize(node, workspace.getRemote(), diskUsage);
}
controlorkspaceExceedSize(project);
}
else{
property.remove(node, projectWorkspace);
}
}
}
}
property.saveDiskUsage();
}
public static List<AbstractProject> getAllProjects(ItemGroup<? extends Item> itemGroup) {
List<AbstractProject> items = new ArrayList<AbstractProject>();
for (Item item : itemGroup.getItems()) {
if(item instanceof AbstractProject){
items.add((AbstractProject)item);
}
if (item instanceof ItemGroup) {
items.addAll(getAllProjects((ItemGroup) item));
}
}
return items;
}
/**
* A {@link Callable} which computes disk usage of remote file object
*/
public static class DiskUsageCallable implements Callable<Long, IOException> {
public static final Logger LOGGER = Logger
.getLogger(DiskUsageCallable.class.getName());
private FilePath path;
private List<FilePath> exceedFilesPath;
public DiskUsageCallable(FilePath filePath, List<FilePath> exceedFilesPath) {
this.path = filePath;
this.exceedFilesPath = exceedFilesPath;
}
public Long call() throws IOException {
File f = new File(path.getRemote());
List<File> exceeded = new ArrayList<File>();
for(FilePath file: exceedFilesPath){
exceeded.add(new File(file.getRemote()));
}
return DiskUsageUtil.getFileSize(f, exceeded);
}
}
public static final Logger LOGGER = Logger.getLogger(DiskUsageUtil.class.getName());
}