DE 

//Cloudogu EcoSystem Docs

  1. docs.cloudogu.com
  2. Developer documentation
  3. System components
  4. Cesapp
  5. Functions
  6. Email notification for failed processes
Getting Started
User manual
Developer documentation

Email notification for failed processes

Cesapp can send automated emails if certain processes fail. This happens automatically, is switched on by default and does not need to be configured further. If one of the following processes fails, a notification email is sent to the administrator (configured by default in the registry key config/ldap/admin_mail):

  • cesapp backup
  • cesapp restore
  • cesapp remove-backups

Important: This said mail can only be sent if the Postfix dogu is installed and configured correctly. If this is not the case, no mail will be sent, but no error will occur.

If it is generally not desired that this mail is sent, this can be switched off via a configuration . To do this, the registry key config/_global/mail/alert/enabled must be set to false.

Configuration of the mail notification

Content of the mail

The content of the mail is defined by Cesapp and is in English by default and looks like this:

Subject: "Cesapp alert: The process '{{.Process}}' has failed"

Content: "You are receiving this mail because the process '{{.Process}}' on instance '{{.Instance}}' was canceled with an error. The error message is: '{{.Error}}'. You can receive more information in the logfile of the cesapp."

The placeholders there are replaced accordingly before the mail is sent.

  • `{{.Process}}: The failed process (backup/restore/remove-backups).
  • `{{.Instance}}: The domain name of the instance
  • {{.Error}}: The error message because of which the mail is sent

This message can be freely defined by configuration. To do this, corresponding configuration values must be set in the registry. Each of these configuration values can contain any of the three placeholders. However, it is not mandatory to specify one or more of these placeholders. The following keys can be set for this:

  • config/_global/mail/alert/subject => The subject of the mail
  • config/_global/mail/alert/body => The content of the mail

Sender and recipient of the mail

The sender of the mail can be defined via the registry key config/_global/mail/alert/notification_sender. If the key is not defined, the default value cesapp@<instance-domain> is used.

The mail is always sent to the administrator of the instance configured in config/ldap/admin_mail. Additional recipients can also be defined. To do this, the registry key config/_global/mail/alert/notification_targets must be set. This consists of a comma-separated list of e-mail addresses, for example mail1@test.de,mail2@test.de,mail3@test.de. Even if this registry key is set, the administrator of the instance continues to receive the notification e-mail, in addition to the recipients defined in this key.