LadyBug helps to track errors along the app execution.

LadyBug.md

LadyBug

LadyBug is cute and log messages along app execution. Behind the scenes LadyBug uses OSLog to perform log messages and store log in app archive according by level.

level	persisted	performance
debug	❌	faster
info	❓ (only during log collect)	faster (out of log collect), lower (during log collect)
notice	✅	lower
error	✅	lower
fault	✅	lower

The usage is pretty same of Logger, except it provide general usage scopes like viewCyle that represents categories.

References:

• Explore logging in Swift
• Logger documentation

Usage

// Simple log
🐞.viewCycle.debug("onAppear called")

// Formatted log
🐞.systemEvent.notice("\(message, align: .left(columns: 15)) \(email, privacy: .private(mask: .hash))")

License

MIT

LadyBug.swift

/*
  LadyBug.swift
  
  MIT License
  Copyright (c) 2021 Jan Cassio
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/

/// LadyBug is a cute way to use OSLog to help debug apps.
///
///This simple structure provides a general usage interface to add log messages into an app
///and could be customized anytime just changing a couple of lines.
///
struct 🐞 {
    private static let subsystem = Bundle.main.bundleIdentifier ?? "com.namespace.SystemName"
    
    /// Provides a `Logger`with the category named `"view-cycle"`.
    static var viewCycle: Logger {
        Logger(subsystem: subsystem, category: "view-cycle")
    }
    
    /// Provides a `Logger`with the category named `"unhandled"`.
    static var unhandled: Logger {
        Logger(subsystem: subsystem, category: "unhandled")
    }
    
    /// Provides a `Logger`with the category named `"user-event"`.
    static var userEvent: Logger {
        Logger(subsystem: subsystem, category: "user-event")
    }
    
    /// Provides a `Logger`with the category named `system-event"`.
    static var systemEvent: Logger {
        Logger(subsystem: subsystem, category: "system-event")
    }
}