Need help with SwiftyBeaver?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

SwiftyBeaver
5.0K Stars 378 Forks MIT License 577 Commits 2 Opened issues

Description

Convenient & secure logging during development & release in Swift 3, 4 & 5

Services available

!
?

Need anything else?

Contributors list

No Data

SwiftyBeaver
Colorful, flexible, lightweight logging for Swift 3, Swift 4 & Swift 5.
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 | Twitter | Privacy | License

Language Swift 2, 3, 4 & 5 CircleCI



During Development: Colored Logging to Xcode Console

Learn more about colored logging to Xcode 8 Console with Swift 3, 4 & 5. 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

swiftybeaver-demo1

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.





Installation

  • For Swift 4 & 5 install the latest SwiftyBeaver version
  • For Swift 3 install SwiftyBeaver 1.8.4
  • For Swift 2 install SwiftyBeaver 0.7.0


Carthage

You can use Carthage to install SwiftyBeaver by adding that to your Cartfile:

Swift 4 & 5:

Swift
github "SwiftyBeaver/SwiftyBeaver"

Swift 3:

Swift
github "SwiftyBeaver/SwiftyBeaver" ~> 1.8.4

Swift 2:

Swift
github "SwiftyBeaver/SwiftyBeaver" ~> 0.7


Swift Package Manager

For Swift Package Manager add the following package to your Package.swift file. Just Swift 4 & 5 are supported:

.package(url: "https://github.com/SwiftyBeaver/SwiftyBeaver.git", .upToNextMajor(from: "1.9.0")),


CocoaPods

To use CocoaPods just add this to your Podfile:

Swift 4 & 5:

Swift
pod 'SwiftyBeaver'

Swift 3: ``` Ruby target 'MyProject' do use_frameworks!

# Pods for MyProject pod 'SwiftyBeaver', '~> 1.8.4' end ```

Swift 2: ``` 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 ```



Usage

Add that near the top of your

AppDelegate.swift
to be able to use SwiftyBeaver in your whole project.
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 and then you can already do the following log level calls globally:
// 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", context: 123) // "DEBUG: age 123" log.info("my data", context: [1, "a", 2]) // "INFO: my data [1, "a", 2]"



Server-side Swift

We ❤️ server-side Swift 4 & 5 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
docker run --rm -it -v $PWD:/app swiftybeaver /bin/bash -c "cd /app ; swift build ; swift test"

optionally log into container to run Swift CLI and do more stuff

docker run --rm -it --privileged=true -v $PWD:/app swiftybeaver

Best: for the popular server-side Swift web framework Vapor you can use our Vapor logging provider which makes server logging awesome again 🙌



Documentation

Getting Started:

Logging Destinations:

Advanced Topics:

Stay Informed:



Privacy

SwiftyBeaver is not collecting any data without you as a developer knowing about it. That's why it is open-source and developed in a simple way to be easy to inspect and check what it is actually doing under the hood.

The only sending to servers is done if you use the

SBPlatformDestination
. That destination is meant for production logging and on default it sends your logs plus additional device information end-to-end encrypted to our cloud service. Our cloud service can not decrypt the data.

Instead, you install our Mac App and that Mac App downloads the encrypted logs from the cloud and decrypts and shows them to you. Additionally, the Mac App stores all data that it downloads in a local SQLite database file on your computer so that you actually "physically" own your data.

The business model of the SwiftyBeaver cloud service is to provide the most secure logging solution in the market. On purpose we do not provide a web UI for you because it would require us to store your encryption key on our servers.

Only you can see the logging and device data which is sent from your users' devices. Our servers just see encrypted data and do not know your decryption key.

SwiftyBeaver is fully GDPR compliant due to its focus on encryption and transparency in what data is collected and also meets Apple’s latest requirements on the privacy of 3rd party frameworks.

Our Enterprise offering is an even more secure solution where you are not using anymore our cloud service and Mac App but you send your end-to-end encrypted logs directly to your own servers and you store them in your Elasticsearch cluster. The Enterprise offering is used by health tech and governmental institutions which require the highest level of privacy and security.



End-to-End Encryption

SwiftyBeaver is using symmetric AES256CBC encryption in the

SBPlatformDestination
destination. No other officially supported destination uses encryption.

The encryption used in the

SBPlatformDestination
destination is end-to-end. The open-source SwiftyBeaver logging framework symmetrically encrypts all logging data on your client's device inside your app (iPhone, iPad, ...) before it is sent to the SwiftyBeaver Crypto Cloud. The decryption is done on your Mac which has the SwiftyBeaver Mac App installed. All logging data stays encrypted in the SwiftyBeaver Crypto Cloud due to the lack of the password.

You are using the encryption at your own risk. SwiftyBeaver’s authors and contributors do not take over any guarantee about the absence of potential security or cryptopgraphy issues, weaknesses, etc.; please also read the LICENSE file for details. Also if you are interested in cryptography in general, please have a look at the file AES256CBC.swift to learn more about the cryptographical implementation.

License

SwiftyBeaver Framework is released under the MIT License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.