mirror of
https://github.com/moudsen/mailGraph
synced 2025-10-28 08:07:39 +01:00
Compare commits
30 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
32b8582757 | ||
|
|
9c42ee4b89 | ||
|
|
fa7fba040a | ||
|
|
3a4a7ab23e | ||
|
|
7075b40ad1 | ||
|
|
8bc476ed63 | ||
|
|
e80a2a56a3 | ||
|
|
4b28d3f066 | ||
|
|
93535d4006 | ||
|
|
b9622da72f | ||
|
|
56fb68ae9c | ||
|
|
fa51c3e59e | ||
|
|
4ae62b3a1f | ||
|
|
0731b87d44 | ||
|
|
bdf4b05a6b | ||
|
|
df16444665 | ||
|
|
bccd134523 | ||
|
|
27c1d64511 | ||
|
|
8597658670 | ||
|
|
b7e2062486 | ||
|
|
2955ffc404 | ||
|
|
2976a4af9c | ||
|
|
2882367308 | ||
|
|
8b4885038a | ||
|
|
f541719fbe | ||
|
|
9edab245d8 | ||
|
|
341bd561ab | ||
|
|
e2f657f3dd | ||
|
|
82a8fe4121 | ||
|
|
bee76b63c0 |
67
README.md
67
README.md
@@ -1,16 +1,65 @@
|
||||
## mailGraph (v1.28)
|
||||
Zabbix Media module and scripts for sending e-mail alerts with graphs.
|
||||
## mailGraph v2.11 release ##
|
||||
_(2023/07/01)_
|
||||
|
||||
**Please use the Wiki for information on how to install, configure and use MailGraph in Zabbix.**
|
||||
_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)_
|
||||
|
||||
## UPGRADE NOTES
|
||||
### v1.27
|
||||
If you upgrade to v1.27 please be aware of the additional features for adding Tags to Trigger and Host to add additional graphs and the associated `html.template` updates that come alone with it (otherwise the new graphs will not show ...).
|
||||
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)
|
||||
|
||||
### v1.25 and higher
|
||||
Template data provisioning and code has fundamentally changed. If you upgrade from an earlier version as v1.25, make sure you understand the changes in templates/html.template (now making use of arrays for lists of items).
|
||||
Modified files
|
||||
- mailGraph.php
|
||||
- mailGraph.xml
|
||||
- javascript/zabbix.mailGraph.js
|
||||
|
||||
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
|
||||
|
||||
Changes are in effect immediately, no need to restart any services.
|
||||
|
||||
## mailGraph v2.10 release ##
|
||||
_(2023/06/30)_
|
||||
|
||||
_This version has been verified with Zabbix 5.4, 6.0 LTS and 6.4._
|
||||
|
||||
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
|
||||
|
||||
## Zabbix 6.4.x testing ##
|
||||
_(2023/06/30)_
|
||||
|
||||
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")
|
||||
|
||||
Sidenotes
|
||||
- Zabbix logging still shows deprecation messages however it is believed these are internal to Zabbix and not related to mailGraph
|
||||
|
||||
_(2023/06/29)_
|
||||
|
||||
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.
|
||||
|
||||
## Zabbix 6.2.x testing ##
|
||||
_(2022/10/10)_
|
||||
|
||||
Testing completed. No immediate issues found.
|
||||
|
||||
_(2022/08/22)_
|
||||
|
||||
Zabbix 6.2.x testing is in progress. Once completed the next effort will be to deliver on automatic configuration detection and automatic updates.
|
||||
|
||||
## IMPORTANT NOTE ##
|
||||
As a result of a major functional change in Zabbix 5.4 (Screens no longer exist and are all moved into Dashboards) the mailGraph.screen macro no longer functions under Zabbix 5.4+. A code rewrite is in progress to deal with detecting the Zabbix version and to pick dashboard.get instead of screen.get as a source list for the graphs that should be included in the mail message.
|
||||
|
||||
**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**
|
||||
|
||||
## Example message
|
||||
The below message is just an example of what MailGraph is capable of. The template engine used ("Twig") however allows for a fully customized message creation to your needs!
|
||||
The below message is just an example of what MailGraph is capable of. The template engine ("Twig") allows for a fully customized message creation to your needs! It is also possible to add more Zabbix fields. If you need additional fields just raise an issue ticket and ask and I'll see what I can do.
|
||||
|
||||
[](images/Example-mail-message-v122.png)
|
||||
|
||||
@@ -27,7 +27,7 @@
|
||||
$content = file_get_contents($argv[1]);
|
||||
$data = json_decode($content,TRUE);
|
||||
|
||||
if ($data==NULL)
|
||||
if (($data==NULL) && (sizeof($content)>2))
|
||||
{
|
||||
echo 'Invalid JSON format in config file?!'.$cCRLF;
|
||||
die;
|
||||
@@ -138,4 +138,4 @@
|
||||
default:
|
||||
echo 'Unknown command?'.$cCRLF;
|
||||
}
|
||||
?>
|
||||
?>
|
||||
|
||||
BIN
images/Example-Zabbix-MediaType-Config.png
Normal file
BIN
images/Example-Zabbix-MediaType-Config.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
1
javascript/READ.ME
Normal file
1
javascript/READ.ME
Normal file
@@ -0,0 +1 @@
|
||||
Issue #32 has been resolved. The javascript code now works for Zabbix 5.4, 6.0 LTS and 6.4.
|
||||
@@ -1,7 +1,8 @@
|
||||
// mailGraph v2.11
|
||||
try {
|
||||
// Pickup parameters
|
||||
params = JSON.parse(value),
|
||||
req = new CurlHttpRequest(),
|
||||
req = new HttpRequest(),
|
||||
fields = {},
|
||||
resp = '',
|
||||
result = { tags: {} };
|
||||
@@ -13,14 +14,26 @@ try {
|
||||
}
|
||||
|
||||
// Declare output type
|
||||
req.AddHeader('Content-Type: application/json');
|
||||
req.addHeader('Content-Type: application/json');
|
||||
|
||||
// Must have fields
|
||||
fields.itemId = params.itemId;
|
||||
fields.eventId = params.eventId;
|
||||
fields.itemId = params.itemId * 1;
|
||||
fields.eventId = params.eventId * 1;
|
||||
fields.recipient = params.recipient;
|
||||
fields.baseURL = params.baseURL;
|
||||
fields.duration = params.duration;
|
||||
fields.duration = params.duration * 1;
|
||||
|
||||
if (isNaN(fields.eventId)) {
|
||||
throw '[MailGraph Webhook] Invalid event ID? Integer required (use actual event ID from Zabbix!)';
|
||||
}
|
||||
|
||||
if (isNaN(fields.duration)) {
|
||||
throw '[MailGraph Webhook] Invalid duration? Integer required (set to zero if unknown)!';
|
||||
}
|
||||
|
||||
if (fields.recipient.charAt(0) == '{') {
|
||||
throw '[MailGraph Webhook] Please define recipient for the test message!';
|
||||
}
|
||||
|
||||
// Optional fields
|
||||
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
|
||||
@@ -40,15 +53,27 @@ 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] Receiving response:' + resp);
|
||||
var resp = req.post(params.URL,JSON.stringify(fields));
|
||||
Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
|
||||
|
||||
// If there was an error, report it
|
||||
if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }
|
||||
// If blank the email address is likely incorrect
|
||||
if (resp==null) {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
|
||||
}
|
||||
|
||||
// If there was an error, report it and stop
|
||||
if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
|
||||
|
||||
// If no datas returned, report it and stop
|
||||
if (resp.charAt(0) == "!") {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the event ID provided does not exist? Check mailGraph logging';
|
||||
}
|
||||
|
||||
// We expect the message id back from the processing script
|
||||
resp = JSON.parse(resp);
|
||||
result.tags.__message_id = resp.messageId;
|
||||
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);
|
||||
@@ -56,6 +81,6 @@ try {
|
||||
catch (error)
|
||||
{
|
||||
// In case something went wrong in the processing, pass the error back to Zabbix
|
||||
Zabbix.Log(127, 'MailGraph notification failed : '+error);
|
||||
Zabbix.Log(127, 'MailGraph notification failed: '+error);
|
||||
throw 'MailGraph notification failed : '+error;
|
||||
}
|
||||
|
||||
196
mailGraph.php
196
mailGraph.php
@@ -8,6 +8,8 @@
|
||||
// upon an alert message.
|
||||
//
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// Release 1 tested with Zabbix 5.4 and 6.0 LTS
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// 1.00 2021/02/26 - Mark Oudsen - MVP version, ready for distribution
|
||||
// 1.01 2021/02/27 - Mark Oudsen - Enhanced search for associated graphs to an item // bug fixes
|
||||
// 1.10 2021/02/27 - Mark Oudsen - Moved all configuration outside code
|
||||
@@ -36,6 +38,19 @@
|
||||
// 1.27 2021/03/19 - Mark Oudsen - Added ability to define "mailGraph.screen" tag to embed graphs from
|
||||
// Added PHP informational and warnings to log for easier debug/spotting
|
||||
// 1.28 2021/03/24 - Mark Oudsen - Added ability to specify username/password for TLS/SSL
|
||||
// 1.29 2021/04/03 - Mark Oudsen - Bugfix due to stricter JSONRPC version check since Zabbix 5.0.10
|
||||
// 2021/07/05 - Mark Oudsen - Minor detail added: CLI debug mode now also outputs version
|
||||
// 2021/07/07 - Mark Oudsen - Fixed HTTPProxy typo in code (instead of HTTPPRoxy)
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// Release 2 tested with Zabbix 5.4, 6.0 LTS and 6.4 - tested with latest Composer libraries
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// 2.00 2021/12/16 - Mark Oudsen - itemId not always provisioned by Zabbix
|
||||
// Several fixes on warning - several small bug fixes
|
||||
// 2.01 2021/12/16 - Mark Oudsen - Screens are no longer available - reverting to using Dashboards now
|
||||
// 2.02 2022/01/30 - Mark Oudsen - Added cleanup routine for old logs and images
|
||||
// 2.10 2023/06/30 - Mark Oudsen - Refactored deprecated code - now compatible with Zabbix 6.0 LTS, 6.4
|
||||
// 2.11 2023/07/01 - Mark Oudsen - Refactored Zabbix javascript - now capturing obvious errors
|
||||
// Added ability to locate latest problems for testing purposes
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
//
|
||||
// (C) M.J.Oudsen, mark.oudsen@puzzl.nl
|
||||
@@ -57,8 +72,7 @@
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// CONSTANTS
|
||||
|
||||
$cVersion = 'v1.28';
|
||||
$cVersion = 'v2.11';
|
||||
$cCRLF = chr(10).chr(13);
|
||||
$maskDateTime = 'Y-m-d H:i:s';
|
||||
$maxGraphs = 4;
|
||||
@@ -66,10 +80,14 @@
|
||||
// DEBUG SETTINGS
|
||||
// -- Should be FALSE for production level use
|
||||
|
||||
$cDebug = TRUE; // Extended debug logging mode
|
||||
$cDebug = TRUE; // Extended debug logging mode
|
||||
$cDebugMail = FALSE; // If TRUE, includes log in the mail message (html and plain text attachments)
|
||||
$showLog = FALSE; // Display the log - !!! only use in combination with CLI mode !!!
|
||||
|
||||
// Limit server level output errors
|
||||
|
||||
error_reporting(E_ERROR | E_PARSE);
|
||||
|
||||
// INCLUDE REQUIRED LIBRARIES (Composer)
|
||||
// (configure at same location as the script is running or load in your own central library)
|
||||
// -- swiftmailer/swiftmailer https://swiftmailer.symfony.com/docs/introduction.html
|
||||
@@ -99,23 +117,24 @@
|
||||
$ch = curl_init();
|
||||
|
||||
// Set options
|
||||
curl_setopt($ch, CURLOPT_USERAGENT, 'Zabbix-mailGraph - '.$cVersion);
|
||||
|
||||
if ((isset($HTTPProxy)) && ($HTTPProxy!=''))
|
||||
{
|
||||
_log('% Using proxy: '.$HTTPProxy);
|
||||
if ($cDebug) { _log('% Using proxy: '.$HTTPProxy); }
|
||||
curl_setopt($ch, CURLOPT_PROXY, $HTTPProxy);
|
||||
}
|
||||
|
||||
curl_setopt($ch, CURLOPT_IPRESOLVE, CURL_IPRESOLVE_V4);
|
||||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
|
||||
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 20);
|
||||
|
||||
curl_setopt($ch, CURLOPT_POST, TRUE);
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
|
||||
|
||||
curl_setopt($ch, CURLOPT_URL, $url);
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type:application/json'));
|
||||
curl_setopt($ch, CURLOPT_POST, TRUE);
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS,
|
||||
json_encode($data,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
|
||||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
|
||||
|
||||
curl_setopt($ch, CURLOPT_USERAGENT, 'Zabbix-mailGraph - '.$cVersion);
|
||||
|
||||
// Execute Curl
|
||||
$data = curl_exec($ch);
|
||||
@@ -124,9 +143,10 @@
|
||||
{
|
||||
_log('! Failed: '.curl_error($ch));
|
||||
|
||||
$data = 'An error occurred while retreiving the requested page.'.$cCRLF;
|
||||
$data .= 'Requested page = '.$url.$cCRLF;
|
||||
$data .= 'Error = '.curl_error($ch).$cCRLF;
|
||||
$data = array();
|
||||
$data[] = 'An error occurred while retreiving the requested page.';
|
||||
$data[] .= 'Requested page = '.$url;
|
||||
$data[] .= 'Error = '.curl_error($ch);
|
||||
}
|
||||
else
|
||||
{
|
||||
@@ -377,6 +397,40 @@
|
||||
return($info);
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Cleanup 'path': remove files with 'ext' older than 'daysOld'
|
||||
|
||||
function cleanupDir($path, $ext, $daysOld)
|
||||
{
|
||||
_log('- Scanning "'.$path.'"');
|
||||
|
||||
$files = glob($path.'/*'.$ext);
|
||||
$now = time();
|
||||
|
||||
$filesRemoved = 0;
|
||||
$filesKept = 0;
|
||||
|
||||
foreach ($files as $file)
|
||||
{
|
||||
if (is_file($file))
|
||||
{
|
||||
if ($now - filemtime($file) >= (60 * 60 * 24 * $daysOld))
|
||||
{
|
||||
_log('> Removing "'.$file.'"');
|
||||
unlink($file);
|
||||
$filesRemoved++;
|
||||
}
|
||||
else
|
||||
{
|
||||
$filesKept++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
_log(': Done. Cleaned up '.$filesRemoved.' file(s), kept '.$filesKept.' file(s)');
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Initialize ///////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
@@ -404,6 +458,10 @@
|
||||
{
|
||||
if (($argc>1) && ($argv[1]=='test'))
|
||||
{
|
||||
// Switch on CLI log display
|
||||
$showLog = TRUE;
|
||||
|
||||
_log('<<< mailGraph '.$cVersion.' >>>');
|
||||
_log('# Invoked from CLI');
|
||||
|
||||
// Assumes that config.json file has the correct information
|
||||
@@ -423,9 +481,31 @@
|
||||
if (isset($config['cli_periods_headers'])) { $problemData['periods_headers'] = $config['cli_periods_headers']; }
|
||||
if (isset($config['cli_debug'])) { $problemData['debug'] = $config['cli_debug']; }
|
||||
if (isset($config['cli_proxy'])) { $problemData['HTTPProxy'] = $config['cli_proxy']; }
|
||||
}
|
||||
|
||||
if (($argc>1) && ($argv[1]=='cleanup'))
|
||||
{
|
||||
// Switch on CLI log display
|
||||
$showLog = TRUE;
|
||||
|
||||
// Check for configuration of retention period for images and logs
|
||||
_log('<<< mailGraph '.$cVersion.' >>>');
|
||||
_log('# Invoked from CLI');
|
||||
|
||||
// Set defaults
|
||||
$retImages = 30;
|
||||
$retLogs = 14;
|
||||
|
||||
// Check if configured settings
|
||||
if (isset($config['retention_images'])) { $retImages = intval($config['retention_images']); }
|
||||
if (isset($config['retention_logs'])) { $retLogs = intval($config['retention_logs']); }
|
||||
|
||||
_log('Cleaning up IMAGES ('.$retImages.' days) and LOGS ('.$retLogs.' days)');
|
||||
|
||||
cleanupDir(getcwd().'/images', '.png', $retImages);
|
||||
cleanupDir(getcwd().'/log', '.dump', $retLogs);
|
||||
|
||||
exit(0);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -435,8 +515,8 @@
|
||||
// --- CHECK AND SET P_ VARIABLES ---
|
||||
// FROM POST OR CLI DATA
|
||||
|
||||
if (!isset($problemData['itemId'])) { echo "Missing ITEM ID?\n"; die; }
|
||||
$p_itemId = intval($problemData['itemId']);
|
||||
// if (!isset($problemData['itemId'])) { echo "Missing ITEM ID?\n"; die; }
|
||||
// $p_itemId = intval($problemData['itemId']);
|
||||
|
||||
if (!isset($problemData['eventId'])) { echo "Missing EVENT ID?\n"; die; }
|
||||
$p_eventId = intval($problemData['eventId']);
|
||||
@@ -465,7 +545,7 @@
|
||||
$p_period = '48h';
|
||||
if (isset($problemData['period'])) { $p_period = $problemData['period']; }
|
||||
|
||||
if (isset($problemData['HTTPProxy'])) { $HTTPProxy = $problemData['HTTPPRoxy']; }
|
||||
if (isset($problemData['HTTPProxy'])) { $HTTPProxy = $problemData['HTTPProxy']; }
|
||||
|
||||
// DYNAMIC VARIABLES FROM ZABBIX
|
||||
|
||||
@@ -516,9 +596,20 @@
|
||||
$z_pass = $config['zabbix_user_pwd'];
|
||||
|
||||
// Zabbix API user (requires Super Admin access rights)
|
||||
// --- Copy from Zabbix user and override when defined in configuration
|
||||
// TODO: Check if information retreival can be done with less rigths
|
||||
$z_api_user = $config['zabbix_api_user'];
|
||||
$z_api_pass = $config['zabbix_api_pwd'];
|
||||
$z_api_user = $z_user;
|
||||
$z_api_pass = $z_pass;
|
||||
|
||||
if (isset($config['zabbix_api_user']))
|
||||
{
|
||||
$z_api_user = $config['zabbix_api_user'];
|
||||
}
|
||||
|
||||
if (isset($config['zabbix_api_pwd']))
|
||||
{
|
||||
$z_api_pass = $config['zabbix_api_pwd'];
|
||||
}
|
||||
|
||||
// Mail sender
|
||||
$mailFrom = array($config['mail_from']=>'Zabbix Mailgraph');
|
||||
@@ -554,7 +645,7 @@
|
||||
|
||||
$request = array('jsonrpc'=>'2.0',
|
||||
'method'=>'user.login',
|
||||
'params'=>array('user'=>$z_api_user,
|
||||
'params'=>array('username'=>$z_api_user,
|
||||
'password'=>$z_api_pass),
|
||||
'id'=>nextRequestID(),
|
||||
'auth'=>null);
|
||||
@@ -564,10 +655,41 @@
|
||||
$token = '';
|
||||
if (isset($result['result'])) { $token = $result['result']; }
|
||||
|
||||
if ($token=='') { echo 'Error logging in to Zabbix? ('.$z_url_api.')'; 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);
|
||||
|
||||
// -----------------------------------
|
||||
// --- IF NO EVENT ID FETCH LATEST ---
|
||||
// -----------------------------------
|
||||
|
||||
if ($p_eventId=="0")
|
||||
{
|
||||
_log('# No event ID given, picking up random event from Zabbix');
|
||||
|
||||
$request = array('jsonrpc'=>'2.0',
|
||||
'method'=>'problem.get',
|
||||
'params'=>array('output'=>'extend',
|
||||
'recent'=>'true',
|
||||
'limit'=>1),
|
||||
'auth'=>$token,
|
||||
'id'=>nextRequestID());
|
||||
|
||||
$thisProblems = postJSON($z_url_api, $request);
|
||||
_log('> Problem data'.$cCRLF.json_encode($thisProblems,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
|
||||
|
||||
if (!isset($thisProblems['result'][0])) { echo '! No response data received?'.$cCRLF; die; }
|
||||
|
||||
$p_eventId = $thisProblems['result'][0]['eventid'];
|
||||
_log('> Picked up random last event #'.$p_eventId);
|
||||
}
|
||||
|
||||
// ------------------------------
|
||||
// --- READ EVENT INFORMATION ---
|
||||
// ------------------------------
|
||||
@@ -621,10 +743,10 @@
|
||||
'params'=>array('triggerids'=>$p_triggerId,
|
||||
'output'=>'extend',
|
||||
'selectFunctions'=>'extend',
|
||||
'selectTags'=>'extend'),
|
||||
'expandComment'=>1,
|
||||
'expandDescription'=>1,
|
||||
'expandExpression'=>1,
|
||||
'selectTags'=>'extend',
|
||||
'expandComment'=>1,
|
||||
'expandDescription'=>1,
|
||||
'expandExpression'=>1),
|
||||
'auth'=>$token,
|
||||
'id'=>nextRequestID());
|
||||
|
||||
@@ -710,6 +832,16 @@
|
||||
}
|
||||
}
|
||||
|
||||
if (!isset($p_itemId))
|
||||
{
|
||||
foreach($thisTrigger['result'][0]['functions'] as $aFunction)
|
||||
{
|
||||
$p_itemId = $aFunction['itemid'];
|
||||
_log('- Item ID taken from trigger (first) function = '.$p_itemId);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------
|
||||
// --- GET ITEM INFO ---
|
||||
// ---------------------
|
||||
@@ -766,7 +898,7 @@
|
||||
|
||||
$mailData['HOST_ID'] = $thisHost['result'][0]['hostid'];
|
||||
$mailData['HOST_NAME'] = $thisHost['result'][0]['name'];
|
||||
$mailData['HOST_ERROR'] = $thisHost['result'][0]['error'];
|
||||
if (isset($thisHost['result'][0]['error'])) { $mailData['HOST_ERROR'] = $thisHost['result'][0]['error']; }
|
||||
$mailData['HOST_DESCRIPTION'] = $thisHost['result'][0]['description'];
|
||||
|
||||
// --- Custom settings?
|
||||
@@ -1011,6 +1143,7 @@
|
||||
_log('> Graphs found = '.sizeof($triggerGraphs));
|
||||
}
|
||||
|
||||
$hostGraphs = array();
|
||||
|
||||
if ($hostScreen>0)
|
||||
{
|
||||
@@ -1334,8 +1467,15 @@
|
||||
|
||||
// Return Event TAG information for Zabbix
|
||||
|
||||
$response = array('messageId.mailGraph'=>$messageId);
|
||||
echo json_encode($response).$cCRLF;
|
||||
$response = array('messageId'=>$messageId);
|
||||
|
||||
if ($response=="")
|
||||
{
|
||||
_log("! Failed to send mail message");
|
||||
echo "! Failed to send mail message. Likely an issue with the recipient email address?".$cCRLF;
|
||||
} else {
|
||||
echo json_encode($response).$cCRLF;
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Wrap up //////////////////////////////////////////////////////////////////////////////////////////////
|
||||
@@ -1354,6 +1494,6 @@
|
||||
$logName = 'log.'.$p_eventId.'.'.date('YmdHis').'.dump';
|
||||
|
||||
file_put_contents($z_log_path.$logName,$content);
|
||||
_log('= Log stored to '.$z_log_path.$logName);
|
||||
_log('= Log stored to '.$z_log_path.$logName);
|
||||
}
|
||||
?>
|
||||
?>
|
||||
|
||||
388
mailGraph.xml
388
mailGraph.xml
@@ -1,190 +1,198 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<zabbix_export>
|
||||
<version>5.0</version>
|
||||
<date>2021-03-17T12:55:43Z</date>
|
||||
<media_types>
|
||||
<media_type>
|
||||
<name>MailGraph</name>
|
||||
<type>WEBHOOK</type>
|
||||
<parameters>
|
||||
<parameter>
|
||||
<name>baseURL</name>
|
||||
<value>https://mydomain.com/zabbix/</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>duration</name>
|
||||
<value>{EVENT.DURATION}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>eventId</name>
|
||||
<value>{EVENT.ID}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>graphHeight</name>
|
||||
<value>120</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>graphWidth</name>
|
||||
<value>300</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>HTTPProxy</name>
|
||||
<value/>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<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>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>periods_headers</name>
|
||||
<value>Last 10 minutes,Last 4 hours,Last day,Last 7 days</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>recipient</name>
|
||||
<value>{ALERT.SENDTO}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>showLegend</name>
|
||||
<value>0</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>subject</name>
|
||||
<value>{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>URL</name>
|
||||
<value>https://mydomain.com/mailGraph.php</value>
|
||||
</parameter>
|
||||
</parameters>
|
||||
<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);
|
||||
fields.HTTPProxy = params.HTTPProxy;
|
||||
}
|
||||
|
||||
// Declare output type
|
||||
req.AddHeader('Content-Type: application/json');
|
||||
|
||||
// Must have fields
|
||||
fields.itemId = params.itemId;
|
||||
fields.eventId = params.eventId;
|
||||
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).
|
||||
|
||||
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.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.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}.
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]</message>
|
||||
</message_template>
|
||||
</message_templates>
|
||||
</media_type>
|
||||
</media_types>
|
||||
</zabbix_export>
|
||||
zabbix_export:
|
||||
version: '5.4'
|
||||
date: '2023-07-01T10:54:39Z'
|
||||
media_types:
|
||||
-
|
||||
name: MailGraph
|
||||
type: WEBHOOK
|
||||
parameters:
|
||||
-
|
||||
name: baseURL
|
||||
value: 'https://myzabbix.example.com/'
|
||||
-
|
||||
name: duration
|
||||
value: '{EVENT.DURATION}'
|
||||
-
|
||||
name: eventId
|
||||
value: '{EVENT.ID}'
|
||||
-
|
||||
name: graphHeight
|
||||
value: '120'
|
||||
-
|
||||
name: graphWidth
|
||||
value: '300'
|
||||
-
|
||||
name: HTTPProxy
|
||||
value: ''
|
||||
-
|
||||
name: infoTest
|
||||
value: Test
|
||||
-
|
||||
name: itemId
|
||||
value: '{ITEM.ID}'
|
||||
-
|
||||
name: periods
|
||||
value: '10m,4h,1d,7d'
|
||||
-
|
||||
name: periods_headers
|
||||
value: 'Last 10 minutes,Last 4 hours,Last day,Last 7 days'
|
||||
-
|
||||
name: recipient
|
||||
value: '{ALERT.SENDTO}'
|
||||
-
|
||||
name: showLegend
|
||||
value: '0'
|
||||
-
|
||||
name: subject
|
||||
value: '{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}'
|
||||
-
|
||||
name: URL
|
||||
value: 'https://myzabbix.example.com/mailGraph.php'
|
||||
script: |
|
||||
// mailGraph v2.11
|
||||
try {
|
||||
// Pickup parameters
|
||||
params = JSON.parse(value),
|
||||
req = new HttpRequest(),
|
||||
fields = {},
|
||||
resp = '',
|
||||
result = { tags: {} };
|
||||
|
||||
// Set HTTP proxy if required
|
||||
if (typeof params.HTTPProxy === 'string' && params.HTTPProxy.trim() !== '') {
|
||||
req.setProxy(params.HTTPProxy);
|
||||
fields.HTTPProxy = params.HTTPProxy;
|
||||
}
|
||||
|
||||
// Declare output type
|
||||
req.addHeader('Content-Type: application/json');
|
||||
|
||||
// Must have fields
|
||||
fields.itemId = params.itemId * 1;
|
||||
fields.eventId = params.eventId * 1;
|
||||
fields.recipient = params.recipient;
|
||||
fields.baseURL = params.baseURL;
|
||||
fields.duration = params.duration * 1;
|
||||
|
||||
if (isNaN(fields.eventId)) {
|
||||
throw '[MailGraph Webhook] Invalid event ID? Integer required (use actual event ID from Zabbix!)';
|
||||
}
|
||||
|
||||
if (isNaN(fields.duration)) {
|
||||
throw '[MailGraph Webhook] Invalid duration? Integer required (set to zero if unknown)!';
|
||||
}
|
||||
|
||||
if (fields.recipient.charAt(0) == '{') {
|
||||
throw '[MailGraph Webhook] Please define recipient for the test message!';
|
||||
}
|
||||
|
||||
// Optional fields
|
||||
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }
|
||||
if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }
|
||||
if (typeof params.subject === 'string') { fields.subject = params.subject; }
|
||||
if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }
|
||||
if (typeof params.periods === 'string') { fields.periods = params.periods; }
|
||||
if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }
|
||||
if (typeof params.debug === 'string') { fields.debug = params.debug; }
|
||||
|
||||
// Add generic fields
|
||||
Object.keys(params).forEach(function(key) {
|
||||
if (key.substring(0, 4) == 'info') {
|
||||
fields[key] = params[key];
|
||||
}
|
||||
});
|
||||
|
||||
// Post information to the processing script
|
||||
Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));
|
||||
var resp = req.post(params.URL,JSON.stringify(fields));
|
||||
Zabbix.Log(4, '[Mailgraph Webhook] Received response:' + resp);
|
||||
|
||||
// If blank the email address is likely incorrect
|
||||
if (resp==null) {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
|
||||
}
|
||||
|
||||
// If there was an error, report it and stop
|
||||
if (req.getStatus() != 200) { throw JSON.parse(resp).errors[0]; }
|
||||
|
||||
// If no datas returned, report it and stop
|
||||
if (resp.charAt(0) == "!") {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the event ID provided does not exist? Check mailGraph logging';
|
||||
}
|
||||
|
||||
// We expect the message id back from the processing script
|
||||
msg = JSON.parse(resp);
|
||||
|
||||
result.tags.__message_id = msg.messageId;
|
||||
Zabbix.Log(4, '[MailGraph Webhook] Message sent with identification "' + msg.messageId + '"');
|
||||
|
||||
// Pass the result back to Zabbix
|
||||
return JSON.stringify(result);
|
||||
}
|
||||
catch (error)
|
||||
{
|
||||
// In case something went wrong in the processing, pass the error back to Zabbix
|
||||
Zabbix.Log(127, 'MailGraph notification failed: '+error);
|
||||
throw 'MailGraph notification failed : '+error;
|
||||
}
|
||||
process_tags: 'YES'
|
||||
description: |
|
||||
The "URL" must point to the location of the processing script. If a proxy is required, define "HTTPProxy" for the proxy address.
|
||||
|
||||
Customization:
|
||||
- "graphWidth" and "graphWidth" can be defined for the image size
|
||||
- "showLegend" can be defined to show or hide the legend of the graph
|
||||
- "subject" can be defined for a customized subject for the mail message
|
||||
- "periods" and "periods_headers" can be defined for displaying multiple periods of the same graph, or
|
||||
- "period" and "period_header" can be defined to display a single graph
|
||||
|
||||
The html.template and plain.template files can be adjusted (TWIG format).
|
||||
|
||||
More details are available at https://github.com/moudsen/mailGraph
|
||||
message_templates:
|
||||
-
|
||||
event_source: TRIGGERS
|
||||
operation_mode: PROBLEM
|
||||
subject: 'Problem: {EVENT.NAME}'
|
||||
message: |
|
||||
Problem started at {EVENT.TIME} on {EVENT.DATE}
|
||||
Problem name: {EVENT.NAME}
|
||||
Host: {HOST.NAME}
|
||||
Severity: {EVENT.SEVERITY}
|
||||
Operational data: {EVENT.OPDATA}
|
||||
Original problem ID: {EVENT.ID}
|
||||
{TRIGGER.URL}
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]
|
||||
-
|
||||
event_source: TRIGGERS
|
||||
operation_mode: RECOVERY
|
||||
subject: 'Resolved in {EVENT.DURATION}: {EVENT.RECOVERY.NAME}'
|
||||
message: |
|
||||
Problem has been resolved at {EVENT.RECOVERY.TIME} on {EVENT.RECOVERY.DATE}
|
||||
Problem name: {EVENT.RECOVERY.NAME}
|
||||
Problem duration: {EVENT.DURATION}
|
||||
Host: {HOST.NAME}
|
||||
Severity: {EVENT.SEVERITY}
|
||||
Original problem ID: {EVENT.ID}
|
||||
{TRIGGER.URL}
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]
|
||||
-
|
||||
event_source: TRIGGERS
|
||||
operation_mode: UPDATE
|
||||
subject: 'Updated problem in {EVENT.AGE}: {EVENT.NAME}'
|
||||
message: |
|
||||
{USER.FULLNAME} {EVENT.UPDATE.ACTION} problem at {EVENT.UPDATE.DATE} {EVENT.UPDATE.TIME}.
|
||||
{EVENT.UPDATE.MESSAGE}
|
||||
|
||||
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user