CocoaLumberjack/CocoaLumberjack


A fast & simple, yet powerful & flexible logging framework for Mac and iOS

https://cocoalumberjack.github.io/

License: BSD-3-Clause

Language: Objective-C

Keywords: carthage, cocoalumberjack, cocoapods, ios, log, logging, lumberjack, macos, objective-c, swift, tvos, watchos


CocoaLumberjack

Build Status Pod Version Carthage compatible Pod Platform Pod License Reference Status codecov

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

How to get started

Swift version via CocoaPods
platform :ios, '8.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(DDTTYLogger.sharedInstance) // TTY = Xcode console
DDLog.add(DDASLLogger.sharedInstance) // ASL = Apple System Logs

let fileLogger: DDFileLogger = DDFileLogger() // File Logger
fileLogger.rollingFrequency = TimeInterval(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, '7.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:[DDTTYLogger sharedInstance]]; // TTY = Xcode console
[DDLog addLogger:[DDASLLogger sharedInstance]]; // ASL = Apple System Logs

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 9 or later
  • Swift 4.0 or later
  • iOS 6 or later
  • OS X 10.8 or later
  • WatchOS 2 or later
  • TVOS 9 or later

Backwards compability

  • 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 license. See the LICENSE file.

Architecture

Project Statistics

Sourcerank 12
Repository Size 4.34 MB
Stars 11,273
Forks 1,957
Watchers 398
Open issues 11
Dependencies 1
Contributors 147
Tags 51
Created
Last updated
Last pushed

Top Contributors See all

Ernesto Rivera Bogdan Poplauschi Robbie Hanson C.W. Betts Koichi Yokota Jaehong Kang Dmytro Vorobiov Florian Friedrich Jean-Charles BERTIN Nick Brook Nikolay Morev David Davies-Payne Matthias Wenz Stephan Diederich Ewan Mellor Xavier Matos Stephen Larew Alsey Coleman Miller Pavel Kunc Sebastian Keller

Packages Referencing this Repo

github.com/cocoalumberjack/cocoalumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Latest release 3.4.2 - Published - 11.3K stars
CocoaLumberjack/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Latest release 3.4.2 - Published - 11.3K stars
github.com/github.com/CocoaLumberjack/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Latest release 3.4.2 - Published - 11.3K stars
CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS.
Latest release 3.4.2 - Updated - 11.3K stars

Recent Tags See all

3.4.2 April 17, 2018
3.4.1 January 26, 2018
3.4.0 January 03, 2018
3.3.0 October 03, 2017
3.2.1 August 21, 2017
3.2.0 May 03, 2017
3.1.0 February 22, 2017
3.0.0 September 21, 2016
2.4.0 September 19, 2016
2.3.0 May 02, 2016
2.2.0 October 28, 2015
2.1.0 October 23, 2015
2.1.0-rc October 22, 2015
2.0.3 October 13, 2015
2.1.0-beta October 12, 2015

Interesting Forks See all

mutualmobile/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Objective-C - BSD-3-Clause - Updated - 3 stars
Madefire/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Objective-C - BSD-3-Clause - Last pushed - 2 stars
Sumi-Interactive/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Objective-C - BSD-3-Clause - Last pushed - 2 stars
bitswift/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Objective-C - BSD-3-Clause - Last pushed - 2 stars - 1 forks
EmbeddedSources/CocoaLumberjack
A fast & simple, yet powerful & flexible logging framework for Mac and iOS
Objective-C - BSD-3-Clause - Last pushed - 2 stars

Something wrong with this page? Make a suggestion

Last synced: 2017-10-21 23:09:10 UTC

Login to resync this repository