mirror of
https://github.com/moudsen/mailGraph
synced 2025-06-07 19:24:26 +02:00
Compare commits
No commits in common. "main" and "v1.22" have entirely different histories.
65
README.md
65
README.md
@ -1,62 +1,7 @@
|
||||
## Introduction ##
|
||||
Over the years I've been using Zabbix as both personal and business solution for monitoring. One of the missing features in Zabbix itself was the ability to have graphs generated and associated to monitoring messages as well as an easy way to jump back into Zabbix when searching for monitoring information for specific events, problems or to have a direct link to the associated Zabbix item or host.
|
||||
## mailGraph (v1.22)
|
||||
Zabbix Media module and scripts for sending e-mail alerts with graphs.
|
||||
|
||||
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.
|
||||
**Please use the Wiki for information on how to install, configure and use MailGraph in Zabbix.**
|
||||
|
||||
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:
|
||||
|
||||
|
||||
|
||||
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).
|
||||
|
||||
More information can be found in the Wiki.
|
||||
|
||||
## Installation ##
|
||||
Please refer to the Wiki how to get mailGraph installed and configured on your system.
|
||||
|
||||
## 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
|
||||
|
||||
## Announcements ##
|
||||
_(2025/02/04)_
|
||||
|
||||
Started on coding and testing mailGraph v3.
|
||||
|
||||
_(2025/01/26)_
|
||||
|
||||
mailGraph v2.20 now supporting Zabbix 7.0 (LTS) and Zabbix 7.2 (in particular the new API bearer token authentication method).
|
||||
|
||||
_(2024/12/01)_
|
||||
|
||||
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.
|
||||
|
||||
_(2023/11/01)_
|
||||
|
||||
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.
|
||||
|
||||
Principal bug fixing on mailGraph v2.x (logic failure or similar) will continue but only for Zabbix 6.x onwards.
|
||||
|
||||
## Ideas and improvements ##
|
||||
|
||||
I'm open to new feature requests - please raise an issue for this in this Github space.
|
||||
|
||||
[#50 - Docker support](https://github.com/moudsen/mailGraph/issues/50) - Docker support inserted shortly after testing; will be pushed into release 3 shortly.
|
||||
_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.
|
||||
## Example message
|
||||
[](images/Example-mail-message-v122.png)
|
||||
|
||||
@ -1,32 +1,28 @@
|
||||
{
|
||||
"script_baseurl": "https:\/\/mydomain.com\/",
|
||||
"script_baseurl": "https:\/\/domain.com\/",
|
||||
"cli_itemId": 0,
|
||||
"cli_triggerId": 0,
|
||||
"cli_eventId": 0,
|
||||
"cli_eventValue": 0,
|
||||
"cli_duration": 0,
|
||||
"cli_recipient": "recipient@mydomain.com",
|
||||
"cli_recipient": "recipient@domain.com",
|
||||
"cli_subject": "[TEST] {{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
|
||||
"cli_baseURL": "https:\/\/mydomain.com\/zabbix\/",
|
||||
"cli_baseURL": "https:\/\/domain.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_user": "alogicalusername",
|
||||
"zabbix_api_pwd": "astrongpassword",
|
||||
"mail_from": "sender@domain.com",
|
||||
"subject": "{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
|
||||
"smtp_server": "localhost",
|
||||
"smtp_port": 25,
|
||||
"smtp_security": "none",
|
||||
"smtp_transport": "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
|
||||
}
|
||||
|
||||
@ -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
|
||||
}
|
||||
@ -1,29 +1,27 @@
|
||||
{
|
||||
"script_baseurl": "https:\/\/mydomain.com\/",
|
||||
"script_baseurl": "https:\/\/domain.com\/",
|
||||
"cli_itemId": 0,
|
||||
"cli_triggerId": 0,
|
||||
"cli_eventId": 0,
|
||||
"cli_eventValue": 0,
|
||||
"cli_duration": 0,
|
||||
"cli_recipient": "recipient@mydomain.com",
|
||||
"cli_recipient": "recipient@domain.com",
|
||||
"cli_subject": "[TEST] {{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
|
||||
"cli_baseURL": "https:\/\/mydomain.com\/zabbix\/",
|
||||
"cli_baseURL": "https:\/\/domain.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@domain.com",
|
||||
"subject": "{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
|
||||
"smtp_server": "localhost",
|
||||
"smtp_port": 25,
|
||||
"smtp_security": "none",
|
||||
"smtp_transport": "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
|
||||
|
||||
@ -27,7 +27,7 @@
|
||||
$content = file_get_contents($argv[1]);
|
||||
$data = json_decode($content,TRUE);
|
||||
|
||||
if (($data==NULL) && (sizeof($content)>2))
|
||||
if ($data==NULL)
|
||||
{
|
||||
echo 'Invalid JSON format in config file?!'.$cCRLF;
|
||||
die;
|
||||
|
||||
@ -1 +0,0 @@
|
||||
RESTART_POLICY=unless-stopped
|
||||
@ -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"]
|
||||
@ -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)
|
||||
@ -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>
|
||||
@ -1,2 +0,0 @@
|
||||
#!/bin/bash
|
||||
docker build -t hoppa66/zabbix-mailgraph .
|
||||
@ -1,3 +0,0 @@
|
||||
#!/bin/bash
|
||||
cd /var/www/site/public
|
||||
php mailGraph.php cleanup
|
||||
@ -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
|
||||
@ -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: 85 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 115 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
@ -1 +0,0 @@
|
||||
Issue #32 has been resolved. The javascript code now works for Zabbix 5.4, 6.0 LTS and 6.4.
|
||||
@ -1,42 +1,25 @@
|
||||
// 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),
|
||||
req = new HttpRequest(),
|
||||
req = new CurlHttpRequest(),
|
||||
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;
|
||||
}
|
||||
if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') { req.setProxy(params.HTTPProxy); }
|
||||
|
||||
// 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
|
||||
fields.itemId = params.itemId * 1;
|
||||
fields.eventId = params.eventId * 1;
|
||||
// Must have fields
|
||||
fields.itemId = params.itemId;
|
||||
fields.triggerId = params.triggerId;
|
||||
fields.eventId = params.eventId;
|
||||
fields.eventValue = params.eventValue;
|
||||
fields.recipient = params.recipient;
|
||||
fields.baseURL = params.baseURL;
|
||||
fields.duration = params.duration * 1;
|
||||
|
||||
if (fields.recipient.charAt(0) == '{') {
|
||||
throw '[MailGraph Webhook] Please define recipient for the test message!';
|
||||
}
|
||||
fields.duration = params.duration;
|
||||
|
||||
// Optional fields
|
||||
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
|
||||
@ -56,44 +39,22 @@ try {
|
||||
|
||||
// Post information to the processing script
|
||||
Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
|
||||
var resp = req.post(params.URL,JSON.stringify(fields));
|
||||
Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
|
||||
var resp = req.Post(params.URL,JSON.stringify(fields));
|
||||
Zabbix.Log(4, '[Mailgraph Webhook] Receiving 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 there was an error, report it
|
||||
if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }
|
||||
|
||||
if (req.getStatus() != 200) {
|
||||
throw '[MailGraph Webhook] Processing of mailGraph.php failed: ' + resp;
|
||||
}
|
||||
if (resp==null) {
|
||||
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
|
||||
}
|
||||
|
||||
if (resp=='') {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
|
||||
}
|
||||
|
||||
// Check if JSON was returned
|
||||
if (!isJSON(resp)) {
|
||||
throw '[MailGraph Webhook] An error has occurred during processing: ' + resp;
|
||||
}
|
||||
|
||||
// We expect the message id back from the processing script response in JSON format
|
||||
msg = JSON.parse(resp);
|
||||
|
||||
result.tags.__message_id = msg.messageId;
|
||||
Zabbix.Log(4, '[MailGraph Webhook] Message sent with identification "' + msg.messageId + '"');
|
||||
// We expect the message id back from the processing script
|
||||
resp = JSON.parse(resp);
|
||||
result.tags.__message_id = resp.messageId;
|
||||
|
||||
// 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
|
||||
// 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;
|
||||
}
|
||||
1185
mailGraph.php
1185
mailGraph.php
File diff suppressed because it is too large
Load Diff
250
mailGraph.xml
250
mailGraph.xml
@ -1,7 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<zabbix_export>
|
||||
<version>5.4</version>
|
||||
<date>2023-08-16T20:38:38Z</date>
|
||||
<version>5.0</version>
|
||||
<date>2021-03-10T18:50:24Z</date>
|
||||
<media_types>
|
||||
<media_type>
|
||||
<name>MailGraph</name>
|
||||
@ -9,7 +9,7 @@
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>baseURL</name>
|
||||
<value>https://myzabbix.com/zabbix/</value>
|
||||
<value>https://mydomain.com/zabbix/</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>duration</name>
|
||||
@ -19,6 +19,10 @@
|
||||
<name>eventId</name>
|
||||
<value>{EVENT.ID}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>eventValue</name>
|
||||
<value>{EVENT.VALUE}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>graphHeight</name>
|
||||
<value>120</value>
|
||||
@ -32,8 +36,8 @@
|
||||
<value/>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>infoTest</name>
|
||||
<value>Test</value>
|
||||
<name>itemId</name>
|
||||
<value>{ITEM.ID}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>periods</name>
|
||||
@ -55,159 +59,131 @@
|
||||
<name>subject</name>
|
||||
<value>{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>triggerId</name>
|
||||
<value>{TRIGGER.ID}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>URL</name>
|
||||
<value>https://myzabbix.com/mailGraph.php</value>
|
||||
<value>https://mydomain.com/mailGraph.php</value>
|
||||
</parameter>
|
||||
</parameters>
|
||||
<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),
|
||||
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');
|
||||
|
||||
// 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 (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);
|
||||
|
||||
// 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 "' + msg.messageId + '"');
|
||||
|
||||
// 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>try {
|
||||
// Pickup parameters
|
||||
params = JSON.parse(value),
|
||||
req = new CurlHttpRequest(),
|
||||
fields = {},
|
||||
resp = '',
|
||||
result = { tags: {} };
|
||||
|
||||
// Set HTTP proxy if required
|
||||
if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') { req.setProxy(params.HTTPProxy); }
|
||||
|
||||
// Declare output type
|
||||
req.AddHeader('Content-Type: application/json');
|
||||
|
||||
// Must have fields
|
||||
fields.itemId = params.itemId;
|
||||
fields.triggerId = params.triggerId;
|
||||
fields.eventId = params.eventId;
|
||||
fields.eventValue = params.eventValue;
|
||||
fields.recipient = params.recipient;
|
||||
fields.baseURL = params.baseURL;
|
||||
fields.duration = params.duration;
|
||||
|
||||
// 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] Receiving response:' + resp);
|
||||
|
||||
// If there was an error, report it
|
||||
if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }
|
||||
|
||||
// We expect the message id back from the processing script
|
||||
resp = JSON.parse(resp);
|
||||
result.tags.__message_id = resp.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;
|
||||
}</script>
|
||||
<process_tags>YES</process_tags>
|
||||
<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).
|
||||
|
||||
<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
|
||||
|
||||
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>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]</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>
|
||||
<subject>Resolved in {EVENT.DURATION}: {EVENT.NAME}</subject>
|
||||
<message>Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
|
||||
Problem name: {EVENT.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]</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>{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]</message>
|
||||
</message_template>
|
||||
</message_templates>
|
||||
</media_type>
|
||||
|
||||
@ -81,9 +81,6 @@
|
||||
.content {
|
||||
font-size: 14px;
|
||||
}
|
||||
.acknowledge {
|
||||
font-size: 10px;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
@ -101,7 +98,7 @@
|
||||
({{ HOST_ERROR }})
|
||||
{% endif %}
|
||||
<br/>
|
||||
{% if EVENT_OPDATA|length > 0 %}
|
||||
{% if EVENT_OPDATE|length > 0 %}
|
||||
Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
|
||||
{% endif %}
|
||||
Status: <b>{{ EVENT_STATUS }}</b><br/>
|
||||
@ -115,95 +112,64 @@
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{% if ACKNOWLEDGES|length > 0 %}
|
||||
<br/>
|
||||
{% for anAck in ACKNOWLEDGES %}
|
||||
<table style="border:0; text-align:left;" cellpadding="5" cellspacing="0">
|
||||
</td>
|
||||
</tr>
|
||||
{% if GRAPH_CID1|length > 0 %}
|
||||
<tr>
|
||||
<td class="acknowledge">
|
||||
<b>{{ anAck._clock }}</b><br/><em>({{ anAck.username }}, {{ anAck.name }} {{ anAck.surname }})</em><br/>[{{ anAck._actions }}]<br/>{{ anAck.message }}
|
||||
<div align=justify>
|
||||
<td align="center">
|
||||
<span class="graphHeader">{{ GRAPH_HEADER1 }}</span><br/>
|
||||
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ GRAPH_CID1 }}" />
|
||||
</td>
|
||||
</div>
|
||||
</tr>
|
||||
</table>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
{% if GRAPH_CID2|length > 0 %}
|
||||
<tr>
|
||||
<div align=justify>
|
||||
<td align="center">
|
||||
<hr/>
|
||||
<span class="graphHeader">{{ GRAPH_HEADER2 }}</span><br/>
|
||||
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ GRAPH_CID2 }}" />
|
||||
</td>
|
||||
</div>
|
||||
</tr>
|
||||
{% endif %}
|
||||
{% if GRAPH_CID3|length > 0 %}
|
||||
<tr>
|
||||
<div align=justify>
|
||||
<td align="center">
|
||||
<hr/>
|
||||
<span class="graphHeader">{{ GRAPH_HEADER3 }}</span><br/>
|
||||
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ GRAPH_CID3 }}" />
|
||||
</td>
|
||||
</div>
|
||||
</tr>
|
||||
{% endif %}
|
||||
{% if GRAPH_CID4|length > 0 %}
|
||||
<tr>
|
||||
<div align=justify>
|
||||
<td align="center">
|
||||
<hr/>
|
||||
<span class="graphHeader">{{ GRAPH_HEADER4 }}</span><br/>
|
||||
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ GRAPH_CID4 }}" />
|
||||
</td>
|
||||
</div>
|
||||
</tr>
|
||||
{% endif %}
|
||||
<tr>
|
||||
<td class="links">
|
||||
<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> //
|
||||
<a href="{{ HOST_PROBLEMS_URL }}">Problems</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 %}
|
||||
// <a href="{{ ACK_URL }}">Ack</a>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
{% for aGraph in GRAPHS_I %}
|
||||
<tr>
|
||||
<div align=justify>
|
||||
<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>
|
||||
Loading…
x
Reference in New Issue
Block a user