README

crash-to-slack

A simple module to log uncaught exceptions to a slack channel via incoming webhooks.

This module simplifies the interface to winston + slack-winston

Its only purpose is to get my attention on a Slack channel when an Uncaught exception happens.

Installation

npm install crash-to-slack

Usage

var crash2slack = require("crash-to-slack");

crash2slack({
  // Your slack team domain (without the .slack.com part)
  domain: "yourteam",
  // The token for your incoming webhook
  token: "I8DW21WtcINIBwjD45kysi2U",
  // The channel where you wish to be notified
  channel: "#backend-crashes",
});

API

var crash2slack = require("crash-to-slack");
crash2slack(options);

crash2slack(options)

The options are directly passed to a slack-winston instance.

NOTE: If any of the required options is not passed, crash-to-slack will do nothing at all.

token: Required. Slack incoming webhook token
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 (defaults to "Winston")
icon_emoji: Icon of bot (defaults to :tophat: :tophat:)
level: Level of messages that this transport should log
silent: If true, will not log messages
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.

LICENSE

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!