QuickELogger

A quick and simple way to log messages to disk on your iPhone or iPad app.

Adding QuickELogger to your project

CocoaPods

CocoaPods is the recommended way to add QuickELogger to your project.

Add QuickELogger to your Podfile pod 'QuickELogger'.
Install the pod(s) by running pod install.
Add QuickELogger to your files with import QuickELogger.

Clone from Github

Clone repository from github and copy files directly, or add it as a git submodule.
Add all files from Source directory to your project.

How To

Swift -> Create an instance of QuickELogger, and then it's as simple as calling log(:message:type).
Objective-C -> Create an instance of QuickELoggerObjC, and calling logWithMessage:type:
This logger has the following (pretty standard) log types: verbose, info, debug, warn, error.

Note: By default the file is saved in the /Library/Application Support/QuickELogger/ directory with the filename QuickELogger.json.

Additional configuration options

The filename can be customized for your liking using the init(filename:) initializer.

The directory structure can be customized fit in the following standard iOS directories:

/Documents
/tmp
/Library
/Library/Caches
/Library/Application Support

using the init(directory:) initializer. In addition to being able to specify a different system directory, you can also specify a path inside that system directory using and optional path in the Directory enum.

They can also be customized using the init(filename:directory:) initializer as well.

Example Usage

Swift

import QuickELogger

let logger = QuickELogger()

logger(message: "Pinto beans > Black beans", type: .info)

Objective-C

@import QuickELogger;

QuickELoggerObjC *logger = [[QuickELoggerObjC alloc] init];

[logger logWithMessage:@"Pinto beans > Black beans" type:ObjCLogTypeInfo];

What happens at /Library/Application Support/QuickELogger/QuickELogger.json:

[
  {
    "timeStamp" : "2019-10-27T02:32:57Z",
    "id" : "41593EA2-9D4D-4406-839B-2298AD7FA2E3",
    "message" : "Pinto beans > Black beans",
    "type" : "info"
  }
]

Additional Info

Gotchas

This logger doesn't append to a log file in the traditional sense. It reads from a current log (if one exists), and then overwrites that log with updated logs. This framework was created out of necessity to write logs to disk easily without loading in huge log frameworks and shouldn't be used for ultra-heavy logging.

Plans to make this more "enterprise-ready" are being evaluated.

Treats

This library comes with a protocol ready to use in your application for those of you that enjoy testing your software. This allows you to program your application to this "interface" and then you can stub it out with your own fake implementation for unit tests:

public protocol QuickELoggerProtocol {
    func log(message: String, type: LogType)
}

Testing

Prerequisites: ruby, ruby gems, bundler

This project has been setup to use fastlane to run the specs.

Bundle required gems and then install Cocoapods by running the following commands in the project directory:

$ bundle
$ bundle exec pod install

And then use fastlane to run all the specs on the command line:

$ bundle exec fastlane run_all_specs

Version History

Version history can be found on releases page.

Suggestions, requests, and feedback

Thanks for checking out QuickELogger for your logging needs. Any feedback can be can be sent to: github@ryan.codes.

rbaumbach/QuickELogger