21 Commits
v2.17 ... main

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
17 changed files with 459 additions and 127 deletions

View File

@@ -20,20 +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.
## Announcement - Zabbix 5.x maintenance for mailGraph end-of-life - mailGraph 3.x development in progress ##
## 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.
In conjunction mailGraph v2.x is now frozen and I'm setting up a roadmap for mailGraph v3.x starting new development in Alfa mode as November 2023. This new code is not expected to be published until start of 2024.
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.

View File

@@ -16,13 +16,14 @@
"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",
"smtp_strict": "yes",
"graph_match": "any",
"item_value_truncate": 50,
"period": "20m",
"period_header": "Last 20 minutes",
"retention_images": 7,

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

@@ -16,13 +16,14 @@
"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",
"smtp_strict": "yes",
"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

BIN
images/mailGraph-small.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

View File

@@ -1,4 +1,4 @@
// mailGraph v2.16
// mailGraph v2.20
// Function to test string
function isJSON(str) {

View File

@@ -35,10 +35,18 @@
// Fixed #45 handling of international characters - Dima-online
// Tested with latest PHPMailer (6.9.3) and TWIG (3.11.3), PHP 7.4
// Tested with PHP 8.3, TWIG (3.18.0)
// 2.18 2025/01/10 - Mark Oudsen - SCREEN tag information is only processed for Zabbix versions <= 5
// 2025/01/14 - Mark Oudsen - Fixed #51 SMTPS (implicit) or STARTTLS (explicit)
// 2.20 2025/01/25 - Mark Oudsen - Fixed #49 to support Zabbix API bearer token (Zabbix 7.x+)
// Added detection of php curl module (must have)
// Fixed bug on array size determination
// CURLOPT_BINARYTRANSFER deprecated (removed)
// ------------------------------------------------------------------------------------------------------
// Release 3 placeholder for Zabbix 7.0 LTS and 7.2
// Release 3 placeholder for Zabbix 7.0 LTS and 7.2+
// ------------------------------------------------------------------------------------------------------
// v2.17 Testing on Zabbix 7.0 LTS (in progress), Zabbix 7.2 (in progress)
// 2.20 Tested in Zabbix 7.0.7 LTS and Zabbix 7.2.2
// 2.21 2025/02/20 - Mark Oudsen - Added #57 enhancement for manipulation of data value truncing
// 2.22 2025/03/19 - Mark Oudsen - Fixed #60 incorrect JSON request (boolean as text instead of bool)
// ------------------------------------------------------------------------------------------------------
//
// (C) M.J.Oudsen, mark.oudsen@puzzl.nl
@@ -52,16 +60,27 @@
//
// Notes
// -----
// 1) mailGraph is following the environmental requirements from Zabbix, supporting PHP 7.4-8.3 ad per
// 1) mailGraph is following the environmental requirements from Zabbix, supporting PHP 7 and 8 as per
// - https://www.zabbix.com/documentation/6.0/en/manual/installation/requirements
// - https://www.zabbix.com/documentation/6.4/en/manual/installation/requirements
// - https://www.zabbix.com/documentation/7.0/en/manual/installation/requirements
// - https://www.zabbix.com/documentation/7.2/en/manual/installation/requirements
//
// 2) TWIG 3.18.0 is available on PHP 8 only (seemless upgrade when using composer update)
// 2) TWIG 3.18.0 is available on PHP 8 only
// - Seemless in-place upgrade when using composer update after upgrading PHP 7.x to PHP 8.x
//
// 3) Testing of composer libraries updates is limited to every 6 to 12 months
// 3) Full testing of composer libraries updates/versions is limited to every 6 to 12 months
// - In case you encounter an issue, please raise an issue on GitHub
// https://github.com/moudsen/mailGraph/issues
//
// - Refer to the wiki for exact versions tested
//
// 4) PHP related notes
// - PHP 5.4 - Limited to mailGraph v1.xx only - unsupported (end of life) - Tested - No more updates
// - PHP 7.x - Limited to mailGraph v2.xx only - unsupported (end of life) - Tested - Freezing
// - PHP 8.x - Supported - Tested
//
// 5) Zabbix related
// - As from Zabbix 7.2 onwards the only authentication method accepted is API bearer token
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -73,7 +92,7 @@
// -------
// - Automatic setup and configuration of mailGraph
// - Automatic code updates (CLI triggered)
// - Add DASHBOARD facility (SCREEN was abandoned in Zabbix 5.4
// - Add DASHBOARD processing facility (SCREEN was abandoned after Zabbix 5.4) [idea only]
// - Extract Graph API functionality to seperate code unit/object
//
/////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -92,7 +111,7 @@
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// CONSTANTS
$cVersion = 'v2.17';
$cVersion = 'v2.22';
$cCRLF = chr(10).chr(13);
$maskDateTime = 'Y-m-d H:i:s';
$maxGraphs = 8;
@@ -122,7 +141,7 @@
/////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// Fetch the HTML source of the given URL
// Fetch the response of the given URL
// --- Redirects will be honored
// --- Enforces use of IPv4
// --- Caller must verify if the return string is JSON or ERROR
@@ -133,6 +152,7 @@
global $cVersion;
global $cDebug;
global $HTTPProxy;
global $z_api_token;
// Initialize Curl instance
_log('% postJSON: '.$url);
@@ -141,7 +161,6 @@
$ch = curl_init();
// Set options
if ((isset($HTTPProxy)) && ($HTTPProxy!=''))
{
if ($cDebug) { _log('% Using proxy: '.$HTTPProxy); }
@@ -151,18 +170,41 @@
curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 20);
// Set headers
$headers = ['Content-Type:application/json'];
// Bypass token authentication method if we are using API token method
if ($z_api_token != '') {
if ($data['method']!='apiinfo.version') {
$headers[] = 'Authorization: Bearer '.$z_api_token;
if ($cDebug) { _log('> Adding API bearer token'); }
}
if (isset($data['auth'])) {
unset($data['auth']);
if ($cDebug) { _log('> Cleared AUTH information'); }
}
}
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
// Set POST
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
// Set URL and output-to-variable option
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
// Set Agent name
curl_setopt($ch, CURLOPT_USERAGENT, 'Zabbix-mailGraph - '.$cVersion);
// Execute Curl
$data = curl_exec($ch);
// Check if we have valid data
if ($data===FALSE)
{
_log('! Failed: '.curl_error($ch));
@@ -199,6 +241,7 @@
global $z_tmp_cookies;
global $z_images_path;
global $z_url_api;
global $z_api_token;
global $cVersion;
global $cCRLF;
global $HTTPProxy;
@@ -235,9 +278,6 @@
"&graphtype=".$graphType."&legend=".$showLegend."&profileIdx=web.graphs.filter".
"&from=now-".$period."&to=now";
// Prepare POST login
$z_login_data = array('name' => $z_user, 'password' => $z_pass, 'enter' => "Sign in");
// Cookie and image names
$filename_cookie = $z_tmp_cookies ."zabbix_cookie_" .$graphid . "." .$thisTime. ".txt";
$filename = "zabbix_graph_" .$graphid . "." . $thisTime . "-" . $period . ".png";
@@ -258,9 +298,9 @@
}
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$z_login_data = array('name' => $z_user, 'password' => $z_pass, 'enter' => "Sign in");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $z_login_data);
@@ -272,8 +312,9 @@
if ($login!='')
{
//TODO: Pick up the specific error from CURL?
echo 'Error logging in to Zabbix!'.$cCRLF;
die;
return('');
}
// Get the graph
@@ -378,50 +419,27 @@
/////////////////////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// Check the array for information we do not want to share in any logging
// Check the array if it contains information that should not be logged
function maskOutputFields($info)
function maskKey(&$theValue, $theKey)
{
foreach($info as $aKey=>$aValue)
switch($theKey)
{
switch($aKey)
{
case 'zabbix_user':
case 'zabbix_user_pwd':
case 'zabbix_api_user':
case 'zabbix_api_pwd':
$info[$aKey] = '<masked>';
break;
case 'zabbix_user':
case 'zabbix_user_pwd':
case 'zabbix_api_user':
case 'zabbix_api_pwd':
case 'zabbix_api_token':
case 'username':
case 'password':
$theValue = '<masked>';
break;
}
}
return($info);
}
// Check the array if it contains information that should not be logged
function maskOutputContent($info)
{
global $config;
foreach($info as $infoKey=>$infoValue)
{
if (is_array($infoValue)) { $info[$infoKey] = maskOutputContent($infoValue); }
foreach($config as $aKey=>$aValue)
{
switch($aKey)
{
case 'zabbix_user':
case 'zabbix_user_pwd':
case 'zabbix_api_user':
case 'zabbix_api_pwd':
if ($aValue==$infoValue) { $info[$infoKey] = '<masked>'; };
break;
}
}
}
array_walk_recursive($info,'maskKey');
return($info);
}
@@ -501,13 +519,19 @@
// Initialize ///////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// --- CHECK CURL
if (!extension_loaded('curl')) {
_log('! mailGraph requires the php-curl module to function properly. Please install this module and retry.');
die;
}
// --- CONFIG DATA ---
// [CONFIGURE] Change only when you want to place your config file somewhere else ...
$config = readConfig(getcwd().'/config/config.json');
_log('# Configuration taken from config.json'.$cCRLF.
json_encode(maskOutputFields($config),JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
json_encode(maskOutputContent($config),JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
// --- MAIL DATA ---
@@ -640,6 +664,10 @@
$p_smtp_strict = 'yes';
if ((isset($config['smtp_strict'])) && ($config['smtp_strict']=='no')) { $p_smtp_strict = 'no'; }
$p_smtp_security = 'none';
if ((isset($config['smtp_security'])) && ($config['smtp_security']=='smtps')) { $p_smtp_security = 'smtps'; }
if ((isset($config['smtp_security'])) && ($config['smtp_security']=='starttls')) { $p_smtp_security = 'starttls'; }
$p_smtp_username = '';
if (isset($config['smtp_username'])) { $p_smtp_username = $config['smtp_username']; }
@@ -670,6 +698,9 @@
$p_graph_match = 'any';
if ((isset($config['graph_match'])) && ($config['graph_match']=='exact')) { $p_graph_match = 'exact'; }
$p_item_value_truncate = 0;
if (isset($config['item_value_truncate'])) { $p_item_value_truncate = intval($config['item_value_truncate']); }
// --- GLOBAL CONFIGURATION ---
// Script related settings
@@ -702,6 +733,13 @@
_log('+ created IMAGES directory "'.$z_images_path.'"');
}
// Zabbix token - if a token is defined this will be the selected login method automatically (username/password neglected)
$z_api_token = '';
if (isset($config['zabbix_api_token'])) {
$z_api_token = $config['zabbix_api_token'];
}
// Zabbix user (requires Super Admin access rights to access image generator script)
$z_user = $config['zabbix_user'];
$z_pass = $config['zabbix_user_pwd'];
@@ -747,30 +785,39 @@
// --- LOGIN ---
// -------------
_log('# LOGIN to Zabbix');
// We only use the USER.LOGIN method if not using the API bearer token method
if ($z_api_token=='') {
_log('# LOGIN to Zabbix');
$request = array('jsonrpc'=>'2.0',
'method'=>'user.login',
'params'=>array('username'=>$z_api_user,
'password'=>$z_api_pass),
'id'=>nextRequestID(),
'auth'=>null);
$request = array('jsonrpc'=>'2.0',
'method'=>'user.login',
'params'=>array('username'=>$z_api_user,
'password'=>$z_api_pass),
'id'=>nextRequestID(),
'auth'=>null);
$result = postJSON($z_url_api,$request);
$result = postJSON($z_url_api,$request);
$token = '';
if (isset($result['result'])) { $token = $result['result']; }
$token = '';
if (isset($result['result'])) { $token = $result['result']; }
if ($token=='')
{
echo 'Error logging in to Zabbix? ('.$z_url_api.'): '.$cCRLF;
echo var_dump($request).$cCRLF;
echo var_dump($result).$cCRLF;
die;
if ($token=='')
{
echo 'Error logging in to Zabbix? ('.$z_url_api.'): '.$cCRLF;
echo var_dump($request).$cCRLF;
echo var_dump($result).$cCRLF;
die;
}
_log('> Token = '.$token);
} else {
if ($cDebug) {
_log('# Using API bearer token authentication to access Zabbix');
}
$token = '';
}
_log('> Token = '.$token);
// -----------------------
// --- LOG API VERSION ---
// -----------------------
@@ -785,6 +832,7 @@
$result = postJSON($z_url_api, $request);
$apiVersion = $result['result'];
$apiVersionMajor = substr($apiVersion,0,01);
_log('> API version '.$apiVersion);
@@ -799,11 +847,15 @@
$request = array('jsonrpc'=>'2.0',
'method'=>'problem.get',
'params'=>array('output'=>'extend',
'recent'=>'true',
'recent'=>TRUE,
'limit'=>1),
'auth'=>$token,
'id'=>nextRequestID());
if ($z_api_token=='') {
$request['auth'] = $token;
}
$thisProblems = postJSON($z_url_api, $request);
_log('> Problem data (recent)'.$cCRLF.json_encode($thisProblems,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
@@ -814,7 +866,7 @@
$request = array('jsonrpc'=>'2.0',
'method'=>'problem.get',
'params'=>array('output'=>'extend',
'recent'=>'false',
'recent'=>FALSE,
'limit'=>1),
'auth'=>$token,
'id'=>nextRequestID());
@@ -839,15 +891,27 @@
_log('# Retreiving EVENT information');
$request = array('jsonrpc'=>'2.0',
'method'=>'event.get',
'params'=>array('eventids'=>$p_eventId,
'output'=>'extend',
'selectRelatedObject'=>'extend',
'selectSuppressionData'=>'extend',
'select_acknowledges'=>'extend'),
'auth'=>$token,
'id'=>nextRequestID());
if ($apiVersionMajor<"7") {
$request = array('jsonrpc'=>'2.0',
'method'=>'event.get',
'params'=>array('eventids'=>$p_eventId,
'output'=>'extend',
'selectRelatedObject'=>'extend',
'selectSuppressionData'=>'extend',
'select_acknowledges'=>'extend'),
'auth'=>$token,
'id'=>nextRequestID());
} else {
$request = array('jsonrpc'=>'2.0',
'method'=>'event.get',
'params'=>array('eventids'=>$p_eventId,
'output'=>'extend',
'selectRelatedObject'=>'extend',
'selectSuppressionData'=>'extend',
'selectAcknowledges'=>'extend'),
'auth'=>$token,
'id'=>nextRequestID());
}
$thisEvent = postJSON($z_url_api,$request);
_log('> Event data'.$cCRLF.json_encode($thisEvent,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
@@ -875,7 +939,7 @@
}
// --- Collect and attach acknowledge messages for this event
if (sizeof($thisEvent['result'][0]['acknowledges']>0)) {
if (count($thisEvent['result'][0]['acknowledges'])>0) {
foreach($thisEvent['result'][0]['acknowledges'] as $aCount=>$anAck) {
$mailData['ACKNOWLEDGES'][$aCount] = $anAck;
$mailData['ACKNOWLEDGES'][$aCount]['_clock'] = zabbixTStoString($anAck['clock']);
@@ -971,18 +1035,30 @@
break;
case 'mailGraph.screen':
$triggerScreen = intval($aTag['value']);
_log('+ Trigger screen = '.$triggerScreen);
if ($apiVersionMajor<="5") {
$triggerScreen = intval($aTag['value']);
_log('+ Trigger screen = '.$triggerScreen);
} else {
_log('- Trigger screen value ignored');
}
break;
case 'mailGraph.screenPeriod':
$triggerScreenPeriod = $aTag['value'];
_log('+ Trigger screen period = '.$triggerScreenPeriod);
if ($apiVersionMajor<="5") {
$triggerScreenPeriod = $aTag['value'];
_log('+ Trigger screen period = '.$triggerScreenPeriod);
}
break;
case 'mailGraph.screenPeriodHeader':
$triggerScreenPeriodHeader = $aTag['value'];
_log('+ Trigger screen header = '.$triggerScreenPeriodHeader);
if ($apiVersionMajor<="5") {
$triggerScreenPeriodHeader = $aTag['value'];
_log('+ Trigger screen header = '.$triggerScreenPeriodHeader);
}
break;
case 'mailGraph.valueTruncate':
$p_item_value_truncate = intval($aTag['value']);
_log('+ Data value truncing = '.$p_item_value_truncate);
break;
}
}
@@ -1028,9 +1104,11 @@
if (substr($mailData['ITEM_LASTVALUE'],0,5)=='<?xml') { $mailData['ITEM_LASTVALUE'] = '[record]'; }
if (substr($mailData['ITEM_PREVIOUSVALUE'],0,5)=='<?xml') { $mailData['ITEM_PREVIOUSTVALUE'] = '[record]'; }
// Catch long elements
if (strlen($mailData['ITEM_LASTVALUE'])>50) { $mailData['ITEM_LASTVALUE'] = substr($mailData['ITEM_LASTVALUE'],0,50).' ...'; }
if (strlen($mailData['ITEM_PREVIOUSVALUE'])>50) { $mailData['ITEM_PREVIOUSVALUE'] = substr($mailData['ITEM_PREVIOUSVALUE'],0,50).' ...'; }
// Handling long data elements
if ($p_item_value_truncate>0) {
if (strlen($mailData['ITEM_LASTVALUE'])>$p_item_value_truncate) { $mailData['ITEM_LASTVALUE'] = substr($mailData['ITEM_LASTVALUE'],0,$p_item_value_truncate).' ...'; }
if (strlen($mailData['ITEM_PREVIOUSVALUE'])>$p_item_value_truncate) { $mailData['ITEM_PREVIOUSVALUE'] = substr($mailData['ITEM_PREVIOUSVALUE'],0,$p_item_value_truncate).' ...'; }
}
// ---------------------
// --- GET HOST INFO ---
@@ -1260,26 +1338,30 @@
$result = array();
foreach($screenGraphs['result'][0]['screenitems'] as $anItem)
{
switch($anItem['resourcetype'])
if (isset($screenGrahps['result'][0]['screenitems'])) {
foreach($screenGraphs['result'][0]['screenitems'] as $anItem)
{
case 0: // Graph
$request = array('jsonrpc'=>'2.0',
'method'=>'graph.get',
'params'=>array('graphids'=>$anItem['resourceid'],
'expandName'=>1,
'output'=>'extend'),
'auth'=>$token,
'id'=>nextRequestID());
switch($anItem['resourcetype'])
{
case 0: // Graph
$request = array('jsonrpc'=>'2.0',
'method'=>'graph.get',
'params'=>array('graphids'=>$anItem['resourceid'],
'expandName'=>1,
'output'=>'extend'),
'auth'=>$token,
'id'=>nextRequestID());
$screenGraph = postJSON($z_url_api,$request);
_log('+ Graph data for screen item #'.$anItem['screenitemid'].$cCRLF.
json_encode($screenGraph,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
$screenGraph = postJSON($z_url_api,$request);
_log('+ Graph data for screen item #'.$anItem['screenitemid'].$cCRLF.
json_encode($screenGraph,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
$result[] = array('screen'=>$anItem,'name'=>$screenGraphs['result'][0]['name'],'graph'=>$screenGraph['result'][0]);
break;
$result[] = array('screen'=>$anItem,'name'=>$screenGraphs['result'][0]['name'],'graph'=>$screenGraph['result'][0]);
break;
}
}
} else {
_log('> No screen items associated to this screen?');
}
// --- Sort the result according to SCREEN x,y position
@@ -1506,6 +1588,12 @@
$mailData['EVENT_DURATION'] = $p_duration;
$mailData['HOST_PROBLEMS_URL'] = $z_server.'zabbix.php?show=1&name=&inventory%5B0%5D%5Bfield%5D=type&inventory%5B0%5D%5Bvalue%5D=&evaltype=0&tags%5B0%5D%5Btag%5D=&tags%5B0%5D%5Boperator%5D=0&tags%5B0%5D%5Bvalue%5D=&show_tags=3&tag_name_format=0&tag_priority=&show_opdata=0&show_timeline=1&filter_name=&filter_show_counter=0&filter_custom_time=0&sort=clock&sortorder=DESC&age_state=0&show_suppressed=0&unacknowledged=0&compact_view=0&details=0&highlight_row=0&action=problem.view&hostids%5B%5D='.$mailData['HOST_ID'];
// Handling long data elements
if ($p_item_value_truncate>0) {
if (strlen($mailData['ITEM_LASTVALUE'])>$p_item_value_truncate) { $mailData['ITEM_LASTVALUE'] = substr($mailData['ITEM_LASTVALUE'],0,$p_item_value_truncate).' ...'; }
if (strlen($mailData['ITEM_PREVIOUSVALUE'])>$p_item_value_truncate) { $mailData['ITEM_PREVIOUSVALUE'] = substr($mailData['ITEM_PREVIOUSVALUE'],0,$p_item_value_truncate).' ...'; }
}
/////////////////////////////////////////////////////////////////////////////////////////////////////////
// Compose & Send Message ///////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1523,11 +1611,34 @@
$mail->CharSet = "UTF-8";
$mail->Encoding = "base64";
// Inialize SMTP parameters
// --- Inialize SMTP parameters
$mail->isSMTP();
$mail->Host = $p_smtp_server;
$mail->Port = $p_smtp_port;
// --- Initialize transport security
switch($p_smtp_security) {
case 'smtps':
_log('> Using SMTPS transport encryption method');
$mail->SMTPSecure = PHPMailer::ENCRYPTION_SMTPS;
break;
case 'starttls':
_log('> Using STARTTLS transport encryption method');
$mail->SMTPSecure = PHPMailer::ENCRYPTION_STARTTLS;
break;
default:
_log('> Plain transport (no encryption)');
}
// --- Disable strict certificate checking?
if ($p_smtp_strict=='no')
{
_log('> No strict TLS checking');
$mail->SMTPOptions = [
'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true ]
];
}
// --- Authentication required?
if ($p_smtp_username!="")
{
@@ -1536,14 +1647,6 @@
$mail->Password = $p_smtp_password;
}
// --- Disable strict certificate checking?
if ($p_smtp_strict=='no')
{
$mail->SMTPOptions = [
'ssl' => [ 'verify_peer' => false, 'verify_peer_name' => false, 'allow_self_signed' => true ]
];
}
// --- Define from
$mail->Sender = $p_smtp_from_address;
$mail->SetFrom($p_smtp_from_address, $p_smtp_from_name, FALSE);
@@ -1633,6 +1736,7 @@
{
echo "! Failed to send message".$cCRLF;
echo "! Error message: ".$e->getMessage().$cCRLF;
echo "! Check your mail server and/or transport settings!".$cCRLF;
_log("! Failed: ".$e->getMessage());
}

View File

@@ -60,7 +60,7 @@
<value>https://myzabbix.com/mailGraph.php</value>
</parameter>
</parameters>
<script>// mailGraph v2.16
<script>// mailGraph v2.20
// Function to test string
function isJSON(str) {

View File

@@ -101,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/>