slack-winston-transport
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

slack-winston-transport

MIT License

Index

Install

npm install -S winston slack-winston-transport

Usage

var winston = require('winston')
var slackWinston = require('slack-winston').Slack

var options = {
  domain: 'my-domain',
  webhook_url: 'my-slack-incoming-webhook-url',
  channel: 'general',
  level: 'warn'
}

winston.add(slackWinston, options)

Many options can be seen in the Slack API docs.

  • level: Level of messages that this transport should log
  • silent: If true, will not log messages
  • webhook_url: Required. Slack incoming webhook url.
  • channel: Required. Channel of chat (e.g. "#foo" or "@foo")
  • domain: Required. Domain of Slack (e.g. "foo" if "foo.slack.com")
  • username: Username of the incoming webhook Slack bot
  • icon_emoji: Icon of bot
  • message: lodash templates. Gets passed the {{message}}, {{level}}, and {{meta}} as a JSON string. If not specified, it will print a default of {{message}}\n\n{{meta}}. Note that this gets sent as the text field in the payload per Slack requirements.
  • queueDelay: Delay time (ms) between messages in queue (defaults to 500)

Credits

This module is a fork of slack-winston by Nick Baugh with some updates.

License

MIT

Package Sidebar

Install

npm i slack-winston-transport

Weekly Downloads

2

Version

1.0.2

License

none

Last publish

Collaborators

  • bluehat