zammad · ralf401 · Aug 24, 2023 · Aug 23, 2023 · Aug 23, 2023 · Aug 24, 2023
diff --git a/images/system/monitoring/1.jpg b/images/system/monitoring/1.jpg
diff --git a/images/system/monitoring/2.jpg b/images/system/monitoring/2.jpg
diff --git a/images/system/monitoring/monitoring-issues-indicator.png b/images/system/monitoring/monitoring-issues-indicator.png
diff --git a/images/system/monitoring/monitoring-no-issues-indicator.png b/images/system/monitoring/monitoring-no-issues-indicator.png
diff --git a/images/system/monitoring/monitoring-token-health-check.png b/images/system/monitoring/monitoring-token-health-check.png
diff --git a/locale/admin-docs.pot b/locale/admin-docs.pot
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Zammad pre-release\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-08-21 15:33+0200\n"
+"POT-Creation-Date: 2023-08-24 10:03+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -16916,27 +16916,73 @@ msgid "Monitoring"
 msgstr ""
 
 #: ../system/monitoring.rst:4
-msgid "**Please note:** This is only available in self hosted instances, as we're monitoring hosted instances and fix problems."
-msgstr ""
-
-#: ../system/monitoring.rst:6
-msgid "On the monitoring page you can see the current health state of Zammad. This can be useful if you for example have the feeling that you don't receive emails anymore, you can take a look here before logging onto your Server."
+msgid "This function is only available in self hosted instances. If you use Zammad in our cloud, we are monitoring the system on our own and take steps to fix potential problems directly."
 msgstr ""
 
 #: ../system/monitoring.rst:9
-msgid "Besides the optical state of an event, you can also reset the access token for this module and get the monitoring URL for a monitoring system of your choice."
+msgid "General"
 msgstr ""
 
 #: ../system/monitoring.rst:11
-msgid "Example output to this can be:"
+msgid "On the monitoring page, you can see the current health state of Zammad under \"*Current Status*\" at the bottom. This can be useful if you want to have a look if everything is up and running. As an example, you could have a look in the monitoring when you assume that some emails aren't processed from Zammad."
 msgstr ""
 
-#: ../system/monitoring.rst:13
-msgid "Everything is OK (refer to image 2 for interface example)::"
+#: ../system/monitoring.rst:17
+msgid "**Can't receive an email and the monitoring response is \"healthy\"?**"
 msgstr ""
 
-#: ../system/monitoring.rst:17
-msgid "Zammad has issue (whatever nature, refer to image 2 for interface example)::"
+#: ../system/monitoring.rst:19
+msgid "Zammad will just inform you about unprocessable emails. This is not the case for oversized emails. You can adjust the maximum email size in :doc:`../channels/email/settings`."
+msgstr ""
+
+#: ../system/monitoring.rst:24
+msgid "Monitoring API"
+msgstr ""
+
+#: ../system/monitoring.rst:26
+msgid "Beside the indication in the monitoring page, you can also use an external monitoring tool to monitor Zammad's health. To request the health of Zammad, you need to provide the API key (token) to the external monitoring tool. You can copy the token from the \"*Current Token*\" field as well as the whole API endpoint of your system (\"*Health Check*\" field), in which the API token is already included."
+msgstr ""
+
+#: ../system/monitoring.rst:37
+msgid "Screenshot showing Current Token and Health Check"
+msgstr ""
+
+#: ../system/monitoring.rst:37
+msgid "Screenshot showing Token and Health Check"
+msgstr ""
+
+#: ../system/monitoring.rst:39
+msgid "In addition to that, you can reset the auto-generated token to make sure that already configured monitoring systems won't work anymore. So, please use this \"*Reset*\" button only if you know what you do!"
+msgstr ""
+
+#: ../system/monitoring.rst:44
+msgid "Example output"
+msgstr ""
+
+#: ../system/monitoring.rst:0
+msgid "No issues found"
+msgstr ""
+
+#: ../system/monitoring.rst:48
+#: ../system/monitoring.rst:60
+msgid "**Indicator in Zammad**:"
+msgstr ""
+
+#: ../system/monitoring.rst:0
+msgid "Screenshot showing monitoring with no issues"
+msgstr ""
+
+#: ../system/monitoring.rst:54
+#: ../system/monitoring.rst:66
+msgid "**API response**::"
+msgstr ""
+
+#: ../system/monitoring.rst:0
+msgid "Issues were found"
+msgstr ""
+
+#: ../system/monitoring.rst:0
+msgid "Screenshot showing monitoring with issues"
 msgstr ""
 
 #: ../system/objects.rst:2

diff --git a/system/monitoring.rst b/system/monitoring.rst
@@ -1,22 +1,68 @@
 Monitoring
 **********
 
-**Please note:** This is only available in self hosted instances, as we're monitoring hosted instances and fix problems.
+.. note:: This function is only available in self hosted instances. If you
+   use Zammad in our cloud, we are monitoring the system on our own and take
+   steps to fix potential problems directly.
 
-On the monitoring page you can see the current health state of Zammad.
-This can be useful if you for example have the feeling that you don't receive emails anymore, you can take a look here before logging onto your Server.
+General
+=======
 
-Besides the optical state of an event, you can also reset the access token for this module and get the monitoring URL for a monitoring system of your choice.
+On the monitoring page, you can see the current health state of Zammad under
+"*Current Status*" at the bottom. This can be useful if you want to have a look
+if everything is up and running.
+As an example, you could have a look in the monitoring when you assume that
+some emails aren't processed from Zammad.
 
-Example output to this can be:
+.. note:: **Can't receive an email and the monitoring response is "healthy"?**
 
-Everything is OK (refer to image 2 for interface example)::
+   Zammad will just inform you about unprocessable emails. This is not the case
+   for oversized emails. You can adjust the maximum email size in
+   :doc:`../channels/email/settings`.
 
-   {"healthy"=>true, "message"=>"success", "token"=>"2432XXXXXXXXXXXXXXXXXXXXXX1761"}
+Monitoring API
+===============
 
-Zammad has issue (whatever nature, refer to image 2 for interface example)::
+Beside the indication in the monitoring page, you can also use an external
+monitoring tool to monitor Zammad's health. To request the health of Zammad,
+you need to provide the API key (token) to the external monitoring tool.
+You can copy the token from the "*Current Token*" field as well as the whole API
+endpoint of your system ("*Health Check*" field), in which the API token is
+already included.
 
-   {"healthy":false,"message":"Channel: Twitter::Account in key:{\"id\"=\XXXXXXXXXXXXXXXXX, \"screen_name\"=\u003e\"Name\", \"name\"=\u003e\"Somewhat name\"}; Can't use stream for channel (42): #\u003cJSON::ParserError: 765: unexpected token at 'The Site Streams and User Streams endpoints have been turned off. Please migrate to alternate APIs. See https://t.co/usss'\u003e","issues":["Channel: Twitter::Account in key:{\"id\"=\XXXXXXX, \"screen_name\"=\u003e\"Name\", \"name\"=\u003e\"Somename\"}; Can't use stream for channel (42): #\u003cJSON::ParserError: 765: unexpected token at 'The Site Streams and User Streams endpoints have been turned off. Please migrate to alternate APIs. See https://t.co/usss'\u003e"],"actions":[],"token":"OgitXXXXXXXXXXXXXXXXXXXXXXNxo4ptCoQ"}
+.. figure:: /images/system/monitoring/monitoring-token-health-check.png
+   :alt: Screenshot showing Current Token and Health Check
+   :scale: 100%
 
-.. image:: /images/system/monitoring/1.jpg
-.. image:: /images/system/monitoring/2.jpg
+   Screenshot showing Token and Health Check
+
+In addition to that, you can reset the auto-generated token to make sure
+that already configured monitoring systems won't work anymore. So, please use
+this "*Reset*" button only if you know what you do!
+
+Example output
+==============
+
+:No issues found:
+
+   **Indicator in Zammad**:
+
+   .. figure:: /images/system/monitoring/monitoring-no-issues-indicator.png
+      :alt: Screenshot showing monitoring with no issues
+      :scale: 70%
+
+   **API response**::
+
+      {"healthy"=>true, "message"=>"success", "token"=>"2432XXXXXXXXXXXXXXXXXXXXXX1761"}
+
+:Issues were found:
+
+   **Indicator in Zammad**:
+
+   .. figure:: /images/system/monitoring/monitoring-issues-indicator.png
+      :alt: Screenshot showing monitoring with issues
+      :scale: 70%
+
+   **API response**::
+
+      {"healthy":false,"message":"Channel: Twitter::Account in key:{\"id\"=\XXXXXXXXXXXXXXXXX, \"screen_name\"=\u003e\"Name\", \"name\"=\u003e\"Somewhat name\"}; Can't use stream for channel (42): #\u003cJSON::ParserError: 765: unexpected token at 'The Site Streams and User Streams endpoints have been turned off. Please migrate to alternate APIs. See https://t.co/usss'\u003e","issues":["Channel: Twitter::Account in key:{\"id\"=\XXXXXXX, \"screen_name\"=\u003e\"Name\", \"name\"=\u003e\"Somename\"}; Can't use stream for channel (42): #\u003cJSON::ParserError: 765: unexpected token at 'The Site Streams and User Streams endpoints have been turned off. Please migrate to alternate APIs. See https://t.co/usss'\u003e"],"actions":[],"token":"OgitXXXXXXXXXXXXXXXXXXXXXXNxo4ptCoQ"}