@gojob/winston-slack

Based on [wja-no/winston-slack](https://github.com/wja-no/winston-slack). Rewritten in TypeScript.

Usage no npm install needed!

<script type="module">
  import gojobWinstonSlack from 'https://cdn.skypack.dev/@gojob/winston-slack';
</script>

README

Based on wja-no/winston-slack. Rewritten in TypeScript.

Winston Transport for Slack chat integration.

npm install --save @gojob/winston-slack

Basic transport that works just like all other winston transports. Sends logged messages to a specified Slack chat channel.

Configuration options:

  • webhook_url: required The webhook URL, something like https://hooks.slack.com/services/XXXXXXXXX/YYYYYYYYY/ZZZZZZZZZZZZZZZZZZZZZZZZ
  • level: If specified, this logger will only log messages at the specified level of importance and more important messages
  • custom_formatter: a function (level, msg, meta) which returns a Slack payload object

Additionally, you can specify any Slack message parameters (such as username and channel), and it will be applied as a fallback if the given argument is not specified per message.

var winston = require('winston');
var Slack = require('@gojob/winston-slack');

winston.add(Slack, {
    webhook_url: "https://hooks.slack.com/services/XXXXXXXXX/YYYYYYYYY/ZZZZZZZZZZZZZZZZZZZZZZZZ",
    channel: "#test-channel",
    username: "ErrorBot",
    level: 'error',
    handleExceptions: true
});