Merge pull request #42 from it-novum/ITC-2780

ITC-2780 Add notification feature to system health check
it-novum · Apr 25, 2024 · 290c1f9 · 290c1f9
2 parents 5924af7 + 9065519
commit 290c1f9
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 0 deletions.
diff --git a/de/docs/alerting/system-health-notifications.md b/de/docs/alerting/system-health-notifications.md
@@ -0,0 +1,28 @@
+# Systemzustand Nutzer Benachrichtigung
+
+Nutzer können von openITCOCKPIT per E-Mail benachrichtigt werden, sobald sich der Systemzustand (System health) des openITCOCKPIT ändert. 
+Hierfür öffnet man das Systemzustandmenü, welches sich in der Kopfzeile hinter dem Herzsymbol versteckt, und drückt auf die blaue Schaltfläche mit dem Nutzer Symbol.
+
+![system health menu](/images/system-health-menu.png)
+
+Daraufhin erscheint die Übersicht. Dort sind alle Nutzer einsehbar, die eine E-Mail Benachrichtigung bei Statusänderung bekommen.
+Dieser Punkt ist auch über das Seitenmenü unter "Systemwerkzeuge" -> "Systemzustand Benachrichtigungsliste" erreichbar.
+
+![system health users overview](/images/system-health-users-overview.png)
+
+Über die Schaltfläche "Neuer Nutzer" können weitere Nutzer der Liste hinzugefügt werden. Es können mehrere gleichzeitigt angelegt werden. Die Nutzer werden bei Änderung auf die angehakten Status benachrichtigt.
+Sollte kein Status angehackt sein, werden die angegebenen Nutzer auch nicht benachrichtigt.
+
+![system health users overview new user](/images/system-health-users-overview-new-user.png)
+
+Seite für die Neuanlage:
+
+![new system health user](/images/system-health-users-new.png)
+
+Nutzer können ebenfalls bearbeitet und entfernt werden. Beide Punkte sind über das Dropdown Menü in der Übersicht erreichbar.
+
+![system health users edit user](/images/system-health-users-overview-edit-user.png)
+
+Seite für das Bearbeiten:
+
+![edit system health user](/images/system-health-users-edit.png)
diff --git a/de/docs/images/system-health-menu.png b/de/docs/images/system-health-menu.png
diff --git a/de/docs/images/system-health-users-edit.png b/de/docs/images/system-health-users-edit.png
diff --git a/de/docs/images/system-health-users-new.png b/de/docs/images/system-health-users-new.png
diff --git a/de/docs/images/system-health-users-overview-edit-user.png b/de/docs/images/system-health-users-overview-edit-user.png
diff --git a/de/docs/images/system-health-users-overview-new-user.png b/de/docs/images/system-health-users-overview-new-user.png
diff --git a/de/docs/images/system-health-users-overview.png b/de/docs/images/system-health-users-overview.png
diff --git a/de/mkdocs.yml b/de/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
     - 'Benachrichtigungen': 'alerting/alerting.md'
     - 'E-Mail Benachrichtigungen': 'beginners/setup-email-notifications/#e-mail-benachrichtigungen-einrichten'
     - 'Push Benachrichtigungen': 'beginners/setup-browser-push-notifications/#browser-push-benachrichtigungen-einrichten'
+    - 'Systemzustand Benachrichtigungen': 'alerting/system-health-notifications.md'
     - 'Axios Assyst': 'alerting/axiosassyst.md'
     - 'Mattermost': 'alerting/mattermost.md'
     - 'PagerDuty': 'alerting/pagerduty.md'

diff --git a/en/docs/alerting/system-health-notifications.md b/en/docs/alerting/system-health-notifications.md
@@ -0,0 +1,27 @@
+# System health user notification
+Users can be notified by openITCOCKPIT by e-mail as soon as the system health of openITCOCKPIT changes.
+To do this, open the system health menu, which is hidden in the header behind the heart symbol, and press the blue button with the user symbol.
+
+![system health menu](/images/system-health-menu.png)
+
+The overview will then appear. All users who receive an e-mail notification when their status changes can be viewed there.
+This item can also be accessed via the side menu under "System tools" -> "System health notification list".
+
+![system health users overview](/images/system-health-users-overview.png)
+
+Additional users can be added to the list using the "New user" button. Several can be created at the same time. The users are notified when the checked status is changed.
+If no status is checked, the specified users will not be notified.
+
+![system health users overview new user](/images/system-health-users-overview-new-user.png)
+
+Page for creating a new user:
+
+![new system health user](/images/system-health-users-new.png)
+
+Users can also be edited and removed. Both items can be accessed via the drop-down menu in the overview.
+
+![system health users edit user](/images/system-health-users-overview-edit-user.png)
+
+Page for editing:
+
+![edit system health user](/images/system-health-users-edit.png)
diff --git a/en/mkdocs.yml b/en/mkdocs.yml
@@ -43,6 +43,7 @@ nav:
       - 'Notifications': 'alerting/alerting.md'
       - 'Setup Email notifications': 'beginners/setup-email-notifications/#setting-up-email-notifications'
       - 'Setup browser push notifications': 'beginners/setup-browser-push-notifications/#setting-up-browser-push-notifications'
+      - 'System health notification': 'alerting/system-health-notifications.md'
       - 'Axios Assyst': 'alerting/axiosassyst.md'
       - 'Mattermost': 'alerting/mattermost.md'
       - 'PagerDuty': 'alerting/pagerduty.md'