v2.11 - Improved error handling and ability to pick random problem via Zabbix for testing

Moved most of README to Wiki for purpose of better documentation.

CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at abuse@puzzl.nl. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

README.md

@@ -1,161 +1,65 @@
-# mailGraph
+## mailGraph v2.11 release ##
-Zabbix Media module and scripts for sending e-mail alerts with graphs.
+_(2023/07/01)_
 
-[![](images/Example-mail-message.png?raw=true)](images/Example-mail-message.png)
+_This version has been verified with Zabbix 5.4 and 6.0 LTS and is expected to work with 6.4 and later (based on v2.10 testing)_
 
-# WORK IN PROGRESS
+Release notes
-Although still under development (consider the current release "beta"), I need feedback and interaction with other users of Zabbix that are looking for the functionality I've developed hence I'm releasing my code to the world.
+- Added pre- and postchecking of variables to the Zabbix javascript - this will prevent the 'invalid JSON' messages and provide better feedback for errors
+- When testing MailGraph it is now possible to set the eventId to zero - a random problem will be picked up via the API
+- Zabbix Media Type XML reverted back to version 5.4 (for backwards compatibility)
 
-**List of item to-do**
+Modified files
-1. Resolve macro information.
+- mailGraph.php
-1. Passing dynamic parameters via the Webhook for template/output usage.
+- mailGraph.xml
-1. Finding "beta testers" to assist me in further enhancing the use cases.
+- javascript/zabbix.mailGraph.js
 
-# Zabbix enhancements
+For those upgrading to the latest release without installing the media type:
-https://support.zabbix.com/browse/ZBXNEXT-6534
+- copy new mailGraph.php over existing mailGraph.php
-Main ticket asking how to get this Media type onboarded in the Media type section of the manual and the associated Zabbix GitHub directory.
+- open the Media type MailGraph in Zabbix and edit the javascript
+-- replace the script contents with the contents of javascript/zabbix.mailGraph.js
 
-https://support.zabbix.com/browse/ZBXNEXT-6535
+Changes are in effect immediately, no need to restart any services.
-One of the major items that needs to be tackled is to resolve Macros that are in names, descriptions, etc. As this does work for the Trigger and TriggerPrototype I've examined the Zabbix source code and from here I would say it's quite "easy" to add the "expandXXX" flags to other types as well (found many existing functions to perform this).
-I'm adding this to my testlab setup for Item and ItemPrototype and will share the outcome. If it is succesfull I will also arrange for other types (like Host) eventually giving back the additional code lines to Zabbix for incorporation into a release.
 
-# Installation pre-requisites
+## mailGraph v2.10 release ##
-The suggested installation path of this script is on the same host where Zabbix lives but outside the actual Zabbix directory, although it is possible to run the script entirely somewhere else (the code is webhook based, picking up information from Zabbix is via the front-end login and API).
+_(2023/06/30)_
 
-# I'm assuming
+_This version has been verified with Zabbix 5.4, 6.0 LTS and 6.4._
-- you are familiar with "composer"
-- you know how to configure a webserver/virtual host
-- that you have CURL and PHP installed
 
-# Prepare the installation
+Minor updates to the mailGraph code
-- Pick a directory within a (virtual) host of your webserver
+- When not defining zabbix_api_user and zabbix_api_pwd in the configuration file the zbx_user and zbx_user_pwd wll be used
-- Create the directories "config", "images", "log", "templates" and "tmp" inside this directory
-- Copy .htaccess to the main directory _(if not using Apache make sure your webserver denies access to /config!)_
-- Copy mailGraph.php to the main directory
-- Install SwiftMailer: `composer require swiftmailer/swiftmailer`
-- Install TWIG: `composer require twig/twig`
-- Copy config/config.php to your /config directory
-- Copy config/config.json.template to your /config/ directory and rename to "config.json"
-- Copy templates/html.template and templates/plain.template to your templates directory
-- Copy mailGraph.xml to a location where you can upload the Media Type to Zabbix
 
-# Configuration
+## Zabbix 6.4.x testing ##
-- Goto your /config directory
+_(2023/06/30)_
-- Two ways to configure the config.json file: 1) with config.php or 2) with your favorite text editor (note that you must have knowledge of JSON format to use this option)'
-- List the available configuration options with "php config.php config.json list"
-- Change any option with "php config.php config.json replace 'key_name' 'new_value'" (note the usage of the single quotes from the command-line!)
 
-**"script_baseurl"** should point to the URL of your directory (ie. "https://mydomain.com/mailgraph/"). Note the ending '/'!
+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")
 
-**"zabbix_user"** must be a Zabbix SuperAdmin user you create to login to Zabbix (this is for grabbing the images via the regular Zabbix routines).
+Sidenotes
+- Zabbix logging still shows deprecation messages however it is believed these are internal to Zabbix and not related to mailGraph
 
-**"zabbix_user_api"** must also be a Zabbix SuperAdmin user your create to login to the Zabbix API (this is for grabbing the information of the event via the Zabbix API).
+_(2023/06/29)_
 
-**"mail_from"** must be a valid e-mail address which represents the 'from' address in the mails that are sent (ie. "zabbix.mailgraph.noreply@domain.com").
+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.
 
-# Load the Media Type "MailGraph" into Zabbix
+## Zabbix 6.2.x testing ##
-- Login to your Zabbix instance
+_(2022/10/10)_
-- Goto "Administration" => "Media yypes"
-- Import the "mailGraph.xml" file
-- Edit the new media type
-- Configure some of the macros associated
 
-"baseURL" must contain your Zabbix URL (ie. "https://mydomain.com/zabbix/"). Note the ending '/'!
+Testing completed. No immediate issues found.
 
-You can set your custom "graphWidth" and "GraphHeight" to your convenience.
+_(2022/08/22)_
 
-You can switch the graph legend on/off with "showLegend" (0=off,1=on).
+Zabbix 6.2.x testing is in progress. Once completed the next effort will be to deliver on automatic configuration detection and automatic updates.
 
-You can change the "subject" of the e-mail that is sent (note that the markup can be a combination of Zabbix MACRO or TWIG notation!).
+## 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.
 
-"URL" is the url to the mailGraph script (ie. "https://mydomain.com/mailGraph.php").
+**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**
 
-# Actions configuration
+## Example message
-At this point the Media type is ready for configuration under "actions" as per the regular way of Zabbix alert processing. Please refer to the manual how to configure.
+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.
 
-# Template adjustments
+[![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)
-I've picked TWIG as the template processor, where the following macros are available for your convenience. Feel free to adjust the html.template and plain.template files as you see fit for your situation!
-
-Values available:
-
-{{ baseURL }} - base url of the Zabbix system (use for references to API and login)
-
-{{ TRIGGER_ID }} - id of the applicable trigger
-
-{{ TRIGGER_DESCRIPTION }} - raw trigger description (note: macros are not parsed!)
-
-{{ TRIGGER_COMMENTS }} - comments of the trigger
-
-{{ TRIGGER_URL }} - url of the trigger form
-
-{{ ITEM_ID }} - id of the associated item to the trigger
-
-{{ ITEM_KEY }} - key of the item
-
-{{ ITEM_NAME }} - item name
-
-{{ ITEM_DESCRIPTION }} - description of the item
-
-{{ ITEM_LASTVALUE }} - last value of the item
-
-{{ ITEM_PREVIOUSVALUE }} - the value of the before LASTVALUE
-
-{{ ITEM_URL }} - url of the item form
-
-{{ HOST_ID }} - id of the associated host to the item
-
-{{ HOST_NAME }} - name of the host
-
-{{ HOST_ERROR }} - last error state of the applicable host
-
-{{ HOST_DESCRIPTION }} - description of the host
-
-{{ HOST_URL }} - url of the host form
-
-{{ EVENT_ID }} - id of the associated event
-
-{{ EVENT_NAME }} - name of the event (note: macros are parsed!)
-
-{{ EVENT_OPDATA }} - associated operational data of the vent
-
-{{ EVENT_VALUE }} - event state (0=Recovered, 1=Triggered/Active)
-
-{{ EVENT_SEVERITY }} - severity of the event
-
-{{ EVENT_STATUS }} - status of the event
-
-{{ EVENT_URL }} - url of the event details
-
-{{ GRAPH_ID }} - id of the (first) associated graph that contains the item
-
-{{ GRAPH_NAME }} - name of this graph
-
-{{ GRAPH_URL }} - URL to this graph (assuming script produces to an accessible location)
-
-{{ GRAPH_CID }} - IMG embed string (<img src="{{ GRAPH_CID }}" />)
-
-{{ LOG_HTML }} - script log in HTML format
-
-{{ LOG_PLAIN }} - script log in PLAIN text format
-
-# Troubleshooting
-In general if something goes wrong (no output), use the following sequence to identify where the error has occured (and raise an issue in this repository so I can take a look at it):
-- Goto Zabbix => Reports => Action Log and search for events with Status "Failed"
-- Note the itemId, triggerId and eventId from this event for testing the Media Type manually
-- If the popup message says "Syntax Error" something went wrong with the processing during the script. In this case you have to investigate a bit more what is happening.
-
-The easiest way to test what is happening is to now goto Administration => Media types and hit the "Test" at the right hand side for MailGraph.
-- Replace relevant macros with information (eventId, triggerId, itemId, recipient, baseUrl and URL) and hit "Test"
-- The last line in the result will tell you what the problem is (most likely an access or connectivity issue)
-- Fix accordingly and retry
-
-To facilitate troubleshooting, you can (at code level):
-- switch on $cDebugMail to receive processing logs as attachment of an e-mail message
-- store logs in the /log directory when $cDebug is switched on
-
-In case of an issue that happens before an e-mail is sent, you can also perform a CLI based test:
-- php mailGraph.php test
-
-Note that you have to set the configuration items starting with "cli" in config.json with actual values from a previous message to make this work!
-
-Last resort is to raise an issue in this repository and I will try to assist as soon as possible to fix it.

config/config.json.template

@@ -1,16 +1,28 @@
 {
-    "script_baseurl": "https:\/\/domain.com\/",
+    "script_baseurl": "https:\/\/mydomain.com\/",
     "cli_itemId": 0,
     "cli_triggerId": 0,
     "cli_eventId": 0,
-    "cli_eventValue": 0,
     "cli_duration": 0,
-    "cli_recipient": "recipient@domain.com",
+    "cli_recipient": "recipient@mydomain.com",
-    "cli_subject": "\"{{ HOST_NAME }}\":  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME }}"
+    "cli_subject": "[TEST] {{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
-    "cli_baseURL": "https:\/\/domain.com\/zabbix\/",
+    "cli_baseURL": "https:\/\/mydomain.com\/zabbix\/",
+    "cli_period": "30m",
+    "cli_period_header": "Last 30 minutes",
+    "cli_debug": 1,
+    "cli_proxy": "",
     "zabbix_user": "alogicalusername",
-    "zabbix_pwd": "astrongpassword",
+    "zabbix_user_pwd": "astrongpassword",
     "zabbix_api_user": "alogicalusername",
     "zabbix_api_pwd": "astrongpassword",
-    "mail_from": "sender@domain.com"
+    "mail_from": "sender@mydomain.com",
+    "subject": "{{ HOST_NAME|raw }}:  ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
+    "smtp_server": "localhost",
+    "smtp_port": 25,
+    "smtp_transport": "none",
+    "smtp_strict": "yes",
+    "graph_match": "any",
+    "period": "20m",
+    "period_header": "Last 20 minutes",
+    "debug": 0
 }

config/config.json.template.multigraph

@@ -0,0 +1,28 @@
+{
+    "script_baseurl": "https:\/\/mydomain.com\/",
+    "cli_itemId": 0,
+    "cli_triggerId": 0,
+    "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_periods": "10m,4h,2d,7d",
+    "cli_periods_headers": "Last 10 minutes,Last 4 hours,Last 2 days,Last 7 days",
+    "cli_debug": 1,
+    "cli_proxy": "",
+    "zabbix_user": "alogicalusername",
+    "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_strict": "yes",
+    "graph_match": "any",
+    "periods": "10m,4h,2d,7d",
+    "periods_headers": "Last 10 minutes,Last 4 hours,Last 2 days,Last 7 days",
+    "debug": 0
+}

config/config.php

@@ -27,7 +27,7 @@
         $content = file_get_contents($argv[1]);
         $data = json_decode($content,TRUE);
 
-        if ($data==NULL)
+        if (($data==NULL) && (sizeof($content)>2))
         {
             echo 'Invalid JSON format in config file?!'.$cCRLF;
             die;
@@ -138,4 +138,4 @@
         default:
             echo 'Unknown command?'.$cCRLF;
     }
-?>
+?>

javascript/READ.ME

@@ -0,0 +1 @@
+Issue #32 has been resolved. The javascript code now works for Zabbix 5.4, 6.0 LTS and 6.4.

javascript/zabbix.mailGraph.js

@@ -0,0 +1,86 @@
+// mailGraph v2.11
+try {
+    // Pickup parameters
+    params = JSON.parse(value),
+        req = new HttpRequest(),
+        fields = {},
+        resp = '',
+        result = { tags: {} };
+
+    // Set HTTP proxy if required
+    if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
+        req.setProxy(params.HTTPProxy);
+        fields.HTTPProxy = params.HTTPProxy;
+    }
+
+    // Declare output type
+    req.addHeader('Content-Type: application/json');
+
+    // Must have fields
+    fields.itemId = params.itemId * 1;
+    fields.eventId = params.eventId * 1;
+    fields.recipient = params.recipient;
+    fields.baseURL = params.baseURL;
+    fields.duration = params.duration * 1;
+
+    if (isNaN(fields.eventId)) {
+      throw '[MailGraph Webhook] Invalid event ID? Integer required (use actual event ID from Zabbix!)';
+    }
+
+    if (isNaN(fields.duration)) {
+      throw '[MailGraph Webhook] Invalid duration? Integer required (set to zero if unknown)!';
+    }
+
+    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; }
+    if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }
+    if (typeof params.subject === 'string') { fields.subject = params.subject; }
+    if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }
+    if (typeof params.periods === 'string') { fields.periods = params.periods; }
+    if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }
+    if (typeof params.debug === 'string') { fields.debug = params.debug; }
+
+    // Add generic fields
+    Object.keys(params).forEach(function(key) {
+        if (key.substring(0, 4) == 'info') {
+            fields[key] = params[key];
+        }
+    });
+
+    // 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] Received response:' + resp);
+
+    // If blank the email address is likely incorrect
+    if (resp==null) {
+      throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
+    }
+
+    // If there was an error, report it and stop
+    if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
+
+    // If no datas returned, report it and stop
+    if (resp.charAt(0) == "!") {
+      throw '[MailGraph Webhook] No data received from mailGraph! Likely the event ID provided does not exist? Check mailGraph logging';
+    }
+
+    // We expect the message id back from the processing script
+    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);
+    throw 'MailGraph notification failed : '+error;
+}

mailGraph.xml

@@ -1,204 +1,198 @@
-<?xml version="1.0" encoding="UTF-8"?>
+zabbix_export:
-<zabbix_export>
+  version: '5.4'
-    <version>5.0</version>
+  date: '2023-07-01T10:54:39Z'
-    <date>2021-02-28T20:27:03Z</date>
+  media_types:
-    <media_types>
+    -
-        <media_type>
+      name: MailGraph
-            <name>MailGraph</name>
+      type: WEBHOOK
-            <type>WEBHOOK</type>
+      parameters:
-            <parameters>
+        -
-                <parameter>
+          name: baseURL
-                    <name>baseURL</name>
+          value: 'https://myzabbix.example.com/'
-                    <value>https://domain.com/zabbix/</value>
+        -
-                </parameter>
+          name: duration
-                <parameter>
+          value: '{EVENT.DURATION}'
-                    <name>duration</name>
+        -
-                    <value>{EVENT.DURATION}</value>
+          name: eventId
-                </parameter>
+          value: '{EVENT.ID}'
-                <parameter>
+        -
-                    <name>eventId</name>
+          name: graphHeight
-                    <value>{EVENT.ID}</value>
+          value: '120'
-                </parameter>
+        -
-                <parameter>
+          name: graphWidth
-                    <name>eventValue</name>
+          value: '300'
-                    <value>{EVENT.VALUE}</value>
+        -
-                </parameter>
+          name: HTTPProxy
-                <parameter>
+          value: ''
-                    <name>graphHeight</name>
+        -
-                    <value>120</value>
+          name: infoTest
-                </parameter>
+          value: Test
-                <parameter>
+        -
-                    <name>graphWidth</name>
+          name: itemId
-                    <value>300</value>
+          value: '{ITEM.ID}'
-                </parameter>
+        -
-                <parameter>
+          name: periods
-                    <name>HTTPProxy</name>
+          value: '10m,4h,1d,7d'
-                    <value/>
+        -
-                </parameter>
+          name: periods_headers
-                <parameter>
+          value: 'Last 10 minutes,Last 4 hours,Last day,Last 7 days'
-                    <name>itemId</name>
+        -
-                    <value>{ITEM.ID}</value>
+          name: recipient
-                </parameter>
+          value: '{ALERT.SENDTO}'
-                <parameter>
+        -
-                    <name>recipient</name>
+          name: showLegend
-                    <value>{ALERT.SENDTO}</value>
+          value: '0'
-                </parameter>
+        -
-                <parameter>
+          name: subject
-                    <name>showLegend</name>
+          value: '{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}'
-                    <value>0</value>
+        -
-                </parameter>
+          name: URL
-                <parameter>
+          value: 'https://myzabbix.example.com/mailGraph.php'
-                    <name>subject</name>
+      script: |
-                    <value>{{ HOST_NAME }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME }}</value>
+        // mailGraph v2.11
-                </parameter>
+        try {
-                <parameter>
+            // Pickup parameters
-                    <name>triggerId</name>
+            params = JSON.parse(value),
-                    <value>{TRIGGER.ID}</value>
+                req = new HttpRequest(),
-                </parameter>
+                fields = {},
-                <parameter>
+                resp = '',
-                    <name>URL</name>
+                result = { tags: {} };
-                    <value>https://domain.com/mailGraph.php</value>
+        
-                </parameter>
+            // Set HTTP proxy if required
-            </parameters>
+            if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
-            <script>try {&#13;
+                req.setProxy(params.HTTPProxy);
-  // Pickup parameters&#13;
+                fields.HTTPProxy = params.HTTPProxy;
-  params = JSON.parse(value),&#13;
+            }
-           req = new CurlHttpRequest(),&#13;
+        
-           fields = {},&#13;
+            // Declare output type
-           resp = '',&#13;
+            req.addHeader('Content-Type: application/json');
-           result = { tags: {} };&#13;
+        
-&#13;
+            // Must have fields
-  // Set HTTP proxy if required&#13;
+            fields.itemId = params.itemId * 1;
-  if (typeof params.HTTPProxy === 'string' &amp;&amp; params.HTTPProxy.trim() !== '') { req.setProxy(params.HTTPProxy); }&#13;
+            fields.eventId = params.eventId * 1;
-&#13;
+            fields.recipient = params.recipient;
-  // Declare output type&#13;
+            fields.baseURL = params.baseURL;
-  req.AddHeader('Content-Type: application/json');&#13;
+            fields.duration = params.duration * 1;
-&#13;
+        
-  // Must have fields&#13;
+            if (isNaN(fields.eventId)) {
-  fields.itemId = params.itemId;&#13;
+              throw '[MailGraph Webhook] Invalid event ID? Integer required (use actual event ID from Zabbix!)';
-  fields.triggerId = params.triggerId;&#13;
+            }
-  fields.eventId = params.eventId;&#13;
+        
-  fields.eventValue = params.eventValue;&#13;
+            if (isNaN(fields.duration)) {
-  fields.recipient = params.recipient;&#13;
+              throw '[MailGraph Webhook] Invalid duration? Integer required (set to zero if unknown)!';
-  fields.baseURL = params.baseURL;&#13;
+            }
-  fields.duration = params.duration;&#13;
+        
-&#13;
+            if (fields.recipient.charAt(0) == '{') {
-  // Optional fields&#13;
+              throw '[MailGraph Webhook] Please define recipient for the test message!';
-  if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }&#13;
+            }
-  if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }&#13;
+        
-  if (typeof params.subject === 'string') { fields.subject = params.subject; }&#13;
+            // Optional fields
-  if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }&#13;
+            if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
-&#13;
+            if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }
-  // Post information to the processing script&#13;
+            if (typeof params.subject === 'string') { fields.subject = params.subject; }
-  Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));&#13;
+            if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }
-  var resp = req.Post(params.URL,JSON.stringify(fields));&#13;
+            if (typeof params.periods === 'string') { fields.periods = params.periods; }
-  Zabbix.Log(4, '[Mailgraph Webhook] Receiving response:' + resp);&#13;
+            if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }
-&#13;
+            if (typeof params.debug === 'string') { fields.debug = params.debug; }
-  // If there was an error, report it&#13;
+        
-  if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }&#13;
+            // Add generic fields
-&#13;
+            Object.keys(params).forEach(function(key) {
-  // We expect the message id back from the processing script&#13;
+                if (key.substring(0, 4) == 'info') {
-  resp = JSON.parse(resp);&#13;
+                    fields[key] = params[key];
-  result.tags.__message_id = resp.messageId;&#13;
+                }
-&#13;
+            });
-  // Pass the result back to Zabbix&#13;
+        
-  return JSON.stringify(result);&#13;
+            // Post information to the processing script
-}&#13;
+            Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
-catch (error)&#13;
+            var resp = req.post(params.URL,JSON.stringify(fields));
-{&#13;
+            Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
-  // In case something went wrong in the processing, pass the error back to Zabbix&#13;
+        
-  Zabbix.Log(127, 'MailGraph notification failed : '+error);&#13;
+            // If blank the email address is likely incorrect
-  throw 'MailGraph notification failed : '+error;&#13;
+            if (resp==null) {
-}</script>
+              throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
-            <process_tags>YES</process_tags>
+            }
-            <description>The &quot;URL&quot; must point to the location of the processing script. If a proxy is required, define &quot;HTTPProxy&quot; for the proxy address.&#13;
+        
-&#13;
+            // If there was an error, report it and stop
-Customization:&#13;
+            if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
-- &quot;graphWidth&quot; and &quot;graphWidth&quot; can be defined for the image size&#13;
+        
-- &quot;showLegend&quot; can be defined to show or hide the legend of the graph&#13;
+            // If no datas returned, report it and stop
-- &quot;subject&quot; can be defined for a customized subject for the mail message&#13;
+            if (resp.charAt(0) == "!") {
-&#13;
+              throw '[MailGraph Webhook] No data received from mailGraph! Likely the event ID provided does not exist? Check mailGraph logging';
-The html.template and plain.template files can be adjusted (TWIG format).&#13;
+            }
-&#13;
+        
-Values available:&#13;
+            // We expect the message id back from the processing script
-{{ baseURL }} - base url of the Zabbix system (use for references to API and login)&#13;
+            msg = JSON.parse(resp);
-{{ TRIGGER_ID }} - id of the applicable trigger&#13;
+        
-{{ TRIGGER_DESCRIPTION }} - raw trigger description (note: macros are not parsed!)&#13;
+            result.tags.__message_id = msg.messageId;
-{{ TRIGGER_COMMENTS }} - comments of the trigger&#13;
+            Zabbix.Log(4, '[MailGraph Webhook] Message sent with identification "' + msg.messageId + '"');
-{{ TRIGGER_URL }} - url of the trigger form&#13;
+        
-{{ ITEM_ID }} - id of the associated item to the trigger&#13;
+            // Pass the result back to Zabbix
-{{ ITEM_KEY }} - key of the item&#13;
+            return JSON.stringify(result);
-{{ ITEM_NAME }} - item name&#13;
+        }
-{{ ITEM_DESCRIPTION }} - description of the item&#13;
+        catch (error)
-{{ ITEM_LASTVALUE }} - last value of the item&#13;
+        {
-{{ ITEM_PREVIOUSVALUE }} - the value of the before LASTVALUE&#13;
+            // In case something went wrong in the processing, pass the error back to Zabbix
-{{ ITEM_URL }} - url of the item form&#13;
+            Zabbix.Log(127, 'MailGraph notification failed: '+error);
-{{ HOST_ID }} - id of the associated host to the item&#13;
+            throw 'MailGraph notification failed : '+error;
-{{ HOST_NAME }} - name of the host&#13;
+        }
-{{ HOST_ERROR }} - last error state of the applicable host&#13;
+      process_tags: 'YES'
-{{ HOST_DESCRIPTION }} - description of the host&#13;
+      description: |
-{{ HOST_URL }} - url of the host form&#13;
+        The "URL" must point to the location of the processing script. If a proxy is required, define "HTTPProxy" for the proxy address.
-{{ EVENT_ID }} - id of the associated event&#13;
+        
-{{ EVENT_NAME }} - name of the event (note: macros are parsed!)&#13;
+        Customization:
-{{ EVENT_OPDATA }} - associated operational data of the vent&#13;
+        - "graphWidth" and "graphWidth" can be defined for the image size
-{{ EVENT_VALUE }} - event state (0=Recovered, 1=Triggered/Active)&#13;
+        - "showLegend" can be defined to show or hide the legend of the graph
-{{ EVENT_SEVERITY }} - severity of the event&#13;
+        - "subject" can be defined for a customized subject for the mail message
-{{ EVENT_STATUS }} - status of the event&#13;
+        - "periods" and "periods_headers" can be defined for displaying multiple periods of the same graph, or
-{{ EVENT_URL }} - url of the event details&#13;
+        - "period" and "period_header" can be defined to display a single graph
-{{ GRAPH_ID }} - id of the (first) associated graph that contains the item&#13;
+        
-{{ GRAPH_NAME }} - name of this graph&#13;
+        The html.template and plain.template files can be adjusted (TWIG format).
-{{ GRAPH_URL }} - URL to this graph (assuming script produces to an accessible location)&#13;
+        
-{{ GRAPH_CID }} - IMG embed string (&lt;img src=&quot;{{ GRAPH_CID }}&quot; /&gt;)&#13;
+        More details are available at https://github.com/moudsen/mailGraph
-{{ LOG_HTML }} - script log in HTML format&#13;
+      message_templates:
-{{ LOG_PLAIN }} - script log in PLAIN text format</description>
+        -
-            <message_templates>
+          event_source: TRIGGERS
-                <message_template>
+          operation_mode: PROBLEM
-                    <event_source>TRIGGERS</event_source>
+          subject: 'Problem: {EVENT.NAME}'
-                    <operation_mode>PROBLEM</operation_mode>
+          message: |
-                    <subject>Problem: {EVENT.NAME}</subject>
+            Problem started at {EVENT.TIME} on {EVENT.DATE}
-                    <message>Problem started at {EVENT.TIME} on {EVENT.DATE}&#13;
+            Problem name: {EVENT.NAME}
-Problem name: {EVENT.NAME}&#13;
+            Host: {HOST.NAME}
-Host: {HOST.NAME}&#13;
+            Severity: {EVENT.SEVERITY}
-Severity: {EVENT.SEVERITY}&#13;
+            Operational data: {EVENT.OPDATA}
-Operational data: {EVENT.OPDATA}&#13;
+            Original problem ID: {EVENT.ID}
-Original problem ID: {EVENT.ID}&#13;
+            {TRIGGER.URL}
-{TRIGGER.URL}&#13;
+            
-&#13;
+            eventId: {EVENT.ID}
-eventId: {EVENT.ID}&#13;
+            TriggerId: {TRIGGER.ID}
-TriggerId: {TRIGGER.ID}&#13;
+            itemId: {ITEM.ID]
-itemId: {ITEM.ID]</message>
+        -
-                </message_template>
+          event_source: TRIGGERS
-                <message_template>
+          operation_mode: RECOVERY
-                    <event_source>TRIGGERS</event_source>
+          subject: 'Resolved in {EVENT.DURATION}: {EVENT.RECOVERY.NAME}'
-                    <operation_mode>RECOVERY</operation_mode>
+          message: |
-                    <subject>Resolved in {EVENT.DURATION}: {EVENT.NAME}</subject>
+            Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
-                    <message>Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}&#13;
+            Problem name: {EVENT.RECOVERY.NAME}
-Problem name: {EVENT.NAME}&#13;
+            Problem duration: {EVENT.DURATION}
-Problem duration: {EVENT.DURATION}&#13;
+            Host: {HOST.NAME}
-Host: {HOST.NAME}&#13;
+            Severity: {EVENT.SEVERITY}
-Severity: {EVENT.SEVERITY}&#13;
+            Original problem ID: {EVENT.ID}
-Original problem ID: {EVENT.ID}&#13;
+            {TRIGGER.URL}
-{TRIGGER.URL}&#13;
+            
-&#13;
+            eventId: {EVENT.ID}
-eventId: {EVENT.ID}&#13;
+            TriggerId: {TRIGGER.ID}
-TriggerId: {TRIGGER.ID}&#13;
+            itemId: {ITEM.ID]
-itemId: {ITEM.ID]</message>
+        -
-                </message_template>
+          event_source: TRIGGERS
-                <message_template>
+          operation_mode: UPDATE
-                    <event_source>TRIGGERS</event_source>
+          subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
-                    <operation_mode>UPDATE</operation_mode>
+          message: |
-                    <subject>Updated problem in {EVENT.AGE}: {EVENT.NAME}</subject>
+            {USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
-                    <message>{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.&#13;
+            {EVENT.UPDATE.MESSAGE}
-{EVENT.UPDATE.MESSAGE}&#13;
+            
-&#13;
+            Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
-Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.&#13;
+            
-&#13;
+            eventId: {EVENT.ID}
-eventId: {EVENT.ID}&#13;
+            TriggerId: {TRIGGER.ID}
-TriggerId: {TRIGGER.ID}&#13;
+            itemId: {ITEM.ID]
-itemId: {ITEM.ID]</message>
-                </message_template>
-            </message_templates>
-        </media_type>
-    </media_types>
-</zabbix_export>
 

templates/html.template

@@ -1,74 +1,192 @@
 <html lang="en"><head><meta http-equiv=Content-Type content="text/html; charset=UTF-8">
 <style>
-	.Resolved {
+    body {
-    background-color:#86cc89;
+        font-family: Arial,sans-serif;
-    border:1px solid #57bd5b;
+    }
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+    .Resolved {
-	}
+        background-color:#86cc89;
-	.Information {
+        border:1px solid #57bd5b;
-    background-color:#7499ff;
+    }
-    border:1px solid #4673f0;
+    .Information {
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+        background-color:#7499ff;
-	}
+        border:1px solid #4673f0;
-	.Warning {
+    }
-    background-color:#FFC859;
+    .Warning {
-    border:1px solid #E69F10;
+        background-color:#FFC859;
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+        border:1px solid #E69F10;
-	}
+    }
-	.Average {
+    .Average {
-    background-color:#FFA059;
+        background-color:#FFA059;
-    border:1px solid #e66e15;
+        border:1px solid #e66e15;
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+    }
-	}
+    .High {
-	.High {
+        background-color:#E97659;
-    background-color:#E97659;
+        border:1px solid #E45959;
-    border:1px solid #E45959;
+    }
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+    .Disaster {
-	}
+        background-color:#E45959;
-	.Disaster {
+        border:1px solid #DE1E09;
-    background-color:#E45959;
+    }
-    border:1px solid #DE1E09;
+    a {
-	font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
+        text-decoration: none;
-	}
+        color: #010059;
+    }
+    a:link {
+        text-decoration: none;
+        color: #010059;
+    }
+    a:visited {
+        text-decoration: none;
+        color: #010059;
+    }
+    a:active {
+        text-decoration: none;
+        color: #010059;
+    }
+    hr {
+        border: none;
+        height: 1px;
+        color: #333; /* old IE */
+        background-color: #333;
+    }
+    .MsgBody {
+        width: 100%;
+    }
+    #maintable {
+        width: 800px;
+    }
+    @media screen and (max-width: 800px;) {
+        #maintable {
+            width: 100%;
+            max-width: 790px;
+        }
+        #mainimage {
+            -ms-interpolation-mode: bicubic;
+            width: 100%;
+            max-width: 790px;
+            max-height: 450px;
+        }
+    }
+    .links {
+        font-size: 9px;
+    }
+    .header {
+        font-size: 16px;
+        font-weight: bold;
+    }
+    .graphHeader {
+        font-size: 14px;
+        font-weight: bold;
+    }
+    .content {
+        font-size: 14px;
+    }
 </style>
 </head>
 <body>
-<table style="margin: 10px;border-spacing:0 15px;border-collapse: separate;">
+    <table style="margin: 5px;border-spacing:0 10px;border-collapse: separate;" align=center>
-	<tr>
+        <tr>
-		<td class="{{ EVENT_SEVERITY }}" style="border-radius:10px;padding: 10px 36px 10px 36px; ">
+            <td class="{{ EVENT_SEVERITY }}" style="border-radius:10px;padding:5px 18px 5px 18px; ">
-			<table class="{{ EVENT_SEVERITY }}" style="border:0; text-align:left;" cellpadding="0" cellspacing="0">
+                <table class="{{ EVENT_SEVERITY }}" style="border:0; text-align:left;" cellpadding="0" cellspacing="0">
-                <tr><td>
+                    <tr>
-				<p><b>EVENT INFORMATION</b></p>
+                        <td>
-                    Description: <b>{{ EVENT_NAME }}</b><br/>
+                            <p><span class="header">EVENT INFORMATION</span></p>
-                    Host: <b>{{ HOST_NAME }}</b>
+                            <span class="content">
+                                Description: <b>{{ EVENT_NAME }}</b><br/>
+                                Host: <b>{{ HOST_NAME }}</b>
 {% if HOST_ERROR|length > 0 %}
- ({{ HOST_ERROR }})
+                                ({{ HOST_ERROR }})
 {% endif %}
-                    <br/>
+                                <br/>
-                    Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
+{% if EVENT_OPDATE|length > 0 %}
-                    Status: <b>{{ EVENT_STATUS }}</b><br/>
+                                Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
-                    Severity: <b>{{ EVENT_SEVERITY }}</b><br/>
+{% endif %}
+                                Status: <b>{{ EVENT_STATUS }}</b><br/>
+                                Severity: <b>{{ EVENT_SEVERITY }}</b><br/>
 {% if EVENT_SEVERITY == "Resolved" %}
-                    Duration: <b>{{ EVENT_DURATION }}</b><br/>
+                                Duration: <b>{{ EVENT_DURATION }}</b><br/>
 {% endif %}
-                    Item: <b>{{ ITEM_NAME }}</b><br/>
+                                Item: <b>{{ ITEM_NAME }}</b><br/>
-                    Previous/Last: {{ ITEM_PREVIOUSVALUE }} ==&gt; {{ ITEM_LASTVALUE }}
+                                Previous/Last: {{ ITEM_PREVIOUSVALUE }} ==&gt; {{ ITEM_LASTVALUE }}
-                <p><a href="{{ EVENTDETAILS_URL }}">Event Details</a><br/></p>
+                            </span>
-                </td></tr>
+                        </td>
-			</table>
+                    </tr>
-		</td>
+                </table>
-	</tr>
+            </td>
-{% if GRAPH_CID|length > 0 %}
+        </tr>
-    <tr>
+        <tr>
-        <td align="center"><img src="{{ GRAPH_CID }}" /></td>
+            <td class="links">
-    </tr>
+                <div align=center>
+                    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>
+{% if GRAPH_ZABBIXLINK|length > 0 %}
+                    // Graph ID: <a href="{{ GRAPH_ZABBIXLINK }}">{{ GRAPH_ID }}</a>
 {% endif %}
-</table>
+                </div>
-    <p style="font-size:10px">
+            </td>
-        Event ID: <a href="{{ EVENTDETAILS_URL }}">{{ EVENT_ID }}</a> //
+        </tr>
-        Trigger ID: <a href="{{ TRIGGER_URL }}">{{ TRIGGER_ID }}</a> //
+{% for aGraph in GRAPHS_I %}
-        Item ID: <a href="{{ ITEM_URL }}">{{ ITEM_ID }}</a> //
+        <tr>
-        Host ID: <a href="{{ HOST_URL }}">{{ HOST_ID }}</a>
+            <div align=justify>
-    </p>
+                <td align="center">
+                    <span class="graphHeader">{{ aGraph.HEADER }}</span><br/>
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+{% endfor %}
+{% if TRIGGER_SCREEN > 0 %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <span class="graphHeader">{{ GRAPHS_T_HEADER }} - {{ GRAPHS_T_PERIODHEADER }}</span>
+                </td>
+            </div>
+        </tr>
+        <tr>
+            <td class="links">
+                <div align="center">
+                    Screen ID: <a href="{{ GRAPHS_T_LINK }}">{{ TRIGGER_SCREEN }}</a>
+                </div>
+            </td>
+        </tr>
+    {% for aGraph in GRAPHS_T %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+    {% endfor %}
+{% endif %}
+{% if HOST_SCREEN > 0 %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <span class="graphHeader">{{ GRAPHS_H_HEADER }} - {{ GRAPHS_H_PERIODHEADER }}</span>
+                </td>
+            </div>
+        </tr>
+        <tr>
+            <td class="links">
+                <div align="center">
+                    Screen ID: <a href="{{ GRAPHS_H_LINK }}">{{ HOST_SCREEN }}</a>
+                </div>
+            </td>
+        </tr>
+    {% for aGraph in GRAPHS_H %}
+        <tr>
+            <div align=justify>
+                <td align="center">
+                    <img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
+                </td>
+            </div>
+        </tr>
+    {% endfor %}
+{% endif %}
+    </table>
 </body>
-</html>
+</html>

templates/plain.template

@@ -3,10 +3,10 @@ EVENT INFORMATION #{{ EVENT_ID }}
 Severity:    {{ EVENT_SEVERITY }}
 Description: {{ EVENT_NAME }}
 
-{% if GRAPH_CID|length > 0 %}
+{% if GRAPH_CID1|length > 0 %}
-GRAPH #{{ GRAPH_ID }}
+GRAPH #{{ GRAPH_ID1 }}
-{{ GRAPH_URL }}
+{{ GRAPH_URL1 }}
-This graph will remain available for approx. the next 2 weeks only; use HTML reader after this period to view the graph.
+This graph will remain available for approx. the next 2 weeks only; use HTML reader after this period to view the graph that is embedded in the attached HTML version.
 {% endif %}
 
 TRIGGER #{{ TRIGGER_ID }}