v2.22 - Fixed #60 incorrect JSON request while reading latest problems

I've forgotten to update the xml to the same version as mailGraph.php :-(. Fixed with this very minor change.

README.md

@@ -1,55 +1,61 @@
-## mailGraph v2.10 release ##
-_(2023/06/30)_
+## Introduction ##
+Over the years I've been using Zabbix as both personal and business solution for monitoring. One of the missing features in Zabbix itself was the ability to have graphs generated and associated to monitoring messages as well as an easy way to jump back into Zabbix when searching for monitoring information for specific events, problems or to have a direct link to the associated Zabbix item or host.
 
-_This version has been verified with Zabbix 5.4, 6.0 LTS and 6.4._
+This initiated the development of mailGraph v1 in Zabbix 5.4 delivering an elementary solution for sending HTML enriched messages from Zabbix including graphs.
+To facilitate in a very flexible way to setup and format messages including the graphs, Twig made its introduction towards mailGraph v2, the current release branch of mailGraph.
 
-Minor updates to the mailGraph code
-- When not defining zabbix_api_user and zabbix_api_pwd in the configuration file the zbx_user and zbx_user_pwd wll be used
+The below message is just an example of what MailGraph is capable of. The template engine in Twig allows for a fully customized message creation to your needs! It is also possible to add more Zabbix fields as any field is passed to Twig when accessible in Zabbix through the macro mechanism.
 
-Modified files
-- mailGraph.php
-- mailGraph.xml
-- javascript/zabbix.mailGraph.js
+Note that all Zabbix host, item or screen related information is made available to Twig automatically.
 
-For those upgrading to the latest release without installing the media type:
-- copy new mailGraph.php over existing mailGraph.php
-- open the Media type MailGraph in Zabbix and edit the javascript
--- replace the script contents with the contents of javascript/zabbix.mailGraph.js
+Example message:
 
-Changes are in effect immediately, no need to restart any services.
+![Example image](https://github.com/moudsen/mailGraph/assets/16045332/0cb671d9-464f-493b-b250-15dd550fd84a)
 
-## Zabbix 6.4.x testing ##
-_(2023/06/30)_
+mailGraph is capable of adding several series of graphs into a single message delivering a unique experience when and how groups of graph images per the requested periods of time are added.
+Currently mailGraph supports hosts, (one or more related) items and screens (applicable to Zabbix 5.4 only).
 
-Zabbix 6.4 verification has succesfully completed.
-- Refactored code to remove deprecated and removed functions since Zabbix 6.4.0
--- Zabbix Javascript now using HttpRequest instead of CurlHttpRequest (function name changes implemented)
--- Zabbix API user.login is now based on "username" (instead of "user")
+More information can be found in the Wiki.
 
-Sidenotes
-- Zabbix logging still shows deprecation messages however it is believed these are internal to Zabbix and not related to mailGraph
+## Installation ##
+Please refer to the Wiki how to get mailGraph installed and configured on your system.
 
-_(2023/06/29)_
+## Reference websites ##
+[Extensive GERMAN installation from scratch](https://znil.net/index.php?title=Zabbix_mailGraph_installieren_-_Trigger_Alerts_Emails_mit_Grafiken) - nice work from Bernard Linz
 
-Zabbix 6.4.x verification is in progress. Required intermediate release to fix one major issue (Zabbix login parameters deprecation) and some minor coding updates.
-Expect to continue with automatic configuration within the next 2 months.
+## Announcements ##
+_(2025/02/04)_
 
-## Zabbix 6.2.x testing ##
-_(2022/10/10)_
+Started on coding and testing mailGraph v3.
 
-Testing completed. No immediate issues found.
+_(2025/01/26)_
 
-_(2022/08/22)_
+mailGraph v2.20 now supporting Zabbix 7.0 (LTS) and Zabbix 7.2 (in particular the new API bearer token authentication method).
 
-Zabbix 6.2.x testing is in progress. Once completed the next effort will be to deliver on automatic configuration detection and automatic updates.
+_(2024/12/01)_
 
-## IMPORTANT NOTE ##
-As a result of a major functional change in Zabbix 5.4 (Screens no longer exist and are all moved into Dashboards) the mailGraph.screen macro no longer functions under Zabbix 5.4+. A code rewrite is in progress to deal with detecting the Zabbix version and to pick dashboard.get instead of screen.get as a source list for the graphs that should be included in the mail message.
+As per December 2024 PHP 7 and older is no longer supported. Please upgrade to a supported PHP 8 version.
+Note that mailGraph is expected to function in older PHP versions.
 
-**v1.x is no longer supported; please upgrade to the current v2 release**
-**Please use the Wiki for information on how to install, configure and use MailGraph in Zabbix**
+_(2023/11/01)_
 
-## Example message
-The below message is just an example of what MailGraph is capable of. The template engine ("Twig") allows for a fully customized message creation to your needs! It is also possible to add more Zabbix fields. If you need additional fields just raise an issue ticket and ask and I'll see what I can do.
+As per November 2023 the maintenance on mailGraph v2.x for Zabbix 5.x will stop in conjunction with the Zabbix lifecycle policy (https://www.zabbix.com/life_cycle_and_release_policy) as Zabbix 5 is nearing it's end of life.
 
-[![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)
+Principal bug fixing on mailGraph v2.x (logic failure or similar) will continue but only for Zabbix 6.x onwards.
+
+## Ideas and improvements ##
+
+I'm open to new feature requests - please raise an issue for this in this Github space.
+
+[#50 - Docker support](https://github.com/moudsen/mailGraph/issues/50) - Docker support inserted shortly after testing; will be pushed into release 3 shortly.
+
+## Special thank you ##
+I would like to express my gratitude to the following people that have actively contributed to bring bugs and improvements to my attention:
+- [pqvindesland](https://github.com/pqvindesland)
+- [BernardLinz](https://github.com/BernhardLinz)
+- [WMP](https://github.com/WMP)
+- [dima-online](https://github.com/dima-online)
+- [tadeuszkura](https://github.com/tadeuszkura)
+
+## IMPORTANT NOTE for users of mailGraph v2 and older and Zabbix versions under 6.0 ##
+As per November 2023, mailGraph is no longer maintained for Zabbix 5 and older.

config/config.json.template

@@ -1,7 +1,5 @@
 {
     "script_baseurl": "https:\/\/mydomain.com\/",
-    "cli_itemId": 0,
-    "cli_triggerId": 0,
     "cli_eventId": 0,
     "cli_duration": 0,
     "cli_recipient": "recipient@mydomain.com",
@@ -15,14 +13,20 @@
     "zabbix_user_pwd": "astrongpassword",
     "zabbix_api_user": "alogicalusername",
     "zabbix_api_pwd": "astrongpassword",
-    "mail_from": "sender@mydomain.com",
     "subject": "{{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
     "smtp_server": "localhost",
     "smtp_port": 25,
-    "smtp_transport": "none",
+    "smtp_security": "none",
     "smtp_strict": "yes",
+    "smtp_from_address": "mailgraph@mydomain.com",
+    "smtp_from_name": "mailGraph",
+    "smtp_reply_address": "feedback@mydomain.com",
+    "smtp_reply_name": "mailGraph response mailbox",
     "graph_match": "any",
+    "item_value_truncate": 50,
     "period": "20m",
     "period_header": "Last 20 minutes",
+    "retention_images": 7,
+    "retention_logs": 14,
     "debug": 0
 }

config/config.json.template.api_token

@@ -0,0 +1,31 @@
+{
+    "script_baseurl": "https:\/\/mydomain.com\/",
+    "cli_eventId": 0,
+    "cli_duration": 0,
+    "cli_recipient": "recipient@mydomain.com",
+    "cli_subject": "[TEST] {{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
+    "cli_baseURL": "https:\/\/mydomain.com\/zabbix\/",
+    "cli_period": "30m",
+    "cli_period_header": "Last 30 minutes",
+    "cli_debug": 1,
+    "cli_proxy": "",
+    "zabbix_user": "alogicalusername",
+    "zabbix_user_pwd": "astrongpassword",
+    "zabbix_api_token": "TheTokenGeneratedInZabbix",
+    "subject": "{{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
+    "smtp_server": "localhost",
+    "smtp_port": 25,
+    "smtp_security": "none",
+    "smtp_strict": "yes",
+    "smtp_from_address": "mailgraph@mydomain.com",
+    "smtp_from_name": "mailGraph",
+    "smtp_reply_address": "feedback@mydomain.com",
+    "smtp_reply_name": "mailGraph response mailbox",
+    "graph_match": "any",
+    "item_value_truncate": 50,
+    "period": "20m",
+    "period_header": "Last 20 minutes",
+    "retention_images": 7,
+    "retention_logs": 14,
+    "debug": 0
+}

config/config.json.template.multigraph

@@ -1,7 +1,5 @@
 {
     "script_baseurl": "https:\/\/mydomain.com\/",
-    "cli_itemId": 0,
-    "cli_triggerId": 0,
     "cli_eventId": 0,
     "cli_duration": 0,
     "cli_recipient": "recipient@mydomain.com",
@@ -15,13 +13,17 @@
     "zabbix_user_pwd": "astrongpassword",
     "zabbix_api_user": "alogicalusername",
     "zabbix_api_pwd": "astrongpassword",
-    "mail_from": "sender@mydomain.com",
     "subject": "{{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
     "smtp_server": "localhost",
     "smtp_port": 25,
-    "smtp_transport": "none",
+    "smtp_security": "none",
     "smtp_strict": "yes",
+    "smtp_from_address": "mailgraph@mydomain.com",
+    "smtp_from_name": "mailGraph",
+    "smtp_reply_address": "feedback@mydomain.com",
+    "smtp_reply_name": "mailGraph response mailbox",
     "graph_match": "any",
+    "item_value_truncate": 50,
     "periods": "10m,4h,2d,7d",
     "periods_headers": "Last 10 minutes,Last 4 hours,Last 2 days,Last 7 days",
     "debug": 0

javascript/zabbix.mailGraph.js

@@ -1,3 +1,15 @@
+// mailGraph v2.20
+
+// Function to test string
+function isJSON(str) {
+	try {
+		JSON.stringify(JSON.parse(str));
+		return true;
+	} catch (e) {
+		return false;
+	}
+}
+
 try {
     // Pickup parameters
     params = JSON.parse(value),
@@ -7,7 +19,7 @@ try {
         result = { tags: {} };
 
     // Set HTTP proxy if required
-    if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
+    if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
         req.setProxy(params.HTTPProxy);
         fields.HTTPProxy = params.HTTPProxy;
     }
@@ -15,12 +27,16 @@ try {
     // Declare output type
     req.addHeader('Content-Type: application/json');
 
-    // Must have fields
-    fields.itemId = params.itemId;
-    fields.eventId = params.eventId;
+    // Pick up fields relevant for mailGraph API level call while parsing/casting fields that should be integer
+    fields.itemId = params.itemId * 1;
+    fields.eventId = params.eventId * 1;
     fields.recipient = params.recipient;
     fields.baseURL = params.baseURL;
-    fields.duration = params.duration;
+    fields.duration = params.duration * 1;
+
+    if (fields.recipient.charAt(0) == '{') {
+      throw '[MailGraph Webhook] Please define recipient for the test message!';
+    }
 
     // Optional fields
     if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
@@ -41,21 +57,43 @@ try {
     // Post information to the processing script
     Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
     var resp = req.post(params.URL,JSON.stringify(fields));
-    Zabbix.Log(4, '[Mailgraph Webhook] Receiving response:' + resp);
+    Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
 
-    // If there was an error, report it
-    if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
+    // The response can be
+    // - did not receive status 200 as result (contains HTTP server response)
+    // - null (no response received at all)
+    // - empty string (likely no e-mail sent due to recipient issue)
+    // - not json (debugging message for troubleshooting or configuration hints)
+    // - json (contains the mail message ID sent)
 
-    // We expect the message id back from the processing script
-    resp = JSON.parse(resp);
-    result.tags.__message_id = resp.messageId;
+    if (req.getStatus() != 200) {
+       throw '[MailGraph Webhook] Processing of mailGraph.php failed: ' + resp;
+    }
+    if (resp==null) {
+      throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
+    }
+
+    if (resp=='') {
+      throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
+    }
+
+    // Check if JSON was returned
+    if (!isJSON(resp)) {
+      throw '[MailGraph Webhook] An error has occurred during processing: ' + resp;
+    }
+
+    // We expect the message id back from the processing script response in JSON format
+    msg = JSON.parse(resp);
+
+    result.tags.__message_id = msg.messageId;
+    Zabbix.Log(4, '[MailGraph Webhook] Message sent with identification "' + msg.messageId + '"');
 
     // Pass the result back to Zabbix
     return JSON.stringify(result);
 }
 catch (error)
 {
-    // In case something went wrong in the processing, pass the error back to Zabbix
-    Zabbix.Log(127, 'MailGraph notification failed : '+error);
+    // In case something else went wrong in the processing, pass the error back to Zabbix
+    Zabbix.Log(127, 'MailGraph notification failed: '+error);
     throw 'MailGraph notification failed : '+error;
 }

mailGraph.xml

@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <zabbix_export>
-    <version>6.0</version>
-    <date>2023-06-29T23:22:52Z</date>
+    <version>5.4</version>
+    <date>2023-08-16T20:38:38Z</date>
     <media_types>
         <media_type>
             <name>MailGraph</name>
             <type>WEBHOOK</type>
-             <parameters>
+            <parameters>
                 <parameter>
                     <name>baseURL</name>
-                    <value>https://mydomain.com/zabbix/</value>
+                    <value>https://myzabbix.com/zabbix/</value>
                 </parameter>
                 <parameter>
                     <name>duration</name>
@@ -35,10 +35,6 @@
                     <name>infoTest</name>
                     <value>Test</value>
                 </parameter>
-                <parameter>
-                    <name>itemId</name>
-                    <value>{ITEM.ID}</value>
-                </parameter>
                 <parameter>
                     <name>periods</name>
                     <value>10m,4h,1d,7d</value>
@@ -61,11 +57,22 @@
                 </parameter>
                 <parameter>
                     <name>URL</name>
-                    <value>https://mydomain.com/mailGraph.php</value>
+                    <value>https://myzabbix.com/mailGraph.php</value>
                 </parameter>
             </parameters>
+            <script>// mailGraph v2.20
 
-            <script>try {
+// Function to test string
+function isJSON(str) {
+	try {
+		JSON.stringify(JSON.parse(str));
+		return true;
+	} catch (e) {
+		return false;
+	}
+}
+
+try {
     // Pickup parameters
     params = JSON.parse(value),
         req = new HttpRequest(),
@@ -82,12 +89,16 @@
     // Declare output type
     req.addHeader('Content-Type: application/json');
 
-    // Must have fields
-    fields.itemId = params.itemId;
-    fields.eventId = params.eventId;
+    // Pick up fields relevant for mailGraph API level call while parsing/casting fields that should be integer
+    fields.itemId = params.itemId * 1;
+    fields.eventId = params.eventId * 1;
     fields.recipient = params.recipient;
     fields.baseURL = params.baseURL;
-    fields.duration = params.duration;
+    fields.duration = params.duration * 1;
+
+    if (fields.recipient.charAt(0) == '{') {
+      throw '[MailGraph Webhook] Please define recipient for the test message!';
+    }
 
     // Optional fields
     if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
@@ -108,22 +119,44 @@
     // Post information to the processing script
     Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
     var resp = req.post(params.URL,JSON.stringify(fields));
-    Zabbix.Log(4, '[Mailgraph Webhook] Receiving response:' + resp);
+    Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
 
-    // If there was an error, report it
-    if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
+    // The response can be
+    // - did not receive status 200 as result (contains HTTP server response)
+    // - null (no response received at all)
+    // - empty string (likely no e-mail sent due to recipient issue)
+    // - not json (debugging message for troubleshooting or configuration hints)
+    // - json (contains the mail message ID sent)
 
-    // We expect the message id back from the processing script
-    resp = JSON.parse(resp);
-    result.tags.__message_id = resp.messageId;
+    if (req.getStatus() != 200) {
+       throw '[MailGraph Webhook] Processing of mailGraph.php failed: ' + resp;
+    }
+    if (resp==null) {
+      throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
+    }
+
+    if (resp=='') {
+      throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
+    }
+
+    // Check if JSON was returned
+    if (!isJSON(resp)) {
+      throw '[MailGraph Webhook] An error has occurred during processing: ' + resp;
+    }
+
+    // We expect the message id back from the processing script response in JSON format
+    msg = JSON.parse(resp);
+
+    result.tags.__message_id = msg.messageId;
+    Zabbix.Log(4, '[MailGraph Webhook] Message sent with identification &quot;' + msg.messageId + '&quot;');
 
     // Pass the result back to Zabbix
     return JSON.stringify(result);
 }
 catch (error)
 {
-    // In case something went wrong in the processing, pass the error back to Zabbix
-    Zabbix.Log(127, 'MailGraph notification failed : '+error);
+    // In case something else went wrong in the processing, pass the error back to Zabbix
+    Zabbix.Log(127, 'MailGraph notification failed: '+error);
     throw 'MailGraph notification failed : '+error;
 }</script>
             <process_tags>YES</process_tags>
@@ -150,11 +183,7 @@ Host: {HOST.NAME}
 Severity: {EVENT.SEVERITY}
 Operational data: {EVENT.OPDATA}
 Original problem ID: {EVENT.ID}
-{TRIGGER.URL}
-
-eventId: {EVENT.ID}
-TriggerId: {TRIGGER.ID}
-itemId: {ITEM.ID]</message>
+Trigger ID (/url): {TRIGGER.ID} {TRIGGER.URL}</message>
                 </message_template>
                 <message_template>
                     <event_source>TRIGGERS</event_source>
@@ -166,11 +195,7 @@ Problem duration: {EVENT.DURATION}
 Host: {HOST.NAME}
 Severity: {EVENT.SEVERITY}
 Original problem ID: {EVENT.ID}
-{TRIGGER.URL}
-
-eventId: {EVENT.ID}
-TriggerId: {TRIGGER.ID}
-itemId: {ITEM.ID]</message>
+Trigger ID: {TRIGGER.ID} {TRIGGER.URL}</message>
                 </message_template>
                 <message_template>
                     <event_source>TRIGGERS</event_source>
@@ -181,9 +206,8 @@ itemId: {ITEM.ID]</message>
 
 Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
 
-eventId: {EVENT.ID}
-TriggerId: {TRIGGER.ID}
-itemId: {ITEM.ID]</message>
+Event ID: {EVENT.ID}
+Trigger ID: {TRIGGER.ID}</message>
                 </message_template>
             </message_templates>
         </media_type>

templates/html.template

@@ -81,6 +81,9 @@
     .content {
         font-size: 14px;
     }
+    .acknowledge {
+        font-size: 10px;
+    }
 </style>
 </head>
 <body>
@@ -98,7 +101,7 @@
                                 ({{ HOST_ERROR }})
 {% endif %}
                                 <br/>
-{% if EVENT_OPDATE|length > 0 %}
+{% if EVENT_OPDATA|length > 0 %}
                                 Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
 {% endif %}
                                 Status: <b>{{ EVENT_STATUS }}</b><br/>
@@ -112,6 +115,18 @@
                         </td>
                     </tr>
                 </table>
+{% if ACKNOWLEDGES|length > 0 %}
+                <br/>
+{% for anAck in ACKNOWLEDGES %}
+                <table style="border:0; text-align:left;" cellpadding="5" cellspacing="0">
+                    <tr>
+                        <td class="acknowledge">
+                            <b>{{ anAck._clock }}</b><br/><em>({{ anAck.username }}, {{ anAck.name }} {{ anAck.surname }})</em><br/>[{{ anAck._actions }}]<br/>{{ anAck.message }}
+                        </td>
+                    </tr>
+                </table>
+{% endfor %}
+{% endif %}
             </td>
         </tr>
         <tr>
@@ -120,10 +135,12 @@
                     Event ID: <a href="{{ EVENTDETAILS_URL }}">{{ EVENT_ID }}</a> //
                     Trigger ID: <a href="{{ TRIGGER_URL }}">{{ TRIGGER_ID }}</a> //
                     Item ID: <a href="{{ ITEM_URL }}">{{ ITEM_ID }}</a> //
-                    Host ID: <a href="{{ HOST_URL }}">{{ HOST_ID }}</a>
+                    Host ID: <a href="{{ HOST_URL }}">{{ HOST_ID }}</a> //
+                    <a href="{{ HOST_PROBLEMS_URL }}">Problems</a>
 {% if GRAPH_ZABBIXLINK|length > 0 %}
                     // Graph ID: <a href="{{ GRAPH_ZABBIXLINK }}">{{ GRAPH_ID }}</a>
 {% endif %}
+                   // <a href="{{ ACK_URL }}">Ack</a>
                 </div>
             </td>
         </tr>
@@ -189,4 +206,4 @@
 {% endif %}
     </table>
 </body>
-</html>
+</html>