Puppy
Puppy is a flexible logging library written in Swift
🐶
It supports multiple transports(console, file, syslog, and oslog) as loggers. It not only works alone, but also as a backend for apple/swift-log. Furthermore, it has file log rotation feature and you can also customize the log format as you like.
Features
- Written in Swift.
- Supports both Darwin and Linux.
- Supports console, file, syslog, and oslog as loggers.
- Supports automatic log rotation about file logger.
- Also Works as a backend for
apple/swift-log.
Examples
Basic Usage
Logging to mutliple transports(e.g. console and file). It is recommended that the first argument of each logger be a unique reverse-order FQDN since it is also used internally for a DispatchQueue's label.
import Puppy
let console = ConsoleLogger("com.example.yourapp.console")
let fileURL = URL(fileURLWithPath: "./foo.log").absoluteURL
let file = FileLogger("com.example.yourapp.file", fileURL: fileURL)
let log = Puppy()
// Set the logging level.
log.add(console, withLevel: .warning)
log.add(file, withLevel: .warning)
log.debug("DEBUG message") // Will NOT be logged.
log.error("ERROR message") // Will be logged.
Use with apple/swift-log
Logging to mutliple transports(e.g. console and syslog) as a backend for apple/swift-log.
import Puppy
import Logging
let console = ConsoleLogger("com.example.yourapp.console")
let syslog = SystemLogger("com.example.yourapp.syslog")
let puppy = Puppy.default
puppy.add(console)
puppy.add(syslog)
LoggingSystem.bootstrap {
var handler = PuppyLogHandler(label: $0, puppy: puppy)
// Set the logging level.
handler.logLevel = .trace
return handler
}
log.trace("TRACE message") // Will be logged.
log.debug("DEBUG message") // Will be logged.
Use file log rotation
Logging to file and use log rotation feature.
import Puppy
class ViewController: UIViewController {
let delegate = SampleFileRotationDelegate()
override func viewDidLoad() {
super.viewDidLoad()
let fileRotation = try! FileRotationLogger("com.example.yourapp.filerotation",
fileURL: "./rotation/foo.log")
fileRotation.maxFileSize = 10 * 1024 * 1024
fileRotation.maxArchivedFilesCount = 5
fileRotation.delegate = delegate
let log = Puppy()
log.add(fileRotation)
log.info("INFO message")
log.warning("WARNING message")
}
}
class SampleFileRotationDelegate: FileRotationLoggerDeletate {
func fileRotationLogger(_ fileRotationLogger: FileRotationLogger,
didArchiveFileURL: URL, toFileURL: URL) {
print("didArchiveFileURL: \(didArchiveFileURL), toFileURL: \(toFileURL)")
}
func fileRotationLogger(_ fileRotationLogger: FileRotationLogger,
didRemoveArchivedFileURL: URL) {
print("didRemoveArchivedFileURL: \(didRemoveArchivedFileURL)")
}
}
Customize the log format
Customize the log format using Formattable protocol. Logging to oslog for example.
import Puppy
class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
let oslog = OSLogger("com.yourapp.oslog")
oslog.format = LogFormatter()
let log = Puppy()
log.add(oslog)
log.info("INFO message")
log.warning("WARNING message")
}
}
class LogFormatter: LogFormattable {
func formatMessage(_ level: LogLevel, message: String, tag: String, function: String,
file: String, line: UInt, swiftLogInfo: [String : String],
label: String, date: Date, threadID: UInt64) -> String {
let date = dateFormatter(date)
let file = shortFileName(file)
return "\(date) \(threadID) [\(level.emoji) \(level)] \(file)#L.\(line) \(function) \(message)"
}
}
License
Puppy is available under the MIT license. See the LICENSE file for details.
509 Dec 10, 2022
290 Nov 15, 2022
28 Jul 6, 2022
12 Jul 28, 2021
52 Oct 28, 2022
12.9k Jan 9, 2023
5k Dec 22, 2022
1.3k Nov 16, 2022
5.6k Jan 4, 2023
1.3k Dec 8, 2022
777 Jul 15, 2022
174 Nov 30, 2022
825 Nov 6, 2022
361 Jun 29, 2022
199 Jan 2, 2023
72 Aug 12, 2022
1 Jan 10, 2022
0 May 30, 2022