Log framework based on CocoaLumberjack. Adds dynamic log levels, modules' support and eases usage.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Demo
Source
.gitignore
.travis.yml
LICENSE
NBULog.podspec
NOTICE
README.md

README.md

NBULog

Platform: iOS/OSX Version: 2.0.0 License: Apache 2.0 Dependency Status Build Status

Log framework based on CocoaLumberjack. Adds dynamic log levels, modules' support and eases usage.

Was part of NBUCore.

Demo

iOS and OS X demo projects are included in the repository.

Features

Dynamic Log Levels

Instead of handling a ddLogLevel variable set you app log level dynamically. Also works with third party libraries that support NBULog.

[NBULog setAppLogLevel:DDLogLevelInfo];
[NBULog setKitLogLevel:DDLogLevelWarning]; // When using NBUKit

Modules

By default all your sources to APP_MODULE_DEFAULT but you can define your own modules in your prefix.pch file.

// Custom log modules
#define APP_MODULE_NETWORK  1 // APP_MODULE_DEFAULT = 0
#define APP_MODULE_OTHER    2

Then just redefine LOG_MODULE for the files that belong to one of your custom modules.

#import "MockNetworkModule.h"

// Define log module for this file
#undef  LOG_MODULE
#define LOG_MODULE APP_MODULE_NETWORK

Also you log a message for a different module than the one your file belongs to:

// Send an extra message for another module
NBULogInfoWithModule(APP_MODULE_OTHER, @"Log message from a APP_MODULE_OTHER");

Finally, you can also modify the log levels of individual modules.

// Only log messages from the custom APP_MODULE_NETWORK
[NBULog setAppLogLevel:DDLogLevelOff];
[NBULog setAppLogLevel:DDLogLevelInfo
             forModule:APP_MODULE_NETWORK];

[NBULog setKitLogLevel:DDLogLevelWarning
             forModule:NBUKIT_MODULE_ADDITIONS]; // When using NBUKit

XcodeColors

XcodeColors

When installed, XcodeColors are automatically enabled for the Xcode console.

On-Device Log Console and GUI to Ajust Levels

LumberjackConsole 1 LumberjackConsole 2

When LumberjackConsole is present you can add am on-device dashboard logger and adjust log levels from the UI.

#ifndef MY_PRODUCTION_MACRO
    // Register custom modules before adding the dashboard
    [NBULog registerAppContextWithModulesAndNames:@{@(APP_MODULE_NETWORK)   : @"Network",
                                                    @(APP_MODULE_OTHER)     : @"Other"}];
    
    // Add dashboard only for testing builds
    [NBULog addDashboardLogger];
#endif

Installation

Add pod 'NBULog' to your CocoaPods' Podfile:

platform :ios, '8.0'
use_frameworks!

pod 'NBULog'

# Optional on-device console
pod 'NBULog/Console'

Documentation

http://cocoadocs.org/docsets/NBULog/

Usage in 3rd Party Libraries

You can easily use NBULog in your library when available without making NBULog a requirement.

1. Conditionally Use NBULog

...and fallback to CocoaLumberjack or NSLog otherwise.

E.g. from NBUKit's NBUKitPrivate.h:

//  NBUKitPrivate.h

// ...

// a) Use NBULog for logging when available
#if __has_include("NBULog.h")

#import "NBULog+NBUKit.h"

#undef  LOG_CONTEXT
#define LOG_CONTEXT NBUKIT_LOG_CONTEXT

#undef  LOG_MODULE
#define LOG_MODULE  NBUKIT_MODULE_DEFAULT

#undef  LOG_LEVEL
#define LOG_LEVEL   [NBULog kitLogLevel]

// b) Else try CocoaLumberjack
#elif __has_include("DDLog.h")

#ifdef DEBUG
    #define NBUKitLogLevel DDLogLevelVerbose
#else
    #define NBUKitLogLevel DDLogLevelWarning
#endif

#define LOG_LEVEL_DEF   NBUKitLogLevel
#import <CocoaLumberjack/DDLog.h>

#define NBULogError(frmt, ...)      DDLogError(frmt, ##__VA_ARGS__)
#define NBULogWarn(frmt, ...)       DDLogWarn(frmt, ##__VA_ARGS__)
#define NBULogInfo(frmt, ...)       DDLogInfo(frmt, ##__VA_ARGS__)
#define NBULogDebug(frmt, ...)      DDLogDebug(frmt, ##__VA_ARGS__)
#define NBULogVerbose(frmt, ...)    DDLogVerbose(frmt, ##__VA_ARGS__)
#define NBULogTrace()               NBULogDebug(@"%@", THIS_METHOD)

// c) Else fallback to NSLog
#else

#ifdef DEBUG
    #define LOG_LEVEL 3
#else
    #define LOG_LEVEL 2
#endif

#define THIS_METHOD                 NSStringFromSelector(_cmd)
#define NBULogError(frmt, ...)      do{ if(LOG_LEVEL >= 1) NSLog((frmt), ##__VA_ARGS__); } while(0)
#define NBULogWarn(frmt, ...)       do{ if(LOG_LEVEL >= 2) NSLog((frmt), ##__VA_ARGS__); } while(0)
#define NBULogInfo(frmt, ...)       do{ if(LOG_LEVEL >= 3) NSLog((frmt), ##__VA_ARGS__); } while(0)
#define NBULogDebug(frmt, ...)      do{ if(LOG_LEVEL >= 4) NSLog((frmt), ##__VA_ARGS__); } while(0)
#define NBULogVerbose(frmt, ...)    do{ if(LOG_LEVEL >= 5) NSLog((frmt), ##__VA_ARGS__); } while(0)
#define NBULogTrace()               NBULogDebug(@"%@", THIS_METHOD)

#endif

2. Register a Log Context and Optional Modules

//  NBULog+NBUKit.h

#if __has_include("NBULog.h")

#import <NBULog/NBULog.h>

// NBUKit log context
#define NBUKIT_LOG_CONTEXT          110

// NBUKit modules
#define NBUKIT_MODULE_DEFAULT       0

@interface NBULog (NBUKit)

// Allow to set and read the current levels.
+ (DDLogLevel)kitLogLevel;
+ (void)setKitLogLevel:(DDLogLevel)logLevel;

@end

#endif

Then register your context and modules if you want them to appear in LumberjackConsole.

//  NBULog+NBUKit.m

#if __has_include("NBULog.h")

#import "NBULog+NBUKit.h"
#import <NBULog/NBULogContextDescription.h>

@implementation NBULog (NBUKit)

+ (void)load
{
    // Register the NBUKit log context
    [NBULog registerContextDescription:[NBULogContextDescription descriptionWithName:@"NBUKit"
                                                                             context:NBUKIT_LOG_CONTEXT
                                                                     modulesAndNames:nil
                                                                   contextLevelBlock:^{ return [NBULog kitLogLevel]; }
                                                                setContextLevelBlock:^(int level) { [NBULog setKitLogLevel:level]; }
                                                          contextLevelForModuleBlock:NULL
                                                       setContextLevelForModuleBlock:NULL]];
}

+ (DDLogLevel)kitLogLevel
{
    // ...
}

+ (void)setKitLogLevel:(DDLogLevel)logLevel
{
    // ...
}

@end

#endif

License

Copyright (c) 2012-2017 CyberAgent Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. 
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.