Swiftpack.co - Package - vapor-community/swiftybeaver-provider

Swift Version Vapor Version SwiftyBeaver Version Linux Build Status codecov GitHub license

SwiftyBeaver Logging Provider for Vapor

Adds the powerful logging of SwiftyBeaver to Vapor for server-side Swift 4 on Linux and Mac.

Installation

Add this project to the Package.swift dependencies of your Vapor project:

  .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.

Service registration

First, register the SwiftyBeaverProvider in your `configure.swift' file.

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

Basic

The configuration consist of an array of destinations. Here is an example of a simple SwiftyBeaver configuration file to configure console, file and swiftybeaver platform destinations with their required properties.

Config/swiftybeaver.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

Use

router.get("hello") { req -> Future<String> 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 and how to set a custom logging format.

Output to Xcode 8 Console

Learn more about colored logging to Xcode 8 Console.

Output to File

Learn more about logging to file which is great for Terminal.app fans or to store logs on disk.

Output to Cloud & Mac App

swiftybeaver-demo1

Learn more about logging to the SwiftyBeaver Platform during release!

Learn More

Get support via Github Issues, email and our public Slack channel.

Credits

This package is developed and maintained by Gustavo Perdomo with the collaboration of all vapor community.

License

SwiftyBeaverProvider is released under the MIT License.

Github

link
Stars: 21
Help us keep the lights on

Releases

3.0.0 - May 10, 2018

Changes:

  • Update Vapor to 3.0.0 Release

3.0.0-rc.2 - Apr 30, 2018

Changes since RC 1

  • Add support to serverURL and analyticsUserName to SBPlatform destination

3.0.0-rc.1 - Apr 20, 2018

Changes:

  • Update to Vapor 3 RC 2.7

3.0.0-beta.3 - Feb 14, 2018

Changes since beta.2

  • Support for Vapor 3.0.0-beta.3

3.0.0-beta.2 - Feb 12, 2018

Changes since beta.1

  • Support for Vapor 3.0.0-beta.1
  • Improved service registration