Logma

Logma is a convenient and customizable library for log processing.

It can write logs using the 5-levels of logging (Debug, Info, Notice, Error, and Fault) defined by the Apple OS log system.

• Logma
• Requirements
• Installation
  • Swift Package Manager
• Getting Started
  • Custom Printer
  • Logmo
• Contribution
• License

Requirements

• iOS 14.0+

Installation

Swift Package Manager

dependencies: [
    .package(url: "https://github.com/wlsdms0122/Logma.git", .upToNextMajor("1.2.0"))
]

Getting Started

Logma is a library that wraps the log system for customization.

If you want to write logs in your app, you can use Logma's basic API for printing.

To use Logma, you should configure the printers first:

Logma.configure([
    // Any printers.
])

Printer is a simple protocol for printing logs. You can define your own log printer or use the default printer ConsolePrinter provided by Logma:

protocol Printer {
    func print(_ message: Any, userInfo: [Logma.Key: Any], level: Logma.Level)
}

After configuring Logma, you can use the following 5-level log APIs:

static func debug(_:userInfo:)
static func info(_:userInfo:)
static func notice(_:userInfo:)
static func error(_:userInfo:)
static func fault(_:userInfo:)

Custom Printer

For example, if you want to write log using Apple's Logger, you can define LoggerPrinter adopt Printer protocol.

// LoggerPrinter.swift
import OSLog

struct LoggerPrinter: Printer {
    let logger = Logger()

    func print(_ message: Any, userInfo: [Logma.Key: Any], level: Logma.Level) {
        let message = ...

        switch level {
        case .debug:
            logger.debug(message)
            ...
        }
        
    }
}

// AppDelegate.swift
import Logma

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    ...
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Logma.configure([
            LoggerPrinter()
        ])
        ...
    }
}

Logmo

Logmo is an iOS runtime log viewer. It's a simple log viewer with log level filters.

You can use Logmo as a standalone tool:

// Show the Logmo window.
Logmo.shared.show()
// Hide the Logmo window.
Logmo.shared.hide()

You can configure Logmo by setting the title and adding logs:

// Set the Logmo window title.
Logmo.shared.setTitle("title")
// Add a log to Logmo.
Logmo.shared.addLog(Log("log message", level: .debug))
// Add the custom setting menu for own.
Logmo.shared.configure {
    Toggle("Toggle Custom Setting", isOn: ...)
    ...
}

After understanding the default usages, the most important thing is to integrate Logmo with Logma using a Printer.

Logmo provides a default LogmoPrinter, but if you want to customize the log message, you can define your own Printer.

Logmo is a WIP project. The UI/UX functionality will be gradually improved.

Contribution

Any ideas, issues, opinions are welcome.

License

Logmo is available under the MIT license. See the LICENSE file for more info.