A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Clone or download
Latest commit 3e1093f Oct 19, 2018
Permalink
Failed to load latest commit information.
.github Add Stale Bot configuration Oct 9, 2018
Benchmarking demos: another cleanup benchmarking after cleanup. Oct 19, 2018
Classes Update Copyright headers / file headers (#968) Oct 19, 2018
Configs Integration: app targets have been separated from framework. (#961) Oct 18, 2018
Demos demos: podfiles have been removed. Oct 19, 2018
Documentation Merged framework targets + using xcconfig Oct 15, 2018
Framework Update Copyright headers / file headers (#968) Oct 19, 2018
Integration Update Copyright headers / file headers (#968) Oct 19, 2018
Lumberjack.xcodeproj Update Copyright headers / file headers (#968) Oct 19, 2018
Tests Update Copyright headers / file headers (#968) Oct 19, 2018
.gitattributes Added a StarUML diagram, exported as an image + into the Readme (set … Jun 1, 2016
.gitignore Add Carthage/Build to .gitignore to avoid dirty submodules when insta… Apr 13, 2017
.swiftlint.yml Added Danger integration using their wizard (bundle exec danger init): Oct 16, 2018
.travis.yml ci: travis has been updated. Oct 19, 2018
CHANGELOG.md Update CHANGELOG with the 3.5.0 already merged changes Oct 16, 2018
CocoaLumberjack.podspec Merged framework targets + using xcconfig Oct 15, 2018
Dangerfile Added Danger integration using their wizard (bundle exec danger init): Oct 16, 2018
Gemfile Added Danger integration using their wizard (bundle exec danger init): Oct 16, 2018
Gemfile.lock Added Danger integration using their wizard (bundle exec danger init): Oct 16, 2018
LICENSE Proper BSD 3-Clause License (the old one was incomplete) - see #936 Aug 14, 2018
LumberjackLogo.png Proposal for Lumberjack logo Jan 27, 2014
README.md Merged framework targets + using xcconfig Oct 15, 2018
uncrustify.cfg Formatted code using Uncrustify (via the BBUncrustifyXcodePlugin). Aug 12, 2014

README.md

CocoaLumberjack

Build Status Pod Version Carthage compatible Pod Platform Pod License codecov codebeat badge

CocoaLumberjack is a fast & simple, yet powerful & flexible logging framework for Mac and iOS.

How to get started

  • install via CocoaPods
  • use DDOSLogger for iOS 10 and later, DDTTYLogger and DDASLLogger for earlier versions.
Swift version via CocoaPods
platform :ios, '12.0'

# You need to set target when you use CocoaPods 1.0.0 or later.
target 'SampleTarget' do
  use_frameworks!
  pod 'CocoaLumberjack/Swift'
end

Note: Swift is a subspec which will include all the Obj-C code plus the Swift one, so this is sufficient. For more details about how to use Swift with Lumberjack, see this conversation.

Swift Usage

If you installed using CocoaPods or manually:

import CocoaLumberjack
DDLog.add(DDOSLogger.sharedInstance) // Uses os_log

let fileLogger: DDFileLogger = DDFileLogger() // File Logger
fileLogger.rollingFrequency = 60 * 60 * 24 // 24 hours
fileLogger.logFileManager.maximumNumberOfLogFiles = 7
DDLog.add(fileLogger)

...

DDLogVerbose("Verbose")
DDLogDebug("Debug")
DDLogInfo("Info")
DDLogWarn("Warn")
DDLogError("Error")
Obj-C version via CocoaPods
platform :ios, '12.0'
pod 'CocoaLumberjack'
Obj-C usage

If you're using Lumberjack as a framework, you can @import CocoaLumberjack;.

Otherwise, #import <CocoaLumberjack/CocoaLumberjack.h>

[DDLog addLogger:[DDOSLogger sharedInstance]]; // Uses os_log

DDFileLogger *fileLogger = [[DDFileLogger alloc] init]; // File Logger
fileLogger.rollingFrequency = 60 * 60 * 24; // 24 hour rolling
fileLogger.logFileManager.maximumNumberOfLogFiles = 7;
[DDLog addLogger:fileLogger];

...

DDLogVerbose(@"Verbose");
DDLogDebug(@"Debug");
DDLogInfo(@"Info");
DDLogWarn(@"Warn");
DDLogError(@"Error");
Installation with Carthage (iOS 8+)

Carthage is a lightweight dependency manager for Swift and Objective-C. It leverages CocoaTouch modules and is less invasive than CocoaPods.

To install with Carthage, follow the instruction on Carthage

Cartfile

github "CocoaLumberjack/CocoaLumberjack"

CocoaLumberjack 3

Migrating to 3.x

  • To be determined

Features

Lumberjack is Fast & Simple, yet Powerful & Flexible.

It is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for Objective-C, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the Objective-C runtime.

Lumberjack is Fast

In most cases it is an order of magnitude faster than NSLog.

Lumberjack is Simple

It takes as little as a single line of code to configure lumberjack when your application launches. Then simply replace your NSLog statements with DDLog statements and that's about it. (And the DDLog macros have the exact same format and syntax as NSLog, so it's super easy.)

Lumberjack is Powerful:

One log statement can be sent to multiple loggers, meaning you can log to a file and the console simultaneously. Want more? Create your own loggers (it's easy) and send your log statements over the network. Or to a database or distributed file system. The sky is the limit.

Lumberjack is Flexible:

Configure your logging however you want. Change log levels per file (perfect for debugging). Change log levels per logger (verbose console, but concise log file). Change log levels per xcode configuration (verbose debug, but concise release). Have your log statements compiled out of the release build. Customize the number of log levels for your application. Add your own fine-grained logging. Dynamically change log levels during runtime. Choose how & when you want your log files to be rolled. Upload your log files to a central server. Compress archived log files to save disk space...

This framework is for you if:

  • You're looking for a way to track down that impossible-to-reproduce bug that keeps popping up in the field.
  • You're frustrated with the super short console log on the iPhone.
  • You're looking to take your application to the next level in terms of support and stability.
  • You're looking for an enterprise level logging solution for your application (Mac or iPhone).

Documentation

Requirements

The current version of Lumberjack requires:

  • Xcode 10 or later
  • Swift 4.2 or later
  • iOS 8 or later
  • OS X 10.10 or later
  • WatchOS 2 or later
  • TVOS 9 or later

Backwards compability

  • for iOS 6, iOS 7, OS X 10.8, OS 10.9 and Xcode 9, use the 3.4.2 version
  • for iOS 5 and OS X 10.7, use the 3.3 version
  • for Xcode 8 and Swift 3, use the 3.2 version
  • for Xcode 7.3 and Swift 2.3, use the 2.4.0 version
  • for Xcode 7.3 and Swift 2.2, use the 2.3.0 version
  • for Xcode 7.2 and 7.1, use the 2.2.0 version
  • for Xcode 7.0 or earlier, use the 2.1.0 version
  • for Xcode 6 or earlier, use the 2.0.x version
  • for OS X < 10.7 support, use the 1.6.0 version

Communication

  • If you need help, use Stack Overflow. (Tag 'lumberjack')
  • If you'd like to ask a general question, use Stack Overflow.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request.

Author

  • Robbie Hanson
  • Love the project? Wanna buy me a coffee? (or a beer :D) donation

Collaborators

License

  • CocoaLumberjack is available under the BSD 3 license. See the LICENSE file.

Extensions

Architecture