Slack action¶
This action allows you to send custom messages to a Slack channel (or user) using a bot when your monitor suites finish their execution.
To use this action you need to:
Install slackclient 2.0 or higher:
$ pip install "slackclient>=2.0"Provide the Slack credentials in your
settings.pyfile as follows:
# settings.py
SPIDERMON_SLACK_SENDER_TOKEN = '<SLACK_SENDER_TOKEN>'
SPIDERMON_SLACK_SENDER_NAME = '<SLACK_SENDER_NAME>'
SPIDERMON_SLACK_RECIPIENTS = ['@yourself', '#yourprojectchannel']
A notification will look like the following one:
Follow these steps to configure your Slack bot.
The following settings are the minimum needed to make this action works:
SPIDERMON_SLACK_RECIPIENTS¶
List of recipients of the message. It could be a channel or an user.
SPIDERMON_SLACK_SENDER_NAME¶
Username of your bot.
SPIDERMON_SLACK_SENDER_TOKEN¶
Bot User OAuth Access Token of your bot.
Warning
Be careful when using bot user tokens in Spidermon. Do not publish bot user tokens in public code repositories.
Other settings available:
SPIDERMON_SLACK_ATTACHMENTS¶
SPIDERMON_SLACK_ATTACHMENTS_TEMPLATE¶
SPIDERMON_SLACK_FAKE¶
Default: False
If set True, the Slack message content will be in the logs but nothing will be sent.