OBLogger

OBLogger provides a super-simple set of macros and methods for logging DEBUG, WARN, INFO, and ERROR messages on the iPhone or iPad. It's primarily designed to help in alpha or beta-test debugging: the messages are saved to a log file, which you can then presumably retrieve. Alternatively, you can rig up a button to present the color-coded log file in the provided view controller. See the Example code for details.

Usage

To run the example project, clone the repo, and run pod install from the Example directory first. Please review the example project for examples of API usage.

API

Include <OBLogger/OBLogger.h> in whichever files you wish to use the logger in. The header defines a number of macros:

• OB_EVENT(): for logging events of interest (you can also configure the logger to handle app lifecycle events automatically)
• OB_ERROR(): for logging errors - note that this generates a notification event OBLoggerErrorNotification which you can subscribe to, so you can display the error
• OB_ERROR(): for logging warnings - note that this generates a notification event OBLoggerWarnNotification which you can subscribe to, so you can display the warning
• OB_INFO(): for logging general information - typically the information that shows how the app is behaving
• OB_DEBUG(): for logging debugging information - this information may be useful when something goes wrong but is often too noisy for normal log viewing

Showing the logfile

To show the log file, you configure a trigger and upon the trigger present the OBViewController. The viewcontroller shows its TextView, color-coding the different types of log messages, and allowing you to filter on different levels.

Again, the best demonstration is in OBViewController.m in the Example.

Catching errors in your application

When OBLogger.error, or it's wrapping macro OB_ERROR is called, it generates a notification event. You can subscribe to that event via

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(receivedError:) name: OBLoggerErrorNotification object:nil];

to catch the error. A similar function is available for warnings. Note that unfortunatley the design is deficient in that the observer will only get a string, not an error object.

Requirements

None. This is standalone.

Installation

OBLogger is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "OBLogger"

Author

etcetc, [email protected]

TO DO

• Tests
• Overload the error function so that it can receive an NSError object as its argument, and pass this argument along as the notification object.

License

OBLogger is available under the MIT license. See the LICENSE file for more info.