DE 

//Cloudogu EcoSystem Docs

  1. docs.cloudogu.com
  2. Entwicklerdokumentation
  3. Systemkomponenten
  4. Cesapp
  5. Funktionen
  6. E-Mail-Benachrichtigung bei fehlgeschlagenen Prozessen
Getting Started
Benutzerhandbuch
Entwicklerdokumentation

E-Mail-Benachrichtigung bei fehlgeschlagenen Prozessen

Die Cesapp kann automatisiert Mails versenden, wenn bestimmte Prozesse fehlschlagen. Dies passiert automatisch, ist standardmäßig eingeschaltet und muss nicht weiter konfiguriert werden. Schlägt einer der folgenden Prozesse fehl, so wird eine Benachrichtigungsmail an den Administrator (Standardmäßig konfiguriert im registry-Key config/ldap/admin_mail):

  • cesapp backup
  • cesapp restore
  • cesapp remove-backups

Wichtig: Diese besagte Mail kann nur dann gesendet werden, wenn das Postfix dogu installiert und korrekt konfiguriert ist. Ist das nicht der Fall, wird keine Mail versendet, aber ohne, dass es dabei zu einem Fehler kommt.

Ist es generell nicht gewünscht, dass diese Mail versendet wird, so kann dies über eine Konfiguration ausgeschaltet werden. Dafür muss der Registry-Key config/_global/mail/alert/enabled auf den Wert false gesetzt werden.

Konfiguration der Mail-Benachrichtigung

Inhalt der Mail

Der Inhalt der Mail wird von der Cesapp definiert und ist standardmäßig auf Englisch und sieht wie folgt aus:

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

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

Die dort vorhandenen Platzhalter werden vor dem Versenden der Mail entsprechend ersetzt.

  • {{.Process}}: Der Fehlgeschlagene Prozess (backup/restore/remove-backups).
  • {{.Instance}}: Der Domain-Name der Instanz
  • {{.Error}}: Die Fehlermeldung, wegen der die Mail versendet wird

Diese Nachricht kann durch Konfiguration frei definiert werden. Dafür müssen entsprechende Konfigurationswerte in der Registry gesetzt werden. Jeder dieser Konfigurationswerte kann jede der drei Platzhalter enthalten. Allerdings ist dies nicht verpflichtend, einen oder mehrere dieser Platzhalter anzugeben. Folgende keys können dafür gesetzt werden:

  • config/_global/mail/alert/subject => Der Betreff der Mail
  • config/_global/mail/alert/body => Der Inhalt der Mail

Absender und Empfänger der Mail

Der Absender der Mail kann über den Registry-Key config/_global/mail/alert/notification_sender definiert werden. Ist der Key nicht definiert, so wird der Standardwert cesapp@<instanz-domain> verwendet.

Die Mail wird immer an den Administrator der Instanz gesendet, der in config/ldap/admin_mail konfiguriert ist. Zusätzlich dazu können weitere Empfänger definiert werden. Dafür muss der Registry-Key config/_global/mail/alert/notification_targets gesetzt werden. Dieser besteht aus einer Komma-Separierten Liste von E-Mail-Adressen, zum Beispiel mail1@test.de,mail2@test.de,mail3@test.de. Auch wenn dieser Registry-Key gesetzt ist, erhält weiterhin der Administrator der Instanz die Benachrichtigungs-Mail, zusätzlich zu den in diesem Key definierten Empfängern.