superslacker 0.4

superslacker plugin for supervisord

Superslacker

Superslacker is a supervisor "event listener" that sends events from processes that run under supervisor to Slack. When superslacker receives an event, it sends a message notification to a configured Slack channel.

superslacker uses Slacker full-featured Python interface for the Slack API.

Installation

pip install superslacker

Command-Line Syntax

$ superslacker [-t token] [-c channel] [-n hostname] [-w webhook] [-a attachment] [-e events]

Options

-t TOKEN, --token=TOKEN

Post a message to Slack using Slack Web API. In order to be able to send messages to Slack, you need to generate your token by registering your application. More info can be found here

-c CHANNEL, --channel=CHANNEL

#channel to fill with your crash messages.

-n HOSTNAME, --hostname=HOSTNAME

Name or identificator of the machine where the events are been generated. This goes in the event message.

-w WEBHOOK, --webhook=WEBHOOK

Post a message to Slack using Slack Incoming WebHook. In order to be able to send messages to Slack, you need to configure an Incoming WebHook for your Slack account. More info can be found here

-e EVENTS, --event=EVENTS

The Supervisor Process State event(s) to listen for. It can be any, one of, or all of STARTING, RUNNING, BACKOFF, STOPPING, EXITED, STOPPED, UNKNOWN.

-i ICON_EMOJI, --icon=ICON_EMOJI

To customize the Slackmoji to be used as icon. Defaults to :sos:.

-u USERNAME, --username=USERNAME

To customize the Slack username. Defaults to superslacker.

Notes

:ghost: gonna be used as an icon for the message and superslacker as a username.

Configuration

An [eventlistener:x] section must be placed in supervisord.conf in order for superslacker to do its work. See the “Events” chapter in the Supervisor manual for more information about event listeners.

The following example assume that superslacker is on your system PATH.

[eventlistener:superslacker]
command=superslacker --token="slacktoken-slacktoken-slacktoken" --channel="#notifications" --hostname="HOST" --events="UNKNOWN,STOPPING"
events=PROCESS_STATE,TICK_60

0.4 (2019-11-15)

Customize Slack username and icon. (Thanks to David Guillot)

0.3 (2018-09-01)

• Make events to watch configurable (Thanks to Ifiok Idiang @ifiok)

0.2 (2017-07-18)

• Add support for incoming webhooks (Thanks to Roman Zhuzha)

0.1 (2016-06-27)

• refactor

0.02 (2015-10-30)

• Copyright and Package fixes.

0.01 (2015-10-30)

• Initial release