Compare commits

..

No commits in common. "main" and "v2.11" have entirely different histories.
main ... v2.11

18 changed files with 547 additions and 1065 deletions

View File

@ -1,62 +1,65 @@
## Introduction ## ## mailGraph v2.11 release ##
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. _(2023/07/01)_
This initiated the development of mailGraph v1 in Zabbix 5.4 delivering an elementary solution for sending HTML enriched messages from Zabbix including graphs. _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)_
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.
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. Release notes
- 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)
Note that all Zabbix host, item or screen related information is made available to Twig automatically. Modified files
- mailGraph.php
- mailGraph.xml
- javascript/zabbix.mailGraph.js
Example message: 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 image](https://github.com/moudsen/mailGraph/assets/16045332/0cb671d9-464f-493b-b250-15dd550fd84a) Changes are in effect immediately, no need to restart any services.
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. ## mailGraph v2.10 release ##
Currently mailGraph supports hosts, (one or more related) items and screens (applicable to Zabbix 5.4 only). _(2023/06/30)_
More information can be found in the Wiki. _This version has been verified with Zabbix 5.4, 6.0 LTS and 6.4._
## Installation ## Minor updates to the mailGraph code
Please refer to the Wiki how to get mailGraph installed and configured on your system. - When not defining zabbix_api_user and zabbix_api_pwd in the configuration file the zbx_user and zbx_user_pwd wll be used
## Reference websites ## ## Zabbix 6.4.x testing ##
[Extensive GERMAN installation from scratch](https://znil.net/index.php?title=Zabbix_mailGraph_installieren_-_Trigger_Alerts_Emails_mit_Grafiken) - nice work from Bernard Linz _(2023/06/30)_
## Announcements ## Zabbix 6.4 verification has succesfully completed.
_(2025/02/04)_ - 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")
Started on coding and testing mailGraph v3. Sidenotes
- Zabbix logging still shows deprecation messages however it is believed these are internal to Zabbix and not related to mailGraph
_(2025/01/26)_ _(2023/06/29)_
mailGraph v2.20 now supporting Zabbix 7.0 (LTS) and Zabbix 7.2 (in particular the new API bearer token authentication method). 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.
_(2024/12/01)_ ## Zabbix 6.2.x testing ##
_(2022/10/10)_
As per December 2024 PHP 7 and older is no longer supported. Please upgrade to a supported PHP 8 version. Testing completed. No immediate issues found.
Note that mailGraph is expected to function in older PHP versions.
_(2023/11/01)_ _(2022/08/22)_
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. Zabbix 6.2.x testing is in progress. Once completed the next effort will be to deliver on automatic configuration detection and automatic updates.
Principal bug fixing on mailGraph v2.x (logic failure or similar) will continue but only for Zabbix 6.x onwards. ## 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.
## Ideas and improvements ## **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**
I'm open to new feature requests - please raise an issue for this in this Github space. ## 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.
[#50 - Docker support](https://github.com/moudsen/mailGraph/issues/50) - Docker support inserted shortly after testing; will be pushed into release 3 shortly. [![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)
_Please refer to the `docker` directory for the first release of the docker image on Docker Hub (hoppa66/zabbix-mailgraph)_
## 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.

View File

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

View File

@ -1,31 +0,0 @@
{
"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
}

View File

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

View File

@ -1 +0,0 @@
RESTART_POLICY=unless-stopped

View File

@ -1,88 +0,0 @@
FROM ubuntu:latest
#########################################################################################################
#########################################################################################################
##
## ZABBIX-MAILGRAPH (Dockerfile)
## =============================
## Dockerfile to builld and configure the zabbix-mailgraph image.
##
## -----------------------------------------------------------------------------------------------------
## v0.9.1 2025/05/05 - Mark Oudsen - First public beta - Pending documentation
## v0.9.0 2025/05/05 - Mark Oudsen - Internal test release
## v0.1.0 2025/05/05 - Mark Oudsen - Initial build, based on idea from "dima-online
## "https://github.com/moudsen/mailGraph/issues/50
##
## -----------------------------------------------------------------------------------------------------
##
## (C) M.J.Oudsen, mark.oudsen@puzzl.nl
## MIT License
## Credits: "demi-online" (https://github.com/dima-online)
##
#########################################################################################################
#########################################################################################################
# Disable interactive functions
ENV DEBIAN_FRONTEND=noninteractive
# Install Apache, PHP and supplimentary programs
RUN apt-get update && \
apt-get install -y apache2 \
libapache2-mod-php \
php-curl \
php-zip \
curl \
git
# Clean out APT files
RUN rm -rf /var/lib/apt/lists/*
RUN apt-get clean -y
# Install Composer for PHP dependencies
RUN cd /tmp && curl -sS https://getcomposer.org/installer | php && mv composer.phar /usr/local/bin/composer
# Enable Apache modules
RUN a2enmod php8.3
RUN a2enmod rewrite
# Update the PHP.ini file, enable <? ?> tags and quieten logging.
RUN sed -i "s/short_open_tag = Off/short_open_tag = On/" /etc/php/8.3/apache2/php.ini
RUN sed -i "s/error_reporting = .*$/error_reporting = E_ERROR | E_WARNING | E_PARSE/" /etc/php/8.3/apache2/php.ini
# Manually set up the apache environment variables
ENV APACHE_RUN_USER=www-data
ENV APACHE_RUN_GROUP=www-data
ENV APACHE_LOG_DIR="/var/log/apache2"
ENV APACHE_LOCK_DIR="/var/lock/apache2"
ENV APACHE_PID_FILE="/var/run/apache2.pid"
# Copy the Github code into Apache site directory (run fetch_mailgraph.sh before building!)
ADD www /var/www/site/public
# Copy the cleanup script into local bin
ADD cleanup.sh /usr/local/bin/cleanup
RUN chmod +x /usr/local/bin/cleanup
# Fetch dependencies via Composer
RUN composer require phpmailer/phpmailer
RUN composer require twig/twig
# Move into the site directory
RUN mv /composer* /var/www/site/public/.
RUN mv /vendor /var/www/site/public/.
# Create some directories not existing yet
RUN mkdir /var/www/site/public/log
RUN mkdir /var/www/site/public/tmp
# Fix ownership
RUN chown www-data.www-data -R /var/www/site/public
# Update(/overwrite) the default apache site with the config we created
ADD apache-config.conf /etc/apache2/sites-enabled/000-default.conf
# Expose the HTTP port to external
EXPOSE 80
# By default, simply start apache
ENTRYPOINT ["/usr/sbin/apache2ctl", "-D", "FOREGROUND"]

View File

@ -1,44 +0,0 @@
## Introduction ##
With the following instructions, mailGraph can be run in a Docker container.
Every new version of mailGraph will also be deployed to Docker Hub.
WORK-IN-PROGRESS
## Instructions - Plain vanilla deployment ##
- Create a directory structure on your system as follows:
```
mkdir /opt/Zabbix-Mailgraph
mkdir /opt/Zabbix-Mailgraph/config
mkdir /opt/Zabbix-Mailgraph/templates
```
- Create a new `config.json` in the above `config` directory and configure accordingly (refer to the wiki for more detailed instructions or use the `config.json.template` as a boilerplate).
- Copy the `plain.template` and `html.template` into the above `templates` directory.
- Deploy the mailGraph container, preferably using `docker-compose`:
-- Adopt and configure the `docker-compose.yml` file to your needs;
-- Configure `RESTART_POLICY=unless-stopped` in a file name `.env` (same directory as `docker-compose`).
- Start the container: `docker-compose -D up`.
- Follow best-practices on your applicable Linux version to ensure the container is started after a reboot.
When running:
- mailGraph is exposed on port `9080` (point the Zabbix webhook to this location).
- Apache logging is exposed on `/opt/Zabbix-Mailgraph/apache.log`.
## Testing and Debugging ##
- Display currently running containers `docker ps`.
- Execute `docker exec -it <container name> sh` for a shell into the container.
- Following the instructions in the Wiki on troubleshooting and debugging, i.e.:
-- `cd /var/www/site/public`
-- `php mailGraph.test test`
- When done testing, `exit` the container.
## Periodic cleanup of images and logs ##
The following command must be run on a regular basis to clean up images and logs (add to cron for example):
- `docker exec -it <container name> cleanup`
## Custom deployment ##
In case you like to adjust the container to your needs, you can adopt and modiyfy the provisioned scripts and files in this directory.
Please do not forget to modify the repository name in `build.sh` and `docker-compose.yml`.
## 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 with regards for mailGraph on Docker:
- [dima-online](https://github.com/dima-online)

View File

@ -1,18 +0,0 @@
ServerName mailgraph.mydomain.com
<VirtualHost *:80>
ServerAdmin me@mydomain.com
DocumentRoot /var/www/site/public
<Directory /var/www/site/public>
Options Indexes FollowSymLinks MultiViews
AllowOverride All
Order deny,allow
Allow from all
</Directory>
ErrorLog ${APACHE_LOG_DIR}/error.log
CustomLog ${APACHE_LOG_DIR}/access.log combined
</VirtualHost>

View File

@ -1,2 +0,0 @@
#!/bin/bash
docker build -t hoppa66/zabbix-mailgraph .

View File

@ -1,3 +0,0 @@
#!/bin/bash
cd /var/www/site/public
php mailGraph.php cleanup

View File

@ -1,13 +0,0 @@
version: '2.1'
services:
webhook:
image: hoppa66/zabbix-mailgraph:latest
restart: ${RESTART_POLICY}
hostname: mailgraph
ports:
- "9080:80"
volumes:
- /opt/Zabbix-mailGraph/apache.log:/var/log/apache2:rw
- /opt/Zabbix-mailGraph/config:/var/www/site/public/config:ro
- /opt/Zabbix-mailGraph/templates:/var/www/site/public/templates:ro

View File

@ -1,3 +0,0 @@
#!/bin/bash
rm -rf www
git clone https://github.com/moudsen/mailGraph.git www

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

View File

@ -1,15 +1,4 @@
// mailGraph v2.20 // mailGraph v2.11
// Function to test string
function isJSON(str) {
try {
JSON.stringify(JSON.parse(str));
return true;
} catch (e) {
return false;
}
}
try { try {
// Pickup parameters // Pickup parameters
params = JSON.parse(value), params = JSON.parse(value),
@ -27,13 +16,21 @@ try {
// Declare output type // Declare output type
req.addHeader('Content-Type: application/json'); req.addHeader('Content-Type: application/json');
// Pick up fields relevant for mailGraph API level call while parsing/casting fields that should be integer // Must have fields
fields.itemId = params.itemId * 1; fields.itemId = params.itemId * 1;
fields.eventId = params.eventId * 1; fields.eventId = params.eventId * 1;
fields.recipient = params.recipient; fields.recipient = params.recipient;
fields.baseURL = params.baseURL; fields.baseURL = params.baseURL;
fields.duration = params.duration * 1; 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) == '{') { if (fields.recipient.charAt(0) == '{') {
throw '[MailGraph Webhook] Please define recipient for the test message!'; throw '[MailGraph Webhook] Please define recipient for the test message!';
} }
@ -59,30 +56,20 @@ try {
var resp = req.post(params.URL,JSON.stringify(fields)); var resp = req.post(params.URL,JSON.stringify(fields));
Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp); Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
// The response can be // If blank the email address is likely incorrect
// - 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)
if (req.getStatus() != 200) {
throw '[MailGraph Webhook] Processing of mailGraph.php failed: ' + resp;
}
if (resp==null) { if (resp==null) {
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)'; throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
} }
if (resp=='') { // If there was an error, report it and stop
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.'; 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';
} }
// Check if JSON was returned // We expect the message id back from the processing script
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); msg = JSON.parse(resp);
result.tags.__message_id = msg.messageId; result.tags.__message_id = msg.messageId;
@ -93,7 +80,7 @@ try {
} }
catch (error) catch (error)
{ {
// In case something else went wrong in the processing, pass the error back to Zabbix // In case something went wrong in the processing, pass the error back to Zabbix
Zabbix.Log(127, 'MailGraph notification failed: '+error); Zabbix.Log(127, 'MailGraph notification failed: '+error);
throw 'MailGraph notification failed : '+error; throw 'MailGraph notification failed : '+error;
} }

File diff suppressed because it is too large Load Diff

View File

@ -1,215 +1,198 @@
<?xml version="1.0" encoding="UTF-8"?> zabbix_export:
<zabbix_export> version: '5.4'
<version>5.4</version> date: '2023-07-01T10:54:39Z'
<date>2023-08-16T20:38:38Z</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://myzabbix.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>graphHeight</name> value: '300'
<value>120</value> -
</parameter> name: HTTPProxy
<parameter> value: ''
<name>graphWidth</name> -
<value>300</value> name: infoTest
</parameter> value: Test
<parameter> -
<name>HTTPProxy</name> name: itemId
<value/> value: '{ITEM.ID}'
</parameter> -
<parameter> name: periods
<name>infoTest</name> value: '10m,4h,1d,7d'
<value>Test</value> -
</parameter> name: periods_headers
<parameter> value: 'Last 10 minutes,Last 4 hours,Last day,Last 7 days'
<name>periods</name> -
<value>10m,4h,1d,7d</value> name: recipient
</parameter> value: '{ALERT.SENDTO}'
<parameter> -
<name>periods_headers</name> name: showLegend
<value>Last 10 minutes,Last 4 hours,Last day,Last 7 days</value> value: '0'
</parameter> -
<parameter> name: subject
<name>recipient</name> value: '{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}'
<value>{ALERT.SENDTO}</value> -
</parameter> name: URL
<parameter> value: 'https://myzabbix.example.com/mailGraph.php'
<name>showLegend</name> script: |
<value>0</value> // mailGraph v2.11
</parameter> try {
<parameter> // Pickup parameters
<name>subject</name> params = JSON.parse(value),
<value>{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}</value> req = new HttpRequest(),
</parameter> fields = {},
<parameter> resp = '',
<name>URL</name> result = { tags: {} };
<value>https://myzabbix.com/mailGraph.php</value>
</parameter> // Set HTTP proxy if required
</parameters> if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
<script>// mailGraph v2.20 req.setProxy(params.HTTPProxy);
fields.HTTPProxy = params.HTTPProxy;
// Function to test string }
function isJSON(str) {
try { // Declare output type
JSON.stringify(JSON.parse(str)); req.addHeader('Content-Type: application/json');
return true;
} catch (e) { // Must have fields
return false; fields.itemId = params.itemId * 1;
} fields.eventId = params.eventId * 1;
} fields.recipient = params.recipient;
fields.baseURL = params.baseURL;
try { fields.duration = params.duration * 1;
// Pickup parameters
params = JSON.parse(value), if (isNaN(fields.eventId)) {
req = new HttpRequest(), throw '[MailGraph Webhook] Invalid event ID? Integer required (use actual event ID from Zabbix!)';
fields = {}, }
resp = '',
result = { tags: {} }; if (isNaN(fields.duration)) {
throw '[MailGraph Webhook] Invalid duration? Integer required (set to zero if unknown)!';
// Set HTTP proxy if required }
if (typeof params.HTTPProxy === 'string' &amp;&amp; params.HTTPProxy.trim() !== '') {
req.setProxy(params.HTTPProxy); if (fields.recipient.charAt(0) == '{') {
fields.HTTPProxy = params.HTTPProxy; throw '[MailGraph Webhook] Please define recipient for the test message!';
} }
// Declare output type // Optional fields
req.addHeader('Content-Type: application/json'); if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }
// Pick up fields relevant for mailGraph API level call while parsing/casting fields that should be integer if (typeof params.subject === 'string') { fields.subject = params.subject; }
fields.itemId = params.itemId * 1; if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }
fields.eventId = params.eventId * 1; if (typeof params.periods === 'string') { fields.periods = params.periods; }
fields.recipient = params.recipient; if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }
fields.baseURL = params.baseURL; if (typeof params.debug === 'string') { fields.debug = params.debug; }
fields.duration = params.duration * 1;
// Add generic fields
if (fields.recipient.charAt(0) == '{') { Object.keys(params).forEach(function(key) {
throw '[MailGraph Webhook] Please define recipient for the test message!'; if (key.substring(0, 4) == 'info') {
} fields[key] = params[key];
}
// Optional fields });
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; } // Post information to the processing script
if (typeof params.subject === 'string') { fields.subject = params.subject; } Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; } var resp = req.post(params.URL,JSON.stringify(fields));
if (typeof params.periods === 'string') { fields.periods = params.periods; } Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }
if (typeof params.debug === 'string') { fields.debug = params.debug; } // If blank the email address is likely incorrect
if (resp==null) {
// Add generic fields throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
Object.keys(params).forEach(function(key) { }
if (key.substring(0, 4) == 'info') {
fields[key] = params[key]; // 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;
}
process_tags: 'YES'
description: |
The "URL" must point to the location of the processing script. If a proxy is required, define "HTTPProxy" for the proxy address.
Customization:
- "graphWidth" and "graphWidth" can be defined for the image size
- "showLegend" can be defined to show or hide the legend of the graph
- "subject" can be defined for a customized subject for the mail message
- "periods" and "periods_headers" can be defined for displaying multiple periods of the same graph, or
- "period" and "period_header" can be defined to display a single graph
The html.template and plain.template files can be adjusted (TWIG format).
More details are available at https://github.com/moudsen/mailGraph
message_templates:
-
event_source: TRIGGERS
operation_mode: PROBLEM
subject: 'Problem: {EVENT.NAME}'
message: |
Problem started at {EVENT.TIME} on {EVENT.DATE}
Problem name: {EVENT.NAME}
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]
-
event_source: TRIGGERS
operation_mode: RECOVERY
subject: 'Resolved in {EVENT.DURATION}: {EVENT.RECOVERY.NAME}'
message: |
Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
Problem name: {EVENT.RECOVERY.NAME}
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]
-
event_source: TRIGGERS
operation_mode: UPDATE
subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
message: |
{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
{EVENT.UPDATE.MESSAGE}
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
eventId: {EVENT.ID}
TriggerId: {TRIGGER.ID}
itemId: {ITEM.ID]
// 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);
// 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)
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 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>
<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.
Customization:
- &quot;graphWidth&quot; and &quot;graphWidth&quot; can be defined for the image size
- &quot;showLegend&quot; can be defined to show or hide the legend of the graph
- &quot;subject&quot; can be defined for a customized subject for the mail message
- &quot;periods&quot; and &quot;periods_headers&quot; can be defined for displaying multiple periods of the same graph, or
- &quot;period&quot; and &quot;period_header&quot; can be defined to display a single graph
The html.template and plain.template files can be adjusted (TWIG format).
More details are available at https://github.com/moudsen/mailGraph</description>
<message_templates>
<message_template>
<event_source>TRIGGERS</event_source>
<operation_mode>PROBLEM</operation_mode>
<subject>Problem: {EVENT.NAME}</subject>
<message>Problem started at {EVENT.TIME} on {EVENT.DATE}
Problem name: {EVENT.NAME}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Operational data: {EVENT.OPDATA}
Original problem ID: {EVENT.ID}
Trigger ID (/url): {TRIGGER.ID} {TRIGGER.URL}</message>
</message_template>
<message_template>
<event_source>TRIGGERS</event_source>
<operation_mode>RECOVERY</operation_mode>
<subject>Resolved in {EVENT.DURATION}: {EVENT.RECOVERY.NAME}</subject>
<message>Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
Problem name: {EVENT.RECOVERY.NAME}
Problem duration: {EVENT.DURATION}
Host: {HOST.NAME}
Severity: {EVENT.SEVERITY}
Original problem ID: {EVENT.ID}
Trigger ID: {TRIGGER.ID} {TRIGGER.URL}</message>
</message_template>
<message_template>
<event_source>TRIGGERS</event_source>
<operation_mode>UPDATE</operation_mode>
<subject>Updated problem in {EVENT.AGE}: {EVENT.NAME}</subject>
<message>{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
{EVENT.UPDATE.MESSAGE}
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
Event ID: {EVENT.ID}
Trigger ID: {TRIGGER.ID}</message>
</message_template>
</message_templates>
</media_type>
</media_types>
</zabbix_export>

View File

@ -81,9 +81,6 @@
.content { .content {
font-size: 14px; font-size: 14px;
} }
.acknowledge {
font-size: 10px;
}
</style> </style>
</head> </head>
<body> <body>
@ -101,7 +98,7 @@
({{ HOST_ERROR }}) ({{ HOST_ERROR }})
{% endif %} {% endif %}
<br/> <br/>
{% if EVENT_OPDATA|length > 0 %} {% if EVENT_OPDATE|length > 0 %}
Operational data: <b>{{ EVENT_OPDATA }}</b><br/> Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
{% endif %} {% endif %}
Status: <b>{{ EVENT_STATUS }}</b><br/> Status: <b>{{ EVENT_STATUS }}</b><br/>
@ -115,18 +112,6 @@
</td> </td>
</tr> </tr>
</table> </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> </td>
</tr> </tr>
<tr> <tr>
@ -135,12 +120,10 @@
Event ID: <a href="{{ EVENTDETAILS_URL }}">{{ EVENT_ID }}</a> // Event ID: <a href="{{ EVENTDETAILS_URL }}">{{ EVENT_ID }}</a> //
Trigger ID: <a href="{{ TRIGGER_URL }}">{{ TRIGGER_ID }}</a> // Trigger ID: <a href="{{ TRIGGER_URL }}">{{ TRIGGER_ID }}</a> //
Item ID: <a href="{{ ITEM_URL }}">{{ ITEM_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 %} {% if GRAPH_ZABBIXLINK|length > 0 %}
// Graph ID: <a href="{{ GRAPH_ZABBIXLINK }}">{{ GRAPH_ID }}</a> // Graph ID: <a href="{{ GRAPH_ZABBIXLINK }}">{{ GRAPH_ID }}</a>
{% endif %} {% endif %}
// <a href="{{ ACK_URL }}">Ack</a>
</div> </div>
</td> </td>
</tr> </tr>
@ -206,4 +189,4 @@
{% endif %} {% endif %}
</table> </table>
</body> </body>
</html> </html>