Skip to content

Update slack notification formatting #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MetcalfeTom wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Update slack notification formatting #34

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
46ec29e
Update starting message format
MetcalfeTom Dec 26, 2019
0f5f717
Update success message formatting
MetcalfeTom Dec 26, 2019
9223353
Fix formatting
MetcalfeTom Dec 26, 2019
6fcf11a
Update error formatting
MetcalfeTom Dec 26, 2019
58ac7e3
reformat code
MetcalfeTom Dec 26, 2019
b3de6c0
Extract messages and training time formatting methods
MetcalfeTom Dec 26, 2019
30c088a
docstrings
MetcalfeTom Dec 26, 2019
33e5c25
Update README
MetcalfeTom Dec 26, 2019
7e34a8a
Add days, swap _add_mentions order, use slack code formatting where a…
MetcalfeTom Mar 10, 2020
e4b6af5
Fix mentions and return val
MetcalfeTom Mar 10, 2020
6cbb3c0
Remove channel and dump
MetcalfeTom Mar 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Note that launching this will asks you for the sender's email password. It will

### Slack

Similarly, you can also use Slack to get notifications. You'll have to get your Slack room [webhook URL](https://api.slack.com/incoming-webhooks#create_a_webhook) and optionally your [user id](https://api.slack.com/methods/users.identity) (if you want to tag yourself or someone else).
Similarly, you can also use Slack to get notifications. You'll have to get your Slack room [webhook URL](https://api.slack.com/incoming-webhooks#create_a_webhook) and optionally your username (if you want to tag yourself or someone else).

#### Python

Expand All @@ -77,7 +77,7 @@ def train_your_nicest_model(your_nicest_parameters):
return {'loss': 0.9} # Optional return value
```

You can also specify an optional argument to tag specific people: `user_mentions=[<your_slack_id>, <grandma's_slack_id>]`.
You can also specify an optional argument to tag specific people: `user_mentions=[<your_slack_username>, <grandma's_slack_username>]`.

#### Command-line

Expand Down
201 changes: 160 additions & 41 deletions knockknock/slack_sender.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

DATE_FORMAT = "%Y-%m-%d %H:%M:%S"


def slack_sender(webhook_url: str, channel: str, user_mentions: List[str] = []):
"""
Slack sender wrapper: execute func, send a Slack notification with the end status
Expand All @@ -21,7 +22,7 @@ def slack_sender(webhook_url: str, channel: str, user_mentions: List[str] = []):
`channel`: str
The slack room to log.
`user_mentions`: List[str] (default=[])
Optional users ids to notify.
Optional usernames to notify.
Visit https://api.slack.com/methods/users.identity for more details.
"""

Expand All @@ -30,6 +31,10 @@ def slack_sender(webhook_url: str, channel: str, user_mentions: List[str] = []):
"channel": channel,
"icon_emoji": ":clapper:",
}

if user_mentions:
user_mentions = ["@{}".format(user) for user in user_mentions if not user.startswith("@")]

def decorator_sender(func):
@functools.wraps(func)
def wrapper_sender(*args, **kwargs):
Expand All @@ -50,60 +55,174 @@ def wrapper_sender(*args, **kwargs):
master_process = True

if master_process:
contents = ['Your training has started 🎬',
'Machine name: %s' % host_name,
'Main call: %s' % func_name,
'Starting date: %s' % start_time.strftime(DATE_FORMAT)]
contents.append(' '.join(user_mentions))
dump['text'] = '\n'.join(contents)
dump['icon_emoji'] = ':clapper:'
notification = "Your training has started! 🎬"
if user_mentions:
notification = _add_mentions(notification)

dump["blocks"] = _starting_message(
func_name, host_name, notification, start_time
)
dump["text"] = notification
Copy link
Contributor

@VictorSanh VictorSanh Mar 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you need the notification here too? It seems to me that it's already contained in the block field.

Copy link
Author

@MetcalfeTom MetcalfeTom Mar 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, removing it from here means that the message text will not display in desktop notifications

dump["icon_emoji"] = ":clapper:"
Copy link
Contributor

@VictorSanh VictorSanh Mar 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might be missing something on the block builder web demo: I couldn't display this emoji (error with this line it seems).

Copy link
Author

@MetcalfeTom MetcalfeTom Mar 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately I found some bad news about this on the slack webhook docs

You cannot override the default channel (chosen by the user who installed your app), username, or icon when you're using Incoming Webhooks to post messages. Instead, these values will always inherit from the associated Slack app configuration.

I tried some workarounds for this, but it seems that updating the name/emoji are only possible using the new api, which would change the configuration of this sender.

As a result, I removed dump and the channel parameter from this file entirely

Copy link
Contributor

@VictorSanh VictorSanh Mar 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have difficulties understanding: where is your message sent then (on which channel)? is it encoded in the URL in an identifiable way?
As far as possible, I think it's nice to have an identifiable bot sending messages (instead of yourself to yourself), something that the current version is handling well.

Copy link
Contributor

@VictorSanh VictorSanh Mar 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this (https://api.slack.com/bot-users#installing-bot) related?

Copy link
Author

@MetcalfeTom MetcalfeTom Mar 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since knockknock only uses the webhook sender for slack, the bot user is set when initialising the app, and the channel is selected specifically for each webhook (as below).

Screenshot 2020-03-17 at 10 23 22 pm

Messages sent to this webhook are still posted as the bot, but only to one channel, and with the same username and profile image every time. This functionality looks like it has been deprecated for webhooks, and is only possible with the new API.

I can update the slack sender to use the new API if you wish, but it will bring it further away from the refactoring you mentioned earlier

Copy link
Author

@MetcalfeTom MetcalfeTom Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@VictorSanh How would you like to proceed? I believe the choices are:

  1. Forgo the profile image formatting
  2. Update this sender with a bot user account, and use chat.postMessage to specify channel and profile image (and potentially more functionality). This would also mean updating the documentation for the new slack token setup.


requests.post(webhook_url, json.dumps(dump))

try:
value = func(*args, **kwargs)

if master_process:
end_time = datetime.datetime.now()
elapsed_time = end_time - start_time
contents = ["Your training is complete 🎉",
'Machine name: %s' % host_name,
'Main call: %s' % func_name,
'Starting date: %s' % start_time.strftime(DATE_FORMAT),
'End date: %s' % end_time.strftime(DATE_FORMAT),
'Training duration: %s' % str(elapsed_time)]

try:
str_value = str(value)
contents.append('Main call returned value: %s'% str_value)
except:
contents.append('Main call returned value: %s'% "ERROR - Couldn't str the returned value.")

contents.append(' '.join(user_mentions))
dump['text'] = '\n'.join(contents)
dump['icon_emoji'] = ':tada:'
notification = "Your training is complete 🎉"
if user_mentions:
notification = _add_mentions(notification)

dump["blocks"] = _successful_message(
func_name, host_name, notification, start_time, value
)
dump["text"] = notification
dump["icon_emoji"] = ":tada:"
requests.post(webhook_url, json.dumps(dump))

return value

except Exception as ex:
end_time = datetime.datetime.now()
elapsed_time = end_time - start_time
contents = ["Your training has crashed ☠️",
'Machine name: %s' % host_name,
'Main call: %s' % func_name,
'Starting date: %s' % start_time.strftime(DATE_FORMAT),
'Crash date: %s' % end_time.strftime(DATE_FORMAT),
'Crashed training duration: %s\n\n' % str(elapsed_time),
"Here's the error:",
'%s\n\n' % ex,
"Traceback:",
'%s' % traceback.format_exc()]
contents.append(' '.join(user_mentions))
dump['text'] = '\n'.join(contents)
dump['icon_emoji'] = ':skull_and_crossbones:'
notification = "Your training has crashed ☠️"
if user_mentions:
notification = _add_mentions(notification)

dump["blocks"] = _error_message(
ex, func_name, host_name, notification, start_time
)

dump["text"] = notification
dump["icon_emoji"] = ":skull_and_crossbones:"
requests.post(webhook_url, json.dumps(dump))
raise ex

def _error_message(ex, func_name, host_name, notification, start_time):
"""Uses Slack blocks to create a formatted report of exception 'ex'."""
end_time = datetime.datetime.now()
training_time = _format_train_time(end_time, start_time)
return [
{"type": "section", "text": {"type": "mrkdwn", "text": notification}},
{"type": "divider"},
{
"type": "context",
"elements": [
{
"type": "mrkdwn",
"text": "*Machine name:* {}\n"
"*Main call:* {}\n"
"*Starting date:* {}\n"
"*Crash date:* {}\n"
"*Time elapsed before crash:* {}".format(
host_name,
func_name,
start_time.strftime(DATE_FORMAT),
end_time.strftime(DATE_FORMAT),
training_time,
),
}
],
},
{"type": "divider"},
{
"type": "section",
"text": {"type": "mrkdwn", "text": "*Error:* `{}`".format(ex)},
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*Traceback:*\n```{}```".format(traceback.format_exc()),
},
},
]

def _starting_message(func_name, host_name, notification, start_time):
"""Uses Slack blocks to create an initial report of training."""
return [
{"type": "section", "text": {"type": "mrkdwn", "text": notification}},
{"type": "divider"},
{
"type": "context",
"elements": [
{
"type": "mrkdwn",
"text": "*Machine name:* {}\n"
"*Main call:* {}\n"
"*Starting date:* {}\n".format(
host_name, func_name, start_time.strftime(DATE_FORMAT)
),
}
],
},
]

def _successful_message(func_name, host_name, notification, start_time, value):
"""Uses Slack blocks to report a successful training run with statistics."""
end_time = datetime.datetime.now()
training_time = _format_train_time(end_time, start_time)
blocks = [
{"type": "section", "text": {"type": "mrkdwn", "text": notification}},
{"type": "divider"},
{
"type": "context",
"elements": [
{
"type": "mrkdwn",
"text": "*Machine name:* {}\n"
"*Main call:* {}\n"
"*Starting date:* {}\n"
"*End date:* {}\n"
"*Training Duration:* {}".format(
host_name,
func_name,
start_time.strftime(DATE_FORMAT),
end_time.strftime(DATE_FORMAT),
training_time,
),
}
],
},
]

if value is not None:
blocks.append({"type": "divider"})
try:
str_value = str(value)
dump["blocks"].append(
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "*Main call returned value:* {}".format(
str_value
),
},
}
)
except Exception as e:
blocks.append(
"Couldn't str the returned value due to the following error: \n`{}`".format(
e
)
)

return blocks

def _format_train_time(end_time, start_time):
"""Returns a time delta in format HH:MM:SS"""
elapsed_time = end_time - start_time
hours, remainder = divmod(elapsed_time.seconds, 3600)
minutes, seconds = divmod(remainder, 60)
training_time = "{:2d}:{:02d}:{:02d}".format(hours, minutes, seconds)
return training_time

def _add_mentions(notification):
notification = " ".join(user_mentions) + " " + notification
return notification

return wrapper_sender

return decorator_sender