Page MenuHomePhabricator

Create template for maintainer alerts emails
Closed, ResolvedPublic

Assigned To
Authored By
fnegri
Sep 4 2026, 6:00 PM
Referenced Files
F105846885: Toolforge alerts.png
Oct 2 2026, 3:01 PM
F105263141: alerts_preview.png
Sep 28 2026, 9:39 AM
F104589691: Screenshot 2026-09-24 at 18.22.04.png
Sep 24 2026, 4:25 PM
F104584316: Screenshot 2026-09-24 at 13.50.42.png
Sep 24 2026, 11:51 AM
F104584244: Screenshot 2026-09-24 at 13.47.25.png
Sep 24 2026, 11:47 AM
F103587194: alert.png
Sep 18 2026, 3:31 PM

Description

Before we send emails to actual users, we need to settle on exactly what information we want to provide in the email.

The definition of done for this task is a complete HTML template that can be sent to users, after replacing variables.

We can use the template provided by alertmanager as inspiration.

Details

Related Changes in GitLab:
TitleReferenceAuthorSource BranchDest Branch
maintainer-alerts: remove tool- prefixrepos/cloud/toolforge/alerts!72fnegrimain-I174eaa8ac0a970a15753d8e71c3133488e7dc025main
Customize query in GitLab

Event Timeline

aputhin triaged this task as High priority.Sep 9 2026, 11:39 AM
aputhin moved this task from Backlog to Todos on the tools-platform-team board.

We can use the template provided by alertmanager as inspiration.

Fine with me. That one is based on transaction email templates, so there's some inherent "standard" to them already.

For simplicity sake, we can adopt this one with a few adjustments (i.e. adding Toolforge / WMCS logo) and iterate on it based on feedback from users.

fnegri changed the task status from Open to In Progress.Sep 18 2026, 3:02 PM
fnegri moved this task from Todos to In progress on the tools-platform-team board.

Here's a quick Claude-generated example email, based on the alertmanager template mentioned in the task description.

Let's discuss below what we like and what we want to change.

alert.png (1,060×1,952 px, 305 KB)

Here's a quick Claude-generated example email, based on the alertmanager template mentioned in the task description.

Let's discuss below what we like and what we want to change.

alert.png (1,060×1,952 px, 305 KB)

I think this is a good start. I guess for now we wouldn't include a button, but eventually that could take the user to the yet-to-be-created alerts dashboard.

I did some small updates:

Screenshot 2026-09-24 at 13.50.42.png (1,184×1,980 px, 298 KB)

Iterated on it a bit more:

Screenshot 2026-09-24 at 18.22.04.png (1,184×1,686 px, 251 KB)

I removed the toolforge webservice example commands, because after discussing it with @dcaro we realized that those commands will not work for everyone, as some webservices might be running via jobs-api and require different commands.

One thing I'm unsure is if we should add to the template something like "We will email you again when the issue is resolved, and every 24 hours if the issue persists."

Opinions?

One thing I'm unsure is if we should add to the template something like "We will email you again when the issue is resolved, and every 24 hours if the issue persists."

Opinions?

I think that's a good idea. We'll just need to make sure to update it if we change the notification conditions or frequency.

Added the line above and a few other tweaks. This is a preview of both "firing" and "resolved" alerts for the 3 types of alerts we are supporting at the moment:

alerts_preview.png (1,888×1,684 px, 556 KB)

(I think I did not miss any MR xd)

group_203_bot_3c0afd0d9fd9529f3b7bc7e69a4a3bce opened https://gitlab.wikimedia.org/repos/cloud/toolforge/toolforge-deploy/-/merge_requests/1442

alerts-api: bump to 0.0.10-20261002102828-29c7e276

fnegri moved this task from In progress to Done on the tools-platform-team board.

The HTML version of the templates, along with a txt version containing the same text, is now merged and deployed in alerts-api (https://gitlab.wikimedia.org/repos/cloud/toolforge/alerts-api/-/merge_requests/7).

Note: emails are currently being sent only to maintainers of the tool test-maintainer-alerts, sending the emails to all opted-in tools is tracked in T439554: Read the opted-in tools from components-api.

Updated screenshot for all mail types, with some minor changes from the previous one:

Toolforge alerts.png (4,088×4,340 px, 1 MB)