winston-slack-logger
v1.0.0
Published
Slack integration for Winston 3
Downloads
24
Maintainers
Readme
winston-slacker
Slack integration for Winston 3
Installing
$ npm install winston-slacker
This transport can be used like most standard Winston transports to send messages to a Slack channel.
Options
Standard options are support as well as the following additions:
webhook
: Your Slack channel's webhook URLchannel
: The channel to send messages to (with the#
like#general
)username
: The username to use for the message in SlackiconUrl
: URL for Slackbot avatariconImoji
: Emoji for Slackbot iconcustomFormatter
: Function used to format the message for Slack
var winston = require('winston');
var WinstonSlacker = require('winston-slacker');
var options = {
// Set options up
};
winston.add(new WinstonSlacker(options));
You are done configuring winston-slacker. Now it's time to use it!
// Log a message with winston
winston.log({
level: 'info',
message: 'User has logged in successfully.'
})
// Then, see in Slack:
// [info] User has logged in successfully.
Tests
To run tests run npm install
and then npm test
from the root directory in your shell.