Puppy
A flexible Swift logging library supporting multiple transports, log rotation, and cross-platform compatibility.
What is Puppy?
Puppy is a flexible logging library written in Swift that provides robust, cross-platform logging for applications. It supports multiple transports like console, file, syslog, and oslog, and can function both as a standalone tool and as a backend for Apple's swift-log framework. It solves the need for customizable, reliable logging across Darwin, Linux, and Windows environments.
Swift developers building applications that require cross-platform logging, especially those using or integrating with Apple's swift-log framework in server-side, desktop, or mobile projects. It's also suitable for developers needing advanced features like automatic log rotation and custom log formats.
Developers choose Puppy for its seamless integration with swift-log, cross-platform compatibility, and built-in features like file log rotation. Its extensibility through protocols like Loggerable and Formattable allows deep customization, setting it apart from simpler logging solutions.
Overview
A flexible logging library written in Swift
Use Cases
Best For
- Swift projects requiring logging across multiple platforms (Darwin, Linux, Windows).
- Applications that need automatic log rotation with configurable size limits and archive management.
- Integrating with Apple's swift-log framework as a backend for enhanced logging capabilities.
- Customizing log output formats using the Formattable protocol for tailored logging needs.
- Creating custom loggers by conforming to the Loggerable protocol for specialized logging scenarios.
- Server-side Swift frameworks like Vapor that utilize swift-log and require file-based logging with rotation.
Not Ideal For
- Projects requiring direct logging to cloud services or databases without custom implementation
- Applications needing dead-simple, zero-configuration logging out of the box
- Teams focused solely on single-platform development where cross-platform support adds overhead
Pros & Cons
Pros
Works seamlessly on Darwin, Linux, and Windows, as evidenced by CI badges and explicit support mentioned in the README for diverse environments.
Functions as a backend for Apple's swift-log framework, enabling enhanced logging in Swift ecosystems with practical examples for Vapor integration.
Includes file log rotation with configurable size limits and archived file management, shown through RotationConfig examples for efficient log handling.
Allows deep customization of log output via the Formattable protocol, demonstrated in the LogFormatter example for tailored logging needs.
Cons
Lacks direct support for logging to cloud services or databases; custom loggers must be implemented via the Loggerable protocol, requiring additional development effort.
Configuring features like log rotation involves managing file URLs, permissions, and rotation parameters manually, which can be cumbersome compared to simpler libraries.
Being a Swift-specific library, it's not suitable for projects in other programming languages, restricting its use to Swift-based applications only.
Frequently Asked Questions
Related Projects
SwiftyBeaverConvenient & secure logging during development & release in Swift 4 & 5
XCGLoggerA debug log framework for use in Swift projects. Allows you to log details to the console (and optionally a file), just like you would have with NSLog() or print(), but with additional information, such as the date, function name, filename and line number.
TinyConsoleTinyConsole is a micro-console that can help you log and display information inside an iOS application, where having a connection to a development computer is not possible.
RainbowDelightful console output for Swift developers.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.