logbook's Introduction

Logbook

Logbook is a lightweight logging framework for iOS and iPadOS

Features

Levels: Debug -> Error
Categories
Extendable Log Handler

Basic usage

First setup Logbook by adding a LogSink

Logbook.add(sink: ConsoleLogSink())

Log some data

Logbook.debug("Hello Logbook")
Logbook.error("Hello Error")

Advanced usage

Create a global variable for faster access.

let log = Logbook.self

log.debug("Hello Logbook")

LogSinks

Filter logs by level.

ConsoleLogSink(level: .min(.warning))
ConsoleLogSink(level: .fix(.info))

Filter logs by category:

ConsoleLogSink(level: .min(.debug), categories: .include([.networking]))

ConsoleLogSink(level: .min(.debug), categories: .exclude([.networking]))

Add multiple sinks for different usecases:

// Log all with min level warning
Logbook.add(sink: ConsoleLogSink(level: .min(.warning)))

// Log only level error with category .networking
Logbook.add(sink: ConsoleLogSink(level: .fix(.error), categories: .include([.networking])))

Formatting

Add custom dateFormatter to sink

let dateFormatter = DateFormatter()
dateFormatter.dateStyle = .none
dateFormatter.timeStyle = .short

let console = ConsoleLogSink(level: .min(.debug), categories: .exclude([.networking]))
console.dateFormatter = dateFormatter

Add logging format to ConsoleLogSink

console.format = "\(LogPlaceholder.category) \(LogPlaceholder.date): \(LogPlaceholder.messages)"

Custom LogSink

Create your custom sink by confirming LogSink protocol.

LogCategory

Extend LogCategory to create custom categories.

extension LogCategory {
    
    static let startup = LogCategory("startup", prefix: "🚦")
    static let bluetooth = LogCategory("bluetooth", prefix: "🖲")
    
}

log.debug("hello", category: .startup)

Carthage

Add the following line to your Cartfile.

github "allaboutapps/Logbook"

Then run carthage update.

Swift Package Manager

Use Xcode 11+: Go to Project > Swift Packages > + and enter https://github.com/allaboutapps/Logbook

Or update your Package.swift file manually:

dependencies: [
.package(url: "[email protected]:allaboutapps/Logbook.git", from: "1.1"),
    ....
],
targets: [
    .target(name: "YourApp", dependencies: ["Logbook"]),
]

Requirements

Swift 5+

Contributing

Create something awesome, make the code better, add some functionality, whatever (this is the hardest part).
Fork it
Create new branch to make your changes
Commit all your changes to your branch
Submit a pull request

logbook's People

Contributors

Stargazers

Watchers

logbook's Issues

Only evaluate expressions when there is a sink for the log message

Creating log messages can be expansive (e.g. network response body mapping to string).
Currently the expressions for messages (on the caller sites) are already generated when calling the log message.

When wrapping the expression in a closure the closure can only be evaluated if there is a sink even consuming the the message.

with @autoclosure this doesn't change the way of interacting with logbook

CSV File Sink

It would be great to have a built-in file sink which saves to a CSV file, e.g. using https://github.com/dehesa/CodableCSV (needs to be an imperative writer). This would make it easy to inspect & analyze logs in tools such as Excel (group by category, etc.).

Recommend Projects

allaboutapps / logbook Goto Github PK