SwiftLogger

A simple logging library for Swift 3.0

Need to Create Bug Reports?

The goal of this library is to make it real easy to log information inside your application and access it when needed. Simply create a global logging instance, log when needed, then send the logs to your server.

Startup

Anywhere in the global scope, create a SwiftLogger instance.

let log = SwiftLogger()

Usage

Now that you have a logger instance, create some logs.

You can create simple string logs

log.info("this is an info log")

Which displays this

10/31/16 20:25:985 PDT | INFO | MyTestFile.swift::myFunctionName():41 | this is an info log

You can also include an object for contextual information

log.fatal("something bad happened, here's some data", myDictionaryVariable)

Which displays this

10/31/16 20:25:985 PDT | FATL | MyTestFile.swift::MyExplodeyFunc():7 | something bad happened, here's some data || ["aKey": 1, "2ndKey": 2]

All of the different sections of the logging format are customizable.

You can think of it as an extension of debugPrint()

Ready to read what's in there?

The simplest way is to grab all files, send them to your server and purge them.

let logs = try? log.getLogs().values
//todo: send the log strings to your server
//purge the logs
log.purgeLogs()

Need more specifics? getLogs() returns the name of the file and the contents, so you can decide how to deal with each set.

if let dict = try? log.getLogs() {
    for pair in dict {
        //todo: do something with the contents
        //pair.value
        //purge the file
        log.purgeLogs([pair.key])
    }
}

Options

• Control where logging files are saved
• Control the size of files
• Control the maximum amount of storage to use for logging files
• Control the output format for logging messages
• Control, dynamically, which logging methods are actively writing to the log (log level)
• Hook into delegates to have greater visibility on the logging tail, and writing to disk operations
• Decide how important logging is (if something bad happens in the logger, do you want the application to crash, or continue without logging)

Roadmap

This is by no means ready for any production scenario. I'm hoping to it have it ready to go by the end of October, with some testing in a large application. There's still a number of features I plan to add, and test cases to cover. In any case, it does work, so try it out!