Getting started with the CocoaLumberjack framework.
There are 3 steps to getting started with the logging framework:
platform :ios, '8.0' pod 'CocoaLumberjack'
github "CocoaLumberjack/CocoaLumberjack"
Please note, installation via CocoaPods or Carthage is much simpler and recommended by the development team
git submodule add https://git@github.com/CocoaLumberjack/CocoaLumberjack.git
CocoaLumberjack/Lumberjack.xcodeproj
into your projectCocoaLumberjack
or CocoaLumberjackSwift
for OS XCocoaLumberjack-iOS
or CocoaLumberjackSwift-iOS
for iOSCocoaLumberjack-watchOS
or CocoaLumberjackSwift-watchOS
for watchOSCocoaLumberjack-tvOS
or CocoaLumberjackSwift-tvOS
for tvOSConsider this method if you favour static libraries over frameworks or have to use the static library.
git submodule add https://git@github.com/CocoaLumberjack/CocoaLumberjack.git
CocoaLumberjack/Lumberjack.xcodeproj
into your projectCocoaLumberjack-iOS-Static
a dependency for your application targetCocoaLumberjack-iOS-Static
to the Link Binary
phase"$(BUILT_PRODUCTS_DIR)/include"
to the Header Search Paths
Consider this method if you want to more easily modify target build settings, have other complex needs or simply prefer to do things by hand.
git clone https://git@github.com/CocoaLumberjack/CocoaLumberjack.git
#define LOG_LEVEL_DEF ddLogLevel #import <CocoaLumberjack/CocoaLumberjack.h>
A couple lines of code is all you need to get started:
[DDLog addLogger:[DDASLLogger sharedInstance]]; [DDLog addLogger:[DDTTYLogger sharedInstance]];
This will add a pair of “loggers” to the logging framework. In other words, your log statements will be sent to the Console.app and the Xcode console (just like a normal NSLog).
Part of the power of the logging framework is its flexibility. If you also wanted your log statements to be written to a file, then you could add and configure a file logger:
DDFileLogger *fileLogger = [[DDFileLogger alloc] init]; fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling fileLogger.logFileManager.maximumNumberOfLogFiles = 7; [DDLog addLogger:fileLogger];
The above code tells the application to keep a week's worth of log files on the system.
You will also need to set a global log level for your application. This can be modified in different manners later (see the bottom of this document for more information).
To do this, simply define the ddLogLevel
constant. One example of this may be in your .pch file like so:
static const DDLogLevel ddLogLevel = DDLogLevelDebug;
This global log level will be used as a default unless stated otherwise. See below for possible levels you can set this to.
The DDLog header file defines the macros that you will use to replace your NSLog statements. Essentially they look like this:
// Convert from this: NSLog(@"Broken sprocket detected!"); NSLog(@"User selected file:%@ withSize:%u", filePath, fileSize); // To this: DDLogError(@"Broken sprocket detected!"); DDLogVerbose(@"User selected file:%@ withSize:%u", filePath, fileSize);
As you can see, the DDLog macros have the exact same syntax as NSLog.
So all you need to do is decide which log level each NSLog statement belongs to. By default, there are 5 options available:
(You can also customize the levels or the level names. Or you can add fine-grained control on top of or instead of simple levels.)
Which log level you choose per NSLog statement depends, of course, on the severity of the message.
These tie into the log level just as you would expect
Where do I set the log level? Do I have to use a single log level for my entire project?
Of course not! We all know what it‘s like to debug or add new features. You want verbose logging just for the part that you’re currently working on. The CocoaLumberjack framework gives you per file debugging control. So you can change the log level on just that file you're editing.
(Of course there are many other advanced options, such as a global log level, per xcode configuration levels, per logger levels, etc. But we'll get to that in another article.)
Here's all it takes to convert your log statements:
// CONVERT FROM THIS #import "Sprocket.h" @implementation Sprocket - (void)someMethod { NSLog(@"Meet George Jetson"); } @end // TO THIS #import "Sprocket.h" #import "CocoaLumberjack.h" static const DDLogLevel ddLogLevel = DDLogLevelVerbose; @implementation Sprocket - (void)someMethod { DDLogVerbose(@"Meet George Jetson"); } @end
Notice that the log level is declared as a constant. This means that DDLog statements above the log level threshold will be compiled out of your project (when your compiler has optimisations turned on, as it would for your release build).
The latest versions of CocoaLumberjack use ARC. If you're not using ARC in your project, learn how to properly flag the CocoaLumberjack files as ARC in your Xcode project on the ARC page.
This is just the tip of the iceberg.
Find out how to: