Nun also doch wieder ein winziger Beitrag zur Java-Welt von mir. Da ich an Projekten arbeite, die mit Hilfe von Apache Log4j Logdateien erstellen, wurde kürzlich die Frage geäußert, wie man denn verhindern kann, dass das System irgendwann mit gigabytegroßen Logs volllaufen wird. Die bisherige „Alles-in-eine-Datei“-Implementierung sollte also ersetzt werden durch eine Lösung mit täglichem Wegspeichern der Logs vom Vortag und nach Möglichkeit direkt als ZIP-Datei, um Platz zu sparen (Plain Text lässt sich bekanntlich unheimlich gut packen). Hinzu kommt dann noch, dass nur die Logdateien der letzten x Tage vorgehalten werden sollten. Ältere Logs müssen automatisch gelöscht werden.
Nun ist Log4j ein sehr mächtiges Tool, das einem wirklich viel Arbeit abnimmt. Der RollingFileAppender z.B. erlaubt es dem Entwickler ganz einfach, Logdateien wegzuspeichern, wenn sie eine bestimmte Dateigröße erreicht haben, und die nächste Logdatei zu beginnen. Wunderbarerweise gibt es zusätzlich sogar die Möglichkeit, mit maxBackupIndex vorzugeben, wieviele Logdateien gleichzeitig gespeichert bleiben sollen. Fast perfekt, aber leider nicht auf periodisches, also z.B. tägliches Wegspeichern anwendbar. Zu meinem Glück gibt es genau für diese Anforderung den DailyRollingFileAppender, so als wäre er direkt für mich gemacht worden. Und jetzt kommt der Brüller: Der DailyRollingFileAppender hat blöderweise wieder keinen maxBackupIndex, er erlaubt also nicht das Vorhalten einer vorgegebenen Anzahl an Logdateien. Super Sache. Wie bekomme ich jetzt DEN FileAppender, der beides kann? Ich bräuchte eine Kombination aus beidem.
Unter http://wiki.apache.org/logging-log4j/DailyRollingFileAppender fand ich die Rettung in Form einer fertigen Klasse: Der DailyMaxRollingFileAppender – tägliches Wegspeichern mit Angabe des maxBackupIndex. Damit wären also zwei von drei Anforderungen erfüllt. Die ZIP-Funktionalität fehlte noch. Meine Mission war es also, einen kleinen FileAppender zu schreiben, der den DailyMaxRollingFileAppender erweitert. Geboren war der DailyMaxRollingZipFileAppender (DAS ist mal ein Klassenname!):
|
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 |
; html-script: false ]package org.apache.log4j; import java.io.File; import java.io.FileInputStream; import java.io.FileOutputStream; import java.io.IOException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; /** * @author Vincent Hoehnel * */ // This FileAppender additionally enhances DailyMaxRollingFileAppender with ZIP file support public class DailyMaxRollingZipFileAppender extends DailyMaxRollingFileAppender{ public DailyMaxRollingZipFileAppender(){ } public DailyMaxRollingZipFileAppender(Layout layout, String filename, String datePattern) throws IOException{ super(layout, filename, datePattern); } // New rollover method that compresses backup logfiles @Override public void rollOver() throws IOException{ File currentLogfile = new File(fileName); String newFileName = fileName+sdf.format(new Date(currentLogfile.lastModified())); super.rollOver(); File oldLogfile = new File(newFileName); File zipLogfile = new File(newFileName + ".zip"); if(!oldLogfile.exists()) return; // Open and read original backup log file into byte array FileInputStream logfileInputStream = new FileInputStream(oldLogfile); byte[] oldLogfileContent = new byte[(int) oldLogfile.length()]; logfileInputStream.read(oldLogfileContent); logfileInputStream.close(); // Write it into a zip file FileOutputStream fileOutputStream = new FileOutputStream(zipLogfile); ZipOutputStream zipfileOutputStream = new ZipOutputStream(fileOutputStream); zipfileOutputStream.putNextEntry(new ZipEntry(newFileName)); zipfileOutputStream.write(oldLogfileContent, 0, oldLogfileContent.length); zipfileOutputStream.closeEntry(); zipfileOutputStream.close(); fileOutputStream.close(); // Delete original log file oldLogfile.delete(); if(getMaxBackupIndex() > 0){ // Delete the oldest zip file File file = new File(fileName + dateBeforeZip()); if (file.exists()) file.delete(); } } private String dateBeforeZip(){ String dataAnte = ""; if(getDatePattern() != null){ SimpleDateFormat simpleDateFormat = new SimpleDateFormat(getDatePattern()); dataAnte = simpleDateFormat.format(new Date(rpc.getPastCheckMillis(new Date(), getMaxBackupIndex()))); } return dataAnte + ".zip"; } } |
Dieser FileAppender benennt zum Tageswechsel das Logfile mit Angabe des Datums um, verpackt es sofort als handliche ZIP-Datei, und löscht bei Bedarf das älteste Logfile (sofern maxBackupIndex erreicht). Ist ja eigentlich schon fast schade, dass Log4j sowas nicht von Haus aus kann. Falls jemand zufällig mit Log4j zu tun hat und damit was anfangen könnte: Bedient euch.
In related news: Hurra, endlich ein Syntax-Highlighter-Plugin für SuccessDenied. Als Programmierer kann man doch beinahe keinen Blog führen ohne ein solches Plugin.
Nettes feature. :)
Bei uns läuft glaub ich nur ein cronjob der alte logs löscht.
zippen haben wir gar nicht als Anforderung (liese sich damit aber auch machen), und das splitten in tägliche Logs… nun ich hab ehrlich gesagt keine Ahnung wie das läuft, das scheint mir aber eine JavaMachine Einstellung zu sein.
Aber direkt im log4j hat natürlich den Vorteil dass es auch unter nicht-*nix läuft und weniger Konfigurationsaufwand wenn das System neu aufsetzen muss.
Mir fallen momentan echt nur Kleinigkeiten ein, die ich zum Thema Java posten könnte, daher wirds erstmal ne Weile dabei bleiben ;)
Der genannte Aspekt ist tatsächlich einer der Gründe: Die Software soll unter Solaris-, Unix- und Windows-Systemen laufen.