Compare commits

...

54 Commits

Author SHA1 Message Date
moudsen
01fafd98c5
Update README.md - Adding Docker support for mailGraph 2025-05-05 23:22:03 +02:00
Mark Oudsen
fbcc359f05 v0.9.1 - Initial public beta release for testing purposes 2025-05-05 19:07:24 +02:00
Mark Oudsen
12c9f1e331 v0.9.1 - Initial public beta release for testing purposes 2025-05-05 19:00:32 +02:00
Mark Oudsen
2a599cb777 v0.9.1 - Initial public beta release for testing purposes 2025-05-05 19:00:23 +02:00
Mark Oudsen
e40342cd94 v2.22 - Fixed #60 incorrect JSON request while reading latest problems 2025-03-19 11:09:16 +01:00
Mark Oudsen
36fd2b1d23 v2.21 - Added #57 enhancement for manipulation of data value truncing 2025-02-20 14:09:47 +01:00
Mark Oudsen
2a39f94718 v2.21 - Added #57 enhancement for manipulation of data value truncing 2025-02-20 13:51:28 +01:00
moudsen
3d6ec8e735
Bug (#56) fixed - typo in variable (EVENT_OPDATA, not EVENT_OPDATE) 2025-02-20 11:05:38 +01:00
moudsen
bfd5a1670c
v2.20 - Release 3 announcements 2025-02-04 11:42:07 +01:00
Mark Oudsen
ac1a6c49a7 v2.20 - Matching mailGraph version 2025-02-03 01:02:53 +01:00
Mark Oudsen
6e06c5b0cc Merge branch 'main' of github.com:moudsen/mailGraph 2025-02-03 01:01:29 +01:00
Mark Oudsen
cdccef3d4d v2.20 - Added config.json example for API token method 2025-02-03 01:01:14 +01:00
moudsen
b874e38c30
mailGraph logo v1 2025-01-30 16:08:38 +01:00
Mark Oudsen
1de203d79f v2.20 - Modified and tested for Zabbix 7.0 (LTS) and Zabbix 7.2 2025-01-26 23:34:27 +01:00
Mark Oudsen
a8c8e13a98 v2.20 - Modified and tested for Zabbix 7.0 (LTS) and Zabbix 7.2 2025-01-26 23:04:47 +01:00
moudsen
fc13414ff2
v2.18 - Version adjustment only to match the mailGraph.php version
I've forgotten to update the xml to the same version as mailGraph.php :-(. Fixed with this very minor change.
2025-01-25 22:16:23 +01:00
moudsen
0cbd766208
v2.18 - README update
Added link to site of Bernard Linz (German) to extensive installation instructions from zero to a working environment with mailGraph
2025-01-25 22:02:57 +01:00
moudsen
2e869f1999
v2.18 - README update 2025-01-14 12:08:22 +01:00
Mark Oudsen
2f11d76c76 v2.18 - Fixed #51 SMTPS (implicit) or STARTTLS (explicit) 2025-01-14 12:05:13 +01:00
Mark Oudsen
88862f69eb v2.18 - Fixed #51 SMTPS (implicit) or STARTTLS (explicit) 2025-01-14 11:57:23 +01:00
Mark Oudsen
b31f686e24 v2.17 - Several bugfixes - PHP8 confirmed testing - Preparations for release 3 2024-12-30 11:43:48 +01:00
Mark Oudsen
bf7927a0c3 v2.17 - Several bugfixes - PHP8 confirmed testing - Preparations for release 3 2024-12-30 11:26:28 +01:00
moudsen
b43611588a
Merge pull request #44 from WMP/patch-1
Fix config.json.template
2024-12-30 09:18:24 +01:00
WMP
b1f635ab36
Fix config.json.template 2024-06-20 14:56:05 +02:00
Mark Oudsen
dce6f57876 mailGraph v3.x announcement and Zabbix 5 and older maintenance stop 2023-11-02 12:24:24 +01:00
moudsen
74e8a79e4c
mailGraph v3.x accouncement and Zabbix 5 and older maintenance stop 2023-11-02 12:15:09 +01:00
Mark Oudsen
ba3e860fe0 mailGraph v3.x announcement and Zabbix 5 and older maintenance stop 2023-11-02 12:14:01 +01:00
moudsen
2045601eca
v2.16 updates 2023-08-18 11:13:24 +02:00
moudsen
5f49628b8a
Refreshed example image 2023-08-18 11:10:26 +02:00
moudsen
a069dfa99d
Refreshed example output 2023-08-18 11:07:07 +02:00
moudsen
2c2561149a
Refreshed example picture 2023-08-18 11:04:21 +02:00
moudsen
0847513eae
Refreshed example output 2023-08-18 11:02:21 +02:00
root
62a3ee6149 v2.16 - Added auto-creation of IMAGES directory if not present 2023-08-17 06:39:34 -04:00
root
a7196f8bc5 v2.16 - Fixed code type for detection of ACKNOWLEDGES information from event.get 2023-08-17 06:34:36 -04:00
Mark Oudsen
ededded428 v2.16 - Adding ACKNOWLEDGES message information 2023-08-16 22:50:00 +02:00
Mark Oudsen
624ce29a39 v2.15 - Fixed issues found in Zabbix 5.4.12 and refactored Javascript for better error handling 2023-08-16 14:18:08 +02:00
moudsen
16729e0720
v2.14 - Added special thank you section 2023-07-15 15:12:24 +02:00
Mark Oudsen
97dba8f197 v2.14 - Fixed missing flag for fetching web url related items 2023-07-15 00:51:55 +02:00
Mark Oudsen
288b0adaf7 v2.14 - Adding ability to set 'From' and 'Reply-to' address details in configuration - logic refactor on itemId (obsolete) 2023-07-10 23:59:33 +02:00
Mark Oudsen
2859d427f7 v2.14 - Adding ACK_URL for direct jump to Acknowledge edit windows of Zabbix 2023-07-10 14:34:55 +02:00
Mark Oudsen
0cd169a9d2 v2.14 - Adding ability to set 'From' and 'Reply-to' address details in configuration 2023-07-10 14:32:47 +02:00
Mark Oudsen
8269195795 v2.14 - Adding ability to set 'From' address details in configuration 2023-07-10 11:21:48 +02:00
moudsen
6da6da77fb
v2.14 - Configuration updates
itemId no longer required/possibel per Zabbix 6.2. T
new items for SMTP from
keeping "mail_from" for backwards compatibility.
2023-07-10 11:02:20 +02:00
Mark Oudsen
00a67cbb65 v2.14 - Adding ability to set 'From' address details in configuration 2023-07-10 10:14:52 +02:00
Mark Oudsen
bf970029ea Merge branch 'main' of github.com:moudsen/mailGraph 2023-07-10 10:09:53 +02:00
Mark Oudsen
9f3bfb5c69 v2.14 - Adding ability to set 'From' address in configuration 2023-07-10 10:09:39 +02:00
moudsen
504422f452
v2.13 updates 2023-07-06 01:22:40 +02:00
Mark Oudsen
3ef16ae597 v2.13 - Bugfixes speciifally on links into Zabbix (missing context or info) 2023-07-03 21:54:27 +02:00
Mark Oudsen
a597ce6ab3 v2.13 - Bugfixes speciifally on links into Zabbix (missing context or info) 2023-07-03 21:50:14 +02:00
moudsen
a04050c3bc
v2.12 updates 2023-07-02 15:00:47 +02:00
Mark Oudsen
b81414e06d v2.12 - Replaced SwiftMailer with PHPMailer (based on AutoTLS) 2023-07-02 14:54:00 +02:00
moudsen
accb8f40d6
v2.11.1 updates 2023-07-02 14:09:00 +02:00
moudsen
bf5bbcb778
v2.11.1 updates 2023-07-02 14:07:37 +02:00
moudsen
702725e5f7
v2.11.1 updates 2023-07-02 14:06:59 +02:00
18 changed files with 882 additions and 386 deletions

View File

@ -4,10 +4,13 @@ Over the years I've been using Zabbix as both personal and business solution for
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.
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. Example: "{ITEM.ID}".
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.
Note that all Zabbix host, item or screen related information is made available to Twig automatically.
Example message:
[![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)
![Example image](https://github.com/moudsen/mailGraph/assets/16045332/0cb671d9-464f-493b-b250-15dd550fd84a)
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).
@ -17,54 +20,43 @@ More information can be found in the Wiki.
## Installation ##
Please refer to the Wiki how to get mailGraph installed and configured on your system.
## mailGraph v2.11 release ##
_(2023/07/01)_
## 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
_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)_
## Announcements ##
_(2025/02/04)_
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)
Started on coding and testing mailGraph v3.
Modified files
- mailGraph.php
- mailGraph.xml
- javascript/zabbix.mailGraph.js
_(2025/01/26)_
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
mailGraph v2.20 now supporting Zabbix 7.0 (LTS) and Zabbix 7.2 (in particular the new API bearer token authentication method).
Changes are in effect immediately, no need to restart any services.
_(2024/12/01)_
## mailGraph v2.10 release ##
_(2023/06/30)_
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.
_This version has been verified with Zabbix 5.4, 6.0 LTS and 6.4, PHP 7.4 and 8.2 and recent versions of libraries used via composer._
_(2023/11/01)_
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
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.4.x testing ##
_(2023/06/30)_
Principal bug fixing on mailGraph v2.x (logic failure or similar) will continue but only for Zabbix 6.x onwards.
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")
## Ideas and improvements ##
Sidenotes
- Zabbix logging still shows deprecation messages however it is believed these are internal to Zabbix and not related to mailGraph
I'm open to new feature requests - please raise an issue for this in this Github space.
_(2023/06/29)_
[#50 - Docker support](https://github.com/moudsen/mailGraph/issues/50) - Docker support inserted shortly after testing; will be pushed into release 3 shortly.
_Please refer to the `docker` directory for the first release of the docker image on Docker Hub (hoppa66/zabbix-mailgraph)_
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.
## 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 and Zabbix versions under 5.4 ##
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.
**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**
## 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,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
}

View File

@ -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
}

View File

@ -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

1
docker/.env Normal file
View File

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

88
docker/Dockerfile Normal file
View File

@ -0,0 +1,88 @@
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"]

44
docker/README.md Normal file
View File

@ -0,0 +1,44 @@
## 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)

18
docker/apache-config.conf Normal file
View File

@ -0,0 +1,18 @@
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>

2
docker/build.sh Executable file
View File

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

3
docker/cleanup.sh Normal file
View File

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

13
docker/docker-compose.yml Normal file
View File

@ -0,0 +1,13 @@
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

3
docker/fetch_mailgraph.sh Executable file
View File

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

BIN
images/mailGraph-small.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@ -1,4 +1,15 @@
// mailGraph v2.11
// 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),
@ -16,21 +27,13 @@ try {
// Declare output type
req.addHeader('Content-Type: application/json');
// Must have fields
// 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 * 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!';
}
@ -56,20 +59,30 @@ try {
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
// 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 data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
}
// 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';
if (resp=='') {
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
}
// We expect the message id back from the processing script
// 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;
@ -80,7 +93,7 @@ try {
}
catch (error)
{
// In case something went wrong in the processing, pass the error back to Zabbix
// 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;
}

File diff suppressed because it is too large Load Diff

View File

@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<zabbix_export>
<version>5.4</version>
<date>2023-07-02T10:34:30Z</date>
<date>2023-08-16T20:38:38Z</date>
<media_types>
<media_type>
<name>MailGraph</name>
@ -9,7 +9,7 @@
<parameters>
<parameter>
<name>baseURL</name>
<value>https://myzabbix.example.com/</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,10 +57,21 @@
</parameter>
<parameter>
<name>URL</name>
<value>https://myzabbix.example.com/mailGraph.php</value>
<value>https://myzabbix.com/mailGraph.php</value>
</parameter>
</parameters>
<script>// mailGraph v2.11
<script>// 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),
@ -82,21 +89,13 @@ try {
// Declare output type
req.addHeader('Content-Type: application/json');
// Must have fields
// 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 * 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!';
}
@ -122,20 +121,30 @@ try {
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
// 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 data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
}
// 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) == &quot;!&quot;) {
throw '[MailGraph Webhook] No data received from mailGraph! Likely the event ID provided does not exist? Check mailGraph logging';
if (resp=='') {
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
}
// We expect the message id back from the processing script
// 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;
@ -146,7 +155,7 @@ try {
}
catch (error)
{
// In case something went wrong in the processing, pass the error back to Zabbix
// 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>
@ -174,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>
@ -190,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>
@ -205,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>

View File

@ -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>