winston-slackbotuser

Winston transport for logging as a Slack bot user

Showing:

Popularity

Downloads/wk

195

GitHub Stars

0

Maintenance

Last Commit

6yrs ago

Contributors

1

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

#winston-slackbotuser

Winston transport to log as a Slack bot user.

Installation

npm install winston-slackbotuser

Adds a new bot to your Slack team and write down the API Token.

Adds slackbotuser transport to winston with API token and channel set. You can either add the transport to the default winston logger.

winston.add(require('winston-slackbotuser'), {
    token: 'xoxb-1234567890-ABCDEFGHIJKLMNOPQRSTUVWX',
    channel: '#general'
});

Or with a new logger instance.

require('winston-slackbotuser');

new (winston.Logger)({
    transports: [
        new (winston.transports.SlackBotUser)({
            token: 'xoxb-1234567890-ABCDEFGHIJKLMNOPQRSTUVWX',
            channel: '#general'
        }
    ]
});

By default, slackbotuser log level is set to info. If you want to log debug messages, set the level option to debug.

Options

Sample set of options

{
    token: 'xoxb-1234567890-ABCDEFGHIJKLMNOPQRSTUVWX',
    channel: '#general',
    username: 'My Bot',
    as_user: true,
    parse: 'full',
    link_names: 1,
    unfurl_links: true,
    unfurl_media: false,
    icon_url: 'http://lorempixel.com/48/48',
    icon_emoji: ':japanese_goblin:',

    emojis: {
        debug: 'ant',
        warn: 'warning',
        error: 'fire'
    },
    level: 'debug',
    meta: true
}
NameExampleRequiredDescription
tokenxxxx-xxxxxxxxx-xxxxRequiredAPI Token for the bot user
channel#generalRequiredChannel to log to
usernameMy BotOptionalDisplay name of the bot user
as_usertrueOptionalPass true to post the message as the authed user, instead of as a bot
parsefullOptionalChange how messages are treated.
link_names1OptionalFind and link channel names and usernames.
unfurl_linkstrueOptionalPass true to enable unfurling of primarily text-based content.
unfurl_mediafalseOptionalPass false to disable unfurling of media content.
icon_urlhttp://lorempixel.com/48/48OptionalURL to an image to use as the icon for this message
icon_emoji:chart_with_upwards_trend:Optionalemoji to use as the icon for this message. Overrides icon_url.
prefix_emojis{ debug: ":ant:" }Optionalemoji to prefix when a specific log level is used.
levelinfoOptionalLog level.
metatrueOptionalPass false to disable logging metadata.

Please refer to Slack API for details of options. Attachments are currently unsupported.

Contributions

For issues, please provide a minimal repro and post the issue to GitHub issues.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial