CocoaBitscocoabits.de /ios/ios-logging-mit-lumberjack/

Dirk Koller

Objective-C bzw. das Foundation-Framework bringt mit der Klasse NSLog einen eingebauten Log-Mechanismus mit. Die Klasse bzw. ein Makro schreibt eine Logmeldung ins Konsolenfenster. Wer etwaaus der Java-Welt zur Cocoa-Programmierung wechselt, ist allerdings leistungsfähigere Frameworkswie das beliebte Log4J, gewohnt. Zu den Features gehören beispielsweise verschiedene Log-Levelund rollierende Log-Dateien. Glücklicherweise muss man sich auch in der Cocoa-Welt nicht mit dementhaltenen Standard begnügen. Eines der beliebtesten Frameworks zum Thema iOS-Logging istLumberjack. Die Software ist auf GitHub unter https://github.com/robbiehanson/CocoaLumberjackerhältlich.

Im Download findet sich neben Demo-Projekten und einigen anderen Dateien der Ordner Lumberjack.Dieser wird ins eigene Projektverzeichnis kopiert und anschließend dem Projekt via File > Add Files to… zugefügt.

Ist das geschehen, müssen die gewünschten Logger eingerichtet werden. Zur Verfügung stehen diefolgenden Möglichkeiten:

DDASLLogger (sendet Logmeldungen an den Apple System Logger, Console.app)

DDTTYLogger (sendet Logmeldungen in die Xcode console)

DDFileLogger (sendet Logmeldungen in eine Datei)

Eine geeignete Stelle zur Konfiguration der benötigten Logger ist die Methodeapplication:didFinishLaunchingWithOptions: im AppDelegate des Projekts. Selbstverständlich müssendie verwendeten Klassen vor der Verwendung importiert werden.

// Configure the logging framework[DDLog addLogger:[DDASLLogger sharedInstance]];[DDLog addLogger:[DDTTYLogger sharedInstance]];DDFileLogger *fileLogger = [[[DDFileLogger alloc] init] autorelease];fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rollingfileLogger.logFileManager.maximumNumberOfLogFiles = 10;[DDLog addLogger:fileLogger];

Im Beispiel oben wird alle 24h rolliert, also in eine neue Datei geschrieben. Nach 10 Tagen wird dieerste Datei wieder überschrieben.

Danach kann geloggt werden. Bei einem bestehenden Projekt werden die NSLog-Meldungen durchSuchen & Ersetzen an Lumberjack angepasst. Die Log-Befehle für die verschiedenen Level heißen:

DDLogError

DDLogWarn

DDLogInfo

DDLogVerbose

Eine Loganweisung sieht also zum Beispiel so aus:

DDLogInfo(@"Application is starting ...");

Zum Schluss gilt es noch, den Log-Level zu definieren. Hier bietet Lumberjack umfangreicheMöglichkeiten. Ein gängiger Ansatz ist, den Loglevel beim Debuggen relativ gesprächig einzustellen,und im Release den Level hoch zusetzen. Unnötige Ausgaben kosten Performance und es gibt auchimmer mal wieder Gerüchte, dass zu viele Log-Meldungen zur Ablehnung der App im Review-Prozessführen können. Das oben beschriebene Verhalten kann realisiert werden, indem in der DateiProjektname_Prefix.pch folgende Direktive aufgenommen wird.

#ifdef DEBUGstatic const int ddLogLevel = LOG_LEVEL_VERBOSE;#elsestatic const int ddLogLevel = LOG_LEVEL_WARN;#endif

Das Flag DEBUG wird in neueren Xcode-Projekten in der Debug-Konfiuration automatisch gesetzt.

Wer in eine Datei schreibt, möchte vermutlich den Inhalt der Datei auch irgendwann einsehen.Lumberjack gewährt mit Hilfe von DDLogFileManagerDefault Zugriff auf die Log-Files. In der Klassefinden sich Methoden wie logsDirectory oder sortedLogFileNames, mit deren Hilfe sich die DateienLokalisieren, Auslesen oder auch Versenden lassen.

Der Beitrag beschreibt nur einen kleinen Teil des mächtigen Frameworks, im GitHub-Wiki des Projektsfinden sich weitere Informationen.