https://github.com/wlisac/swift-log-slack

A logging backend for SwiftLog that sends log messages to Slack.
https://github.com/wlisac/swift-log-slack

slack swiftlog

Last synced: about 3 hours ago
JSON representation

A logging backend for SwiftLog that sends log messages to Slack.

• Host: GitHub
• URL: https://github.com/wlisac/swift-log-slack
• Owner: wlisac
• License: mit
• Created: 2020-02-16T06:58:32.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-30T09:47:00.000Z (almost 4 years ago)
• Last Synced: 2024-10-15T23:02:40.570Z (about 1 month ago)
• Topics: slack, swiftlog
• Language: Swift
• Homepage:
• Size: 299 KB
• Stars: 75
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# LoggingSlack

![swift](https://img.shields.io/badge/Swift-5.1-orange.svg)

![platforms](https://img.shields.io/badge/platforms-macOS%20%7C%20Linux%20%7C%20iOS%20%7C%20tvOS%20%7C%20watchOS-lightgrey.svg)

![version](https://img.shields.io/badge/version-0.1.0-blue.svg)

[![twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/wlisac)




[![build](https://travis-ci.com/wlisac/swift-log-slack.svg?branch=master)](https://travis-ci.com/wlisac/swift-log-slack)

[![jazzy](https://raw.githubusercontent.com/wlisac/swift-log-slack/gh-pages/badge.svg?sanitize=true)](https://wlisac.github.io/swift-log-slack/Structs/SlackLogHandler.html)

[![codecov](https://img.shields.io/codecov/c/github/wlisac/swift-log-slack)](https://codecov.io/gh/wlisac/swift-log-slack)

Welcome to **LoggingSlack** – a logging backend for [SwiftLog](https://github.com/apple/swift-log) that sends critical log messages to Slack.

## Usage

### Setup Incoming Webhooks

LoggingSlack uses [Incoming Webhooks](https://slack.com/apps/A0F7XDUAZ-incoming-webhooks) to send log messages to a Slack channel.

Once you've setup Incoming Webhooks, you should have a webhook URL that you can use to configure LoggingSlack.

### Bootstrap SwiftLog

LoggingSlack is intended to be used as a secondary logging backend to send critical log messages directly to Slack.

You can use SwiftLog's `MultiplexLogHandler` to setup LoggingSlack with another logging backend.

```swift

import Logging

import LoggingSlack

let webhookURL = URL(string: "https://hooks.slack.com/services/T1MGQL1L8/RM2LE5QLF/YH036NhldqitdR1lVd5NLS6z")!

LoggingSystem.bootstrap { label in

    MultiplexLogHandler([

        // Setup SlackLogHandler with a webhook URL 

        SlackLogHandler(label: label, webhookURL: webhookURL),

        // Setup the standard logging backend to enable console logging

        StreamLogHandler.standardOutput(label: label)

    ])

}

```

### Using a Logger

You can now use SwiftLog as usual and critical log messages are sent directly to Slack.

```swift

import Logging

let logger = Logger(label: "com.example.ExampleApp.main")

logger.critical("Something went wrong!")

```

### Logger Output

The logger will output a Slack message and a console message since both logging backends were setup.



```plain

2020-02-15T19:30:00-0800 critical: Something went wrong!

```

### Log Level Threshold

Only `critical` [log level](https://github.com/apple/swift-log#log-levels) messages are sent to Slack by default.

You can adjust the log level threshold by changing the `globalLogLevelThreshold` static property on `SlackLogHandler`.

For example, this will configure LoggingSlack to send all `error` log level and above messages to Slack.

```swift

SlackLogHandler.globalLogLevelThreshold = .error

```

## API Documentation

Visit the [online API reference](https://wlisac.github.io/swift-log-slack/Structs/SlackLogHandler.html) for full documentation of the public API.

## Installation

LoggingSlack requires Xcode 11 or a Swift 5.1 toolchain with the Swift Package Manager. 

### Swift Package Manager

Add the LoggingSlack package as a dependency to your `Package.swift` file.

```swift

.package(url: "https://github.com/wlisac/swift-log-slack.git", from: "0.1.0")

```

Add LoggingSlack to your target's dependencies.

```swift

.target(name: "Example", dependencies: ["LoggingSlack"])

```