Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vapor-community/swiftybeaver-provider
SwiftyBeaver Logging Provider for Vapor, the server-side Swift web framework https://swiftybeaver.com
https://github.com/vapor-community/swiftybeaver-provider
logging swift-3 swiftybeaver vapor
Last synced: 2 months ago
JSON representation
SwiftyBeaver Logging Provider for Vapor, the server-side Swift web framework https://swiftybeaver.com
- Host: GitHub
- URL: https://github.com/vapor-community/swiftybeaver-provider
- Owner: vapor-community
- License: mit
- Created: 2017-05-18T17:05:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T20:08:48.000Z (about 5 years ago)
- Last Synced: 2024-09-29T22:21:20.920Z (3 months ago)
- Topics: logging, swift-3, swiftybeaver, vapor
- Language: Swift
- Homepage:
- Size: 81.1 KB
- Stars: 33
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://swift.org)
[](https://vapor.codes)
[](https://github.com/SwiftyBeaver/SwiftyBeaver)
[](https://circleci.com/gh/vapor-community/swiftybeaver-provider)
[](https://codecov.io/gh/vapor-community/swiftybeaver-provider)
[](LICENSE)
# SwiftyBeaver Logging Provider for Vapor
Adds the powerful logging of [SwiftyBeaver](https://github.com/SwiftyBeaver/SwiftyBeaver) to [Vapor](https://github.com/vapor/vapor) for server-side Swift 4 on Linux and Mac.
## Installation
Add this project to the `Package.swift` dependencies of your Vapor project:
```swift
.package(url: "https://github.com/vapor-community/swiftybeaver-provider.git", from: "3.0.0")
```
## Setup
After you've added the SwiftyBeaver Provider package to your project, setting the provider up in code is easy.
You can configure your SwiftyBeaver instance in a pure swift way or using a JSON file like Vapor 2 do,
### Register using a pure swift way
```swift
import SwiftBeaverProvider
public func configure(_ config: inout Config, _ env: inout Environment, _ services: inout Services ) throws {
// ...
// Setup your destinations
let console = ConsoleDestination()
console.minLevel = .info // update properties according to your needs
let fileDestination = FileDestination()
// Register the logger
services.register(SwiftyBeaverLogger(destinations: [console, fileDestination]), as: Logger.self)
// Optional
config.prefer(SwiftyBeaverLogger.self, for: Logger.self)
}
```
### Register using a JSON file
First, register the SwiftyBeaverProvider in your `configure.swift` file.
```swift
import SwiftBeaverProvider
public func configure(_ config: inout Config, _ env: inout Environment, _ services: inout Services ) throws {
// ...
// Register providers first
try services.register(SwiftyBeaverProvider())
// Optional
config.prefer(SwiftyBeaverLogger.self, for: Logger.self)
}
```
#### Configure Destinations
If you run your application now, you will likely see an error that the SwiftyBeaver configuration file is missing. Let's add that now
The configuration consist of an array of destinations located in `Config/swiftybeaver.json` file. Here is an example of a simple SwiftyBeaver configuration file to configure console, file and swiftybeaver platform destinations with their required properties.
```json
[
{
"type": "console",
"format": " $Dyyyy-MM-dd HH:mm:ss.SSS$d $C$L$c: $M"
},
{
"type": "file"
},
{
"type": "platform",
"app": "YOUR_APP_ID",
"secret": "YOUR_SECRET_ID",
"key": "YOUR_ENCRYPTION_KEY"
}
]
```
Aditional options:
| KEY | AVAILABLE FOR | TYPE | OBSERVATION |
| ------------------- | ----------------------- | ------ | -------------------------------------------- |
| async | console, file | Bool | |
| format | console, file | String | A space must be placed before dollar sign |
| levelString.debug | console, file | String | |
| levelString.error | console, file | String | |
| levelString.info | console, file | String | |
| levelString.verbose | console, file | String | |
| levelString.warning | console, file | String | |
| path | file | String | path to the log file |
| minLevel | console, file, platform | String | values: verbose, debug, info, warning, error |
| threshold | platform | Int | min: 1, max: 1000 |
> Note:
> \
> It's a good idea to store the SwiftyBeaver configuration file in the Config/secrets folder since it contains sensitive information.
> \
> \
> To get more information about configuration options check the official [SwiftyBeaver docs](https://docs.swiftybeaver.com/)
## Use
```swift
router.get("hello") { req -> Future in
// Get a logger instance
let logger: Logger = try req.make(SwiftyBeaverLogger.self)
// Or
let logger: Logger = try req.make(Logger.self) // needs config.prefer(SwiftyBeaverLogger.self, for: Logger.self) in configure.swift
logger.info("Logger info")
return Future("Hello, world!")
}
```
Please also see the SwiftyBeaver [destination docs](http://docs.swiftybeaver.com/category/8-logging-destinations) and how to set a [custom logging format](http://docs.swiftybeaver.com/category/19-advanced-topics).
## Output to Xcode 8 Console
[Learn more](http://docs.swiftybeaver.com/article/9-log-to-xcode-console) about colored logging to Xcode 8 Console.
## Output to File
[Learn more](http://docs.swiftybeaver.com/article/10-log-to-file) about logging to file which is great for Terminal.app fans or to store logs on disk.
## Output to Cloud & Mac App
[Learn more](http://docs.swiftybeaver.com/article/11-log-to-swiftybeaver-platform) about logging to the SwiftyBeaver Platform **during release!**
## Learn More
- [Website](https://swiftybeaver.com)
- [SwiftyBeaver Framework](https://github.com/SwiftyBeaver/SwiftyBeaver)
- [Documentation](http://docs.swiftybeaver.com/)
- [Medium Blog](https://medium.com/swiftybeaver-blog)
- [On Twitter](https://twitter.com/SwiftyBeaver)
Get support via Github Issues, email and our public Slack channel.
## Credits
This package is developed and maintained by [Gustavo Perdomo](https://github.com/gperdomor) with the collaboration of all vapor community.
## License
SwiftyBeaverProvider is released under the [MIT License](LICENSE).