Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shivahuang/swift-log-swiftybeaver
A logging backend for SwiftLog that sends log messages to SwiftyBeaver.
https://github.com/shivahuang/swift-log-swiftybeaver
logging swift swift-framework swiftybeaver
Last synced: about 2 months ago
JSON representation
A logging backend for SwiftLog that sends log messages to SwiftyBeaver.
- Host: GitHub
- URL: https://github.com/shivahuang/swift-log-swiftybeaver
- Owner: ShivaHuang
- License: mit
- Created: 2021-07-21T18:27:36.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T12:49:27.000Z (3 months ago)
- Last Synced: 2024-10-01T09:21:04.280Z (3 months ago)
- Topics: logging, swift, swift-framework, swiftybeaver
- Language: Swift
- Homepage:
- Size: 5.86 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LoggingSwiftyBeaver
[](https://twitter.com/shivahuang)
A logging backend for [SwiftLog](https://github.com/apple/swift-log) that sends log messages to [SwiftyBeaver](https://swiftybeaver.com).
## Installation 📦
Add the LoggingSwiftyBeaver package as a dependency to your `Package.swift` file.
```swift
.package(url: "https://github.com/ShivaHuang/swift-log-SwiftyBeaver.git", from: "0.1.0")
```
Add LoggingSwiftyBeaver to your target's dependencies.
```swift
.target(
name: "Example",
dependencies: [
.product(name: "LoggingSwiftyBeaver", package: "swift-log-SwiftyBeaver")
])
```
## Usage 📝
### 1. Let's import the logging API package:
```swift
import Logging
import LoggingSwiftyBeaver
```
### 2. Create a `logger`, the label works similarly to a `DispatchQueue` label:
```swift
let logger = Logger(label: "Example") { (label) in
SwiftyBeaver.LogHandler(label, destinations: [
ConsoleDestination()
])
}
```
Alternatively, you can use `SwiftyBeaver` only in `DEBUG` build and don't print anything in `RELEASE` build:
```swift
let logger: Logger = {
Logger(label: "Example") { (label) in
#if DEBUG
return SwiftyBeaver.LogHandler(label, destinations: [
ConsoleDestination()
])
#else
return Logging.SwiftLogNoOpLogHandler()
#endif
}
}()
```
Futher, you can custom format and set console output to short time, log level & message:
```swift
let logger: Logger = {
Logger(label: "Example") { (label) in
#if DEBUG
let console: ConsoleDestination = {
let destination = ConsoleDestination()
destination.format = "$DHH:mm:ss$d $L $M"
return destination
}()
return SwiftyBeaver.LogHandler(label, destinations: [
console
])
#else
return Logging.SwiftLogNoOpLogHandler()
#endif
}
}()
```
### 3. We're now ready to use it:
```swift
// logging an informational message
logger.info("Hello World!")
// ouch, something went wrong
logger.error("Houston, we have a problem: \(problem)")
```
## Log Levels 💜💚💙💛❤️
It's a good habit to distinguish logs by levels. However, `SwiftLog` defines 7 levels while `SwiftyBeaver` has only 5. So an 1-to-1 mapping between `SwiftLog` and `SwiftyBeaver` is not possible. Following is a table for the mapping:
| SwiftLog | SwiftyBeaver |
| ---------- | ------------ |
| `trace` | `verbose` |
| `debug` | `debug` |
| `info` | `info` |
| `notice` | `warning` |
| `warning` | `warning` |
| `error` | `error` |
| `critical` | `error` |
## Origin 🗄
This program was developed by [@shivahuang](https://github.com/ShivaHuang) as part of [Taiwan Social Distancing](https://github.com/ailabstw/social-distancing-ios).