Notification emails merging and localization #798
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sermakov-orion
requested review from
ahadas,
bennyz,
emesika,
mwperina,
michalskrivanek,
oliel,
sgratch,
smelamud,
didib and
ljelinkova
as code owners
sermakov-orion
force-pushed
the
email-notification-enhancements
branch
from
909da9c
to
82f0ea3
Compare
sermakov-orion
force-pushed
the
email-notification-enhancements
branch
2 times, most recently
from
bad75a1
to
d996d30
Compare
|
/ost |
michalskrivanek
force-pushed
the
email-notification-enhancements
branch
from
d996d30
to
76a07d3
Compare
|
/ost |
michalskrivanek
approved these changes
Apr 14, 2023
|
/ost |
2 similar comments
|
/ost |
|
/ost |
sermakov-orion
force-pushed
the
email-notification-enhancements
branch
from
76a07d3
to
fca4703
Compare
|
/ost |
|
lgtm except the properties file that needs to be done in zanata |
michalskrivanek
approved these changes
May 17, 2023
|
/ost |
eh, builds need to finish first:/ |
|
...and for that it needs ansible fixes(or at elst disabling the linting) first |
Signed-off-by: Stepan Ermakov <sermakov@orionsoft.ru>
sermakov-orion
force-pushed
the
email-notification-enhancements
branch
from
fca4703
to
6db8b10
Compare
|
/ost |
2 similar comments
|
/ost |
|
/ost |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, I would like to introduce couple email notification enhancements.
Why do we need these enhancements?
ovirt-engine has a separate service ovirt-engine-notifier. This service monitors events at the audit_log table and sends the notifications to different recipients (amqp, snmp, and smtp).
We are mostly interested in email notifications about engine backup events (ENGINE_BACKUP_STARTED, ENGINE_BACKUP_FAILED, ENGINE_BACKUP_COMPLETED).
So, first, when the engine-backup.sh script notifies ovirt-engine it sends multiple events in a row for each backup scope (files, db, dwhdb, cinderlib, grafanadb). Finally, If you start one backup then email recipients would receive 10 email messages (5 messages (one per scope item) about the backup started and 5 (one per scope item) messages about the backup completed or failed). We want to combine these messages in a way where the recipient receives only two emails: one for the "backup started" (with all scope items inside) and one for the "backup completed/failed" (with all scope items inside).
And second, currently, the template of the email messages is hard coded. And it is always in English. We need to provide the ability to localize the email contents to other languages.
What did we propose in this change?
For both topics explained above (email merging and email localization) we introduced two additional parameters (see changes at ovirt-engine-notifier.in). By default, both these parameters are empty, so the system would work as it is - nothing would be changed in the current behavior.
But if you specify a list of "log type names" for the MAIL_MERGE_LOG_TYPES parameter then the new "email merging" logic would be activated for the events of specified types.
If you specify some locale code (currently "en" or "ru" are supported, but welcome to help us to provide translations for other languages) for the MAIL_LOCALE parameter then the static fields of the notification email subject (such as "Time: ", "Message: ", etc) would be translated to the specified language.