Colorful, flexible, lightweight logging for Swift 2, Swift 3 & Swift 4.
Great for development & release with support for Console, File & cloud platforms.
Log during release to the conveniently built-in SwiftyBeaver Platform, the dedicated Mac App & Elasticsearch!
Docs | Website | Slack | Twitter | License
During Development: Colored Logging to Xcode Console
Learn more about colored logging to Xcode 8 Console with Swift 3 & 4. For Swift 2.3 use this Gist. No need to hack Xcode 8 anymore to get color. You can even customize the log level word (ATTENTION instead of ERROR maybe?), the general amount of displayed data and if you want to use the 💜s or replace them with something else 😉
During Development: Colored Logging to File
Learn more about logging to file which is great for Terminal.app fans or to store logs on disk.
On Release: Encrypted Logging to SwiftyBeaver Platform
Learn more about logging to the SwiftyBeaver Platform during release!
Browse, Search & Filter via Mac App
Conveniently access your logs during development & release with our free Mac App.
On Release: Enterprise-ready Logging to Your Elasticsearch & Kibana (on-premise)
Learn more about legally compliant, end-to-end encrypted logging to Elasticsearch with SwiftyBeaver Enterprise. Install via Docker or manual, fully-featured free trial included!
Google Cloud & More
You can fully customize your log format, turn it into JSON, or create your own destinations. For example our Google Cloud Destination is just another customized logging format which adds the powerful functionality of automatic server-side Swift logging when hosted on Google Cloud Platform.
- For Swift 3 & 4 install the latest SwiftyBeaver version
- For Swift 2 install SwiftyBeaver 0.7.0
You can use Carthage to install SwiftyBeaver by adding that to your Cartfile:
Swift 3 & 4: ``` Swift github "SwiftyBeaver/SwiftyBeaver"
Swift github "SwiftyBeaver/SwiftyBeaver" ~> 0.7
<br/> ### Swift Package Manager For [Swift Package Manager](https://swift.org/package-manager/) add the following package to your Package.swift file. Just Swift 3 & 4 are supported:
Swift .Package(url: "https://github.com/SwiftyBeaver/SwiftyBeaver.git", majorVersion: 1)
<br/> ### CocoaPods We plan to discontinue the support for CocoaPods due to its issues with latest Xcode and Swift versions latest at the end of 2018. Please use Carthage or SPM instead to stay on top of new SwiftyBeaver releases. To use [CocoaPods](https://cocoapods.org) just add this to your Podfile: Swift 3 & 4:
Swift pod 'SwiftyBeaver'
Ruby target 'MyProject' do use_frameworks!
# Pods for MyProject pod 'SwiftyBeaver', '~> 0.7' end
postinstall do |installer| installer.podsproject.buildconfigurations.each do |config| # Configure Pod targets for Xcode 8 with Swift 2.3 config.buildsettings['SWIFT_VERSION'] = '2.3' end end
<br/> <br/> ## Usage Add that near the top of your `AppDelegate.swift` to be able to use SwiftyBeaver in your whole project.
Swift import SwiftyBeaver let log = SwiftyBeaver.self
At the the beginning of your `AppDelegate:didFinishLaunchingWithOptions()` add the SwiftyBeaver log destinations (console, file, etc.), optionally adjust the [log format](http://docs.swiftybeaver.com//article/20-custom-format) and then you can already do the following log level calls globally:
Swift // add log destinations. at least one is needed! let console = ConsoleDestination() // log to Xcode Console let file = FileDestination() // log to default swiftybeaver.log file let cloud = SBPlatformDestination(appID: "foo", appSecret: "bar", encryptionKey: "123") // to cloud
// use custom format and set console output to short time, log level & message console.format = "$DHH:mm:ss$d $L $M" // or use this for JSON output: console.format = "$J"
// add the destinations to SwiftyBeaver log.addDestination(console) log.addDestination(file) log.addDestination(cloud)
// Now let’s log! log.verbose("not so important") // prio 1, VERBOSE in silver log.debug("something to debug") // prio 2, DEBUG in green log.info("a nice information") // prio 3, INFO in blue log.warning("oh no, that won’t be good") // prio 4, WARNING in yellow log.error("ouch, an error did occur!") // prio 5, ERROR in red
// log anything! log.verbose(123) log.info(-123.45678) log.warning(Date()) log.error(["I", "like", "logs!"]) log.error(["name": "Mr Beaver", "address": "7 Beaver Lodge"])
// optionally add context to a log message console.format = "$L: $M $X" log.debug("age", 123) // "DEBUG: age 123" log.info("my data", context: [1, "a", 2]) // "INFO: my data [1, \"a\", 2]"
<br/> <br/> ## Server-side Swift We ❤️ server-side Swift 3 & 4 and SwiftyBeaver supports it **out-of-the-box**! Try for yourself and run SwiftyBeaver inside a Ubuntu Docker container. Just install Docker and then go to your the project folder on macOS or Ubuntu and type:
create docker image, build SwiftyBeaver and run unit tests
swift build --clean && docker build --rm -t swiftybeaver .
optionally log into container to run Swift CLI and do more stuff
docker run --rm -it --privileged=true -v $PWD:/app swiftybeaver ```
- Colored Logging to Xcode Console
- Colored Logging to File
- Encrypted Logging & Analytics to SwiftyBeaver Platform
- Encrypted Logging & Analytics to Elasticsearch & Kibana
More destination & system documentation is coming soon!
Get support via Github Issues, email and public Slack channel.
SwiftyBeaver Framework is released under the MIT License.