Oli's Blog

Logging ist (neben einem Exception-Handling, das diesen Namen auch verdient) das wichtigsten Hilfsmittel, um Fehler im Betrieb zu finden. Leider wird diese Erkenntnis gerne ignoriert.

Für alle Nicht-Ignoranten gibt es die 11 goldenen Logging-Regeln von Simon Wiest:

1. Alle Meldungen in Englisch abfassen.
2. Jede Meldung als vollständigen Satz formulieren.
3. Jede Meldung freistehend formulieren.
4. Eine Meldung nicht der Formatierung wegen auf mehrere Zeilen aufteilen.
5. Textvariablen immer in einfache Anführungszeichen setzen.
6. Meldungen so formulieren, daß sie im Code verbleiben können.
7. Meldungen immer mit einem Punkt abschließen.
8. Meldungen, die eine Exception ausgeben, mit Doppelpunkt abschließen.
9. Wird der Beginn eines Zeitraumes angezeigt, die Meldung mit drei Punkten (...) beenden.
10. Wird das Ende eines Zeitraumes angezeigt, die Meldung mit einem Punkt (.) beenden.
11. Besser den Beginn als das Ende einer längeren Operation anzeigen.

Im angehängten PDF sind die einzelnen Regeln erklärt und mit Beispielen hinterlegt. Denken Sie vielleicht auch ab und zu an den armen Administrator, der sich tagtäglich mit ihren Log-Dateien rumärgern darf und erschweren Sie ihm nicht unnötig die Arbeit. Spätestens wenn ein Bug auf Ihren Schreibtisch flattert, werden Sie froh sein, wenn das zugehörige Log aussagekräftig ist.

PDF: diegoldenenlogging-regeln2006-02-20 (pdf, 178 KB)