Informer Slack Bot for Server Experiment

This is a simple slack bot usable with python environment which allows you to send your remote server's experiment status to slack environment easily.

Features

• Sending messages, warnings, errors to slack channels
• Sending progress of the experiment easily by inputing just percentage of the experiment
• Sending message as dump message Slackbot's error will not halt the code, which will not prevent main code to be running.
• Therefore, other exceptions will be handled afterwards.

Installation

1. Create Slack app from api.slack.com and get api token. More Specifically, please refer python-slack-sdk's install page.
2. Invite the bot created from step 1 to the channel you want to send messages.
3. pip install slack_sdk
4. copy slackBot.py to your working directory
5. from slackBot import slackBot, and you're good to go.

You can edit the location of the slackBot.py's location, but you need to edit the import location.

Post-Installation

On your code, you should call slackBot.SetToken('your-token') to set token to work correctly.

If there's no channel name with #server-bot, you should call slackBot.SetChannel('#channel-name') to set channel. Otherwise, will not work.

If you are running things on docker, ip address and pid will not shown normally. use slackBot.SetProcessInfo('name') to set name manually.

API

Please see the demo.py. Result of the demo.py is shown below.

Important Settings

slackBot.SetToken(token)

Mandatory. Sets the token for slackBot.

slackBot.SetProcessInfo(name)

Set Process Information manually. Useful on docker environment.

slackBot.SetChannel(channel)

Sets a channel to send message. If called again, it will change default channel. Sends a message to the channel.

Additional Settings

slackBot.ResetStartTime()

Resets startTime which used to calculate estimated time. Use this to measure more time specifically like just before start of the training.

slackBot.DisableLimit()

Disables limit that preventing slackBot sends way many messages in specific amount of seconds. This limit only affects on SendMessage, SendWarning, SendError.

slackBot.EnableLimit()

Enables limit that preventing slackBot sends way many messages in specific amount of seconds.

slackBot.SetTimezone(time)

Set timezone which will be added on time expression. If you're using docker environment, you should enter your timezone to get correct time.

• time(float) hours in GMT

Send Messages

These functions allows you to send custom messages, alerts to the bot. But, if you call too fast(5s) in one process, it will not send message for preventing spamming. Use DisableLimit to disable this feature.

slackBot.SendError(message, [channel])

Sends error-style message to the channel.

• message(string) should be provided. It shouldn't be empty.
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

slackBot.SendWarning(message, [channel])

Sends warning-style message to the channel.

• message(string) should be provided. It shouldn't be empty.
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

slackBot.SendMessage(message, [channel])

Sends message to the channel.

• message(string) should be provided. It shouldn't be empty.
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

Sending Signals

These functions will send signals to the channel.

slackBot.SendStartSignal([message, channel])

Sends start signal message to the channel.

• additional message can be set using message(string)
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

slackBot.SendEndSignal([message, channel])

Sends end signal message to the channel.

• additional message can be set using message(string)
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

slackBot.SendPing()

Sends a ping to currently set channel. Which can notice channel is set correctly.

Advanced Message Sending Methods

slackBot.SendProgress(progress, [estimated, length, message, channel])

Sends progress message to the channel.

• progress(float) should be a float value between 0 and 1
• If estimated(bool) is set to false, it will not print estimated time.
• If length(int) is set, it will change length of the progress bar. set to 0 to disable it.
• additional message can be set using message(string)
• provide channel(string) to send to specific channel. Otherwise, it will send to default channel or channel set by SetChannel.

example:

slackBot.SendProgress(0.4) # 40% Completed

slackBot.AppendDump(string)

Append string to dump string. If dump string's length is over dumpLength, it will send the message to the channel. After the code finishes executing, please call SendDump to execute remaining string.

• message(string), string to append to dump

slackBot.SendDump()

Send remaining dump string to the channel.

slackBot.SetDumpLength(length)

Set minimum length of the dump string, on the slack documentation, there are hard limit at 40,000 characters. Still, they ask us to keep messages under 4,000 bytes. Keep in mind when changing this value.

• length(int), length to set.

slackBot.ResetDump(string)

It resets dump string, and make it empty.