mirror of
https://github.com/moudsen/mailGraph
synced 2025-04-20 20:14:26 +02:00
Compare commits
No commits in common. "main" and "v2.14" have entirely different histories.
109
README.md
109
README.md
@ -4,13 +4,13 @@ Over the years I've been using Zabbix as both personal and business solution for
|
||||
This initiated the development of mailGraph v1 in Zabbix 5.4 delivering an elementary solution for sending HTML enriched messages from Zabbix including graphs.
|
||||
To facilitate in a very flexible way to setup and format messages including the graphs, Twig made its introduction towards mailGraph v2, the current release branch of mailGraph.
|
||||
|
||||
The below message is just an example of what MailGraph is capable of. The template engine in Twig allows for a fully customized message creation to your needs! It is also possible to add more Zabbix fields as any field is passed to Twig when accessible in Zabbix through the macro mechanism.
|
||||
The below message is just an example of what MailGraph is capable of. The template engine in Twig allows for a fully customized message creation to your needs! It is also possible to add more Zabbix fields as any field is passed to Twig when accessible in Zabbix through the macro mechanism. Example: `{ITEM.ID}`.
|
||||
|
||||
Note that all Zabbix host, item or screen related information is made available to Twig automatically.
|
||||
|
||||
Example message:
|
||||
|
||||
|
||||
[](images/Example-mail-message-v122.png)
|
||||
|
||||
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).
|
||||
@ -20,42 +20,97 @@ 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
|
||||
## mailGraph v2.14 release ##
|
||||
_(2023/07/10)_
|
||||
|
||||
## Announcements ##
|
||||
_(2025/02/04)_
|
||||
_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)_
|
||||
|
||||
Started on coding and testing mailGraph v3.
|
||||
Release notes
|
||||
- Adding the ability to define FROM details for the emails generated by mailGraph
|
||||
- `smtp_from_address` to set the from mail address (if not set uses mailing system default). Note: obsolete `mail_from` but retained for backwards compatibility.
|
||||
- `smtp_from_name` to set the name that goes with the mail address (if not set uses "mailGraph").
|
||||
- Adding the ability to define REPLY_TO details for the emails generated by mailGraph
|
||||
- `smtp_reply_address` to set the reply-to mail address (if not set, no reply-to will be added to the message).
|
||||
- `smtp_reply_name` to set the reply-to name of the mailbox (if not set defaults to "mailGraph feedback").
|
||||
- Adding a new URL for use in the template:
|
||||
- `ACK_URL` points to the function in Zabbix for editing and submitting an Acknowledge statement.
|
||||
|
||||
_(2025/01/26)_
|
||||
## mailGraph v2.13 release ##
|
||||
_(2023/07/03)_
|
||||
|
||||
mailGraph v2.20 now supporting Zabbix 7.0 (LTS) and Zabbix 7.2 (in particular the new API bearer token authentication method).
|
||||
_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)_
|
||||
|
||||
_(2024/12/01)_
|
||||
Release notes
|
||||
- Fixed references into Zabbix
|
||||
- Trigger was missing "context" parameter
|
||||
- Item was missing "context" parameter
|
||||
- Problems reference to this host was not generated at all
|
||||
|
||||
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.
|
||||
## mailGraph v2.12 release ##
|
||||
_(2023/07/02)_
|
||||
|
||||
_(2023/11/01)_
|
||||
_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)_
|
||||
|
||||
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.
|
||||
Release notes
|
||||
- Replaced Swiftmailer with PHPMailer
|
||||
- Configuration option "smtp_transport" removed (using PHPMailer AutoTLS)
|
||||
- Code cleanup (markup and obsolete related parts)
|
||||
- Addressed any PHP message (deprecation or error) - mailGraph debug output is now "clean" in PHP 7.4.x and PHP 8.2.x
|
||||
- Increased maximum number of graphs from 4 to 8
|
||||
|
||||
Principal bug fixing on mailGraph v2.x (logic failure or similar) will continue but only for Zabbix 6.x onwards.
|
||||
**Please consider to move to PHPMailer as soon as possible as Swiftmailer is abandoned. Installation instructions are included on the wiki.**
|
||||
|
||||
## Ideas and improvements ##
|
||||
Principal approach: `composer require phpmailer/phpmailer`, install mailGraph v2.12 or higher.
|
||||
|
||||
I'm open to new feature requests - please raise an issue for this in this Github space.
|
||||
In case Swiftmailer is no longer used elsewhere you can consider to remove this package with `swiftmailer/swiftmailer`.
|
||||
|
||||
[#50 - Docker support](https://github.com/moudsen/mailGraph/issues/50) - Docker support inserted shortly after testing; will be pushed into release 3 shortly.
|
||||
## mailGraph v2.11 release ##
|
||||
_(2023/07/01)_
|
||||
|
||||
## 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)
|
||||
_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)_
|
||||
|
||||
## 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.
|
||||
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)
|
||||
|
||||
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, PHP 7.4 and 8.2 and recent versions of libraries used via composer._
|
||||
|
||||
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.
|
||||
|
||||
## IMPORTANT NOTE for users of mailGraph v1 and Zabbix versions under 5.4 ##
|
||||
As a result of a major functional change in Zabbix 5.4 (Screens no longer exist and are all moved into Dashboards) the mailGraph.screen macro no longer functions under Zabbix 5.4+. A code rewrite is in progress to deal with detecting the Zabbix version and to pick dashboard.get instead of screen.get as a source list for the graphs that should be included in the mail message.
|
||||
|
||||
**v1.x is no longer supported; please upgrade to the current v2 release**
|
||||
|
||||
@ -16,14 +16,13 @@
|
||||
"subject": "{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
|
||||
"smtp_server": "localhost",
|
||||
"smtp_port": 25,
|
||||
"smtp_security": "none",
|
||||
"smtp_strict": "yes",
|
||||
"smtp_transport": "none",
|
||||
"smtp_from_address": "mailgraph@mydomain.com",
|
||||
"smtp_from_name": "mailGraph",
|
||||
"smtp_reply_address": "feedback@mydomain.com",
|
||||
"smtp_reply_name": "mailGraph response mailbox",
|
||||
"smtp_from_name": "mailGraph response mailbox",
|
||||
"smtp_strict": "yes",
|
||||
"graph_match": "any",
|
||||
"item_value_truncate": 50,
|
||||
"period": "20m",
|
||||
"period_header": "Last 20 minutes",
|
||||
"retention_images": 7,
|
||||
|
||||
@ -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
|
||||
}
|
||||
@ -16,14 +16,13 @@
|
||||
"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",
|
||||
"smtp_from_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
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 115 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 55 KiB |
@ -1,15 +1,4 @@
|
||||
// mailGraph v2.20
|
||||
|
||||
// Function to test string
|
||||
function isJSON(str) {
|
||||
try {
|
||||
JSON.stringify(JSON.parse(str));
|
||||
return true;
|
||||
} catch (e) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
// mailGraph v2.14
|
||||
try {
|
||||
// Pickup parameters
|
||||
params = JSON.parse(value),
|
||||
@ -27,13 +16,21 @@ try {
|
||||
// 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
|
||||
// Pick up fields relevant for mailGraph API level call
|
||||
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!';
|
||||
}
|
||||
@ -59,30 +56,20 @@ try {
|
||||
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 blank the email address is likely incorrect
|
||||
if (resp==null) {
|
||||
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
|
||||
}
|
||||
|
||||
if (resp=='') {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
|
||||
// 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';
|
||||
}
|
||||
|
||||
// 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
|
||||
// We expect the message id back from the processing script
|
||||
msg = JSON.parse(resp);
|
||||
|
||||
result.tags.__message_id = msg.messageId;
|
||||
@ -93,7 +80,7 @@ try {
|
||||
}
|
||||
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;
|
||||
}
|
||||
|
||||
372
mailGraph.php
372
mailGraph.php
@ -8,7 +8,39 @@
|
||||
// upon an alert message.
|
||||
//
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// Release 1 tested with Zabbix 5.4 and 6.0 LTS (history available on GitHub)
|
||||
// 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
|
||||
// 1.11 2021/02/28 - Mark Oudsen - Bugfixes
|
||||
// 1.12 2021/03/01 - Mark Oudsen - Bugfixes
|
||||
// Adding mail server configuration via config.json
|
||||
// 1.13 2021/03/01 - Mark Oudsen - Added smtp options to encrypt none,ssl,tls
|
||||
// 1.14 2021/03/01 - Mark Oudsen - Added smtp strict certificates yes|no via config.json
|
||||
// 1.15 2021/03/01 - Mark Oudsen - Revised relevant graph locator; allowing other item graphs if current
|
||||
// item does not have a graph associated
|
||||
// 1.16 2021/03/02 - Mark Oudsen - Found issue with graph.get not returning graphs to requested item ids
|
||||
// Workaround programmed (fetch host graphs, search for certain itemids)
|
||||
// 1.17 2021/03/02 - Mark Oudsen - Added ability to specify period of time displayed in the graph
|
||||
// 1.18 2021/03/04 - Mark Oudsen - Added ability to specify Tags per trigger
|
||||
// Shorten long "lastvalue" or "prevvalue"
|
||||
// 1.19 2021/03/05 - Mark Oudsen - Added ability to pass Zabbix 'infoXXX' parameters for TWIG template
|
||||
// 1.20 2021/03/07 - Mark Oudsen - Production level version - leaving BETA from here on ...
|
||||
// 1.21 2021/03/09 - Mark Oudsen - Reverted graph.get code back to original code as it was not a bug but
|
||||
// a wrongly typed requested (should be ARRAY, not comma separated)!
|
||||
// 1.22 2021/03/10 - Mark Oudsen - Added ability to embed multiple periods (1-4) of the same graph
|
||||
// 1.23 2021/03/12 - Mark Oudsen - Added graph support for 'Stacked', 'Pie' and 'Exploded'
|
||||
// 1.24 2021/03/12 - Mark Oudsen - Added support for HTTP proxy
|
||||
// 1.25 2021/03/16 - Mark Oudsen - Refactoring for optimized flow and relevant data retrieval
|
||||
// 1.26 2021/03/19 - Mark Oudsen - Bugfixes after refactor (wrong itemId and incorrect eventValue)
|
||||
// Suppressing Zabbix username-password in log
|
||||
// 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
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
@ -26,27 +58,6 @@
|
||||
// Small refactor on itemId variable processing (no longer mandatory)
|
||||
// Additional logic added to random eventId to explain in case of issues
|
||||
// Fixed missing flag for fetching web url related items
|
||||
// 2.15 2023/08/16 - Mark Oudsen - Bugfix for Zabbix 5.4 where empty or zeroed variables are no longer
|
||||
// passed by Zabbix (hence resulting in weird errors)
|
||||
// 2.16 2023/08/16 - Mark Oudsen - Adding ability to use ACKNOWLEDGE messages in the mail message
|
||||
// 2.17 2024/12/30 - Mark Oudsen - Fixed #47 mailData initializaton (wrong location) - BernardLinz
|
||||
// Fixed #46 invalid GraphId on trigger tag - BernardLinz
|
||||
// Fixed #44 config.json.template wrong var name - WMP
|
||||
// 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+
|
||||
// ------------------------------------------------------------------------------------------------------
|
||||
// 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
|
||||
@ -55,36 +66,6 @@
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
//
|
||||
// Notes
|
||||
// -----
|
||||
// 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 in-place upgrade when using composer update after upgrading PHP 7.x to PHP 8.x
|
||||
//
|
||||
// 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
|
||||
//
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
//
|
||||
@ -92,7 +73,7 @@
|
||||
// -------
|
||||
// - Automatic setup and configuration of mailGraph
|
||||
// - Automatic code updates (CLI triggered)
|
||||
// - Add DASHBOARD processing facility (SCREEN was abandoned after Zabbix 5.4) [idea only]
|
||||
// - Add DASHBOARD facility (SCREEN was abandoned in Zabbix 5.4
|
||||
// - Extract Graph API functionality to seperate code unit/object
|
||||
//
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
@ -104,14 +85,14 @@
|
||||
// MAIN SEQUENCE
|
||||
// -------------
|
||||
// 1) Fetch trigger, item, host, graph, event information via Zabbix API via CURL
|
||||
// 2) Fetch Graph(s) associated to the item/trigger (if any) via Zabbix URL via CURL
|
||||
// 3) Build and send mail message from template using PHPmailer//TWIG
|
||||
// 2) Fetch Graph(s) associated to the item/trigger (if any) via Zabbix URL login via CURL
|
||||
// 3) Build and send mail message from template using Swift/TWIG
|
||||
//
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
// CONSTANTS
|
||||
$cVersion = 'v2.22';
|
||||
$cVersion = 'v2.14';
|
||||
$cCRLF = chr(10).chr(13);
|
||||
$maskDateTime = 'Y-m-d H:i:s';
|
||||
$maxGraphs = 8;
|
||||
@ -130,6 +111,7 @@
|
||||
// INCLUDE REQUIRED LIBRARIES (Composer)
|
||||
// (configure at same location as the script is running or load in your own central library)
|
||||
// -- phpmailer/phpmailer https://github.com/PHPMailer/PHPMailer
|
||||
// -- swiftmailer/swiftmailer https://swiftmailer.symfony.com/docs/introduction.html
|
||||
// -- twig/twig https://twig.symfony.com/doc/3.x/templates.html
|
||||
|
||||
// Change only required if you decide to use a local/central library, otherwise leave as is
|
||||
@ -141,7 +123,7 @@
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Fetch the response of the given URL
|
||||
// Fetch the HTML source of the given URL
|
||||
// --- Redirects will be honored
|
||||
// --- Enforces use of IPv4
|
||||
// --- Caller must verify if the return string is JSON or ERROR
|
||||
@ -152,7 +134,6 @@
|
||||
global $cVersion;
|
||||
global $cDebug;
|
||||
global $HTTPProxy;
|
||||
global $z_api_token;
|
||||
|
||||
// Initialize Curl instance
|
||||
_log('% postJSON: '.$url);
|
||||
@ -161,6 +142,7 @@
|
||||
$ch = curl_init();
|
||||
|
||||
// Set options
|
||||
|
||||
if ((isset($HTTPProxy)) && ($HTTPProxy!=''))
|
||||
{
|
||||
if ($cDebug) { _log('% Using proxy: '.$HTTPProxy); }
|
||||
@ -170,41 +152,18 @@
|
||||
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));
|
||||
@ -241,7 +200,6 @@
|
||||
global $z_tmp_cookies;
|
||||
global $z_images_path;
|
||||
global $z_url_api;
|
||||
global $z_api_token;
|
||||
global $cVersion;
|
||||
global $cCRLF;
|
||||
global $HTTPProxy;
|
||||
@ -278,6 +236,9 @@
|
||||
"&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";
|
||||
@ -298,9 +259,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);
|
||||
|
||||
@ -312,9 +273,8 @@
|
||||
|
||||
if ($login!='')
|
||||
{
|
||||
//TODO: Pick up the specific error from CURL?
|
||||
echo 'Error logging in to Zabbix!'.$cCRLF;
|
||||
return('');
|
||||
die;
|
||||
}
|
||||
|
||||
// Get the graph
|
||||
@ -419,27 +379,50 @@
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Check the array if it contains information that should not be logged
|
||||
// Check the array for information we do not want to share in any logging
|
||||
|
||||
function maskKey(&$theValue, $theKey)
|
||||
function maskOutputFields($info)
|
||||
{
|
||||
switch($theKey)
|
||||
foreach($info as $aKey=>$aValue)
|
||||
{
|
||||
switch($aKey)
|
||||
{
|
||||
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>';
|
||||
$info[$aKey] = '<masked>';
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return($info);
|
||||
}
|
||||
|
||||
// Check the array if it contains information that should not be logged
|
||||
|
||||
function maskOutputContent($info)
|
||||
{
|
||||
array_walk_recursive($info,'maskKey');
|
||||
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;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return($info);
|
||||
}
|
||||
|
||||
@ -477,65 +460,17 @@
|
||||
_log(': Done. Cleaned up '.$filesRemoved.' file(s), kept '.$filesKept.' file(s)');
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// Zabbix translator functions
|
||||
|
||||
function zabbixTStoString($linuxTime)
|
||||
{
|
||||
return date("Y-m-d H:i:s", $linuxTime);
|
||||
}
|
||||
|
||||
function zabbixActionToString($actionMask)
|
||||
{
|
||||
$values = [];
|
||||
|
||||
if ($actionMask & 1) { $values[] = "Close problem"; }
|
||||
if ($actionMask & 2) { $values[] = "Acknowledge event"; }
|
||||
if ($actionMask & 4) { $values[] = "Add message"; }
|
||||
if ($actionMask & 8) { $values[] = "Change severity"; }
|
||||
if ($actionMask & 16) { $values[] = "Unacknowledge event"; }
|
||||
if ($actionMask & 32) { $values[] = "Suppress event"; }
|
||||
if ($actionMask & 64) { $values[] = "Unsuppress event"; }
|
||||
if ($actionMask & 128) { $values[] = "Change event rank to cause"; }
|
||||
if ($actionMask & 256) { $values[] = "Change event rank to sympton"; }
|
||||
|
||||
return implode(", ", $values);
|
||||
}
|
||||
|
||||
function zabbixSeverityToString($severity)
|
||||
{
|
||||
switch ($severity) {
|
||||
case 0: return('Not classified');
|
||||
case 1: return('Information');
|
||||
case 2: return('Warning');
|
||||
case 3: return('Average');
|
||||
case 4: return('High');
|
||||
case 5: return('Disaster');
|
||||
}
|
||||
}
|
||||
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
// 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(maskOutputContent($config),JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
|
||||
|
||||
// --- MAIL DATA ---
|
||||
|
||||
$mailData = array();
|
||||
json_encode(maskOutputFields($config),JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
|
||||
|
||||
// --- POST DATA ---
|
||||
|
||||
@ -560,17 +495,15 @@
|
||||
|
||||
// Assumes that config.json file has the correct information for MANDATORY information
|
||||
|
||||
// DEFAULTS
|
||||
$problemData['eventId'] = 0;
|
||||
$problemData['duration'] = 0;
|
||||
|
||||
// MANDATORY
|
||||
$problemData['eventId'] = 0;
|
||||
|
||||
$problemData['recipient'] = $config['cli_recipient'];
|
||||
$problemData['baseURL'] = $config['cli_baseURL'];
|
||||
$problemData['duration'] = $config['cli_duration'];
|
||||
|
||||
// OPTIONAL
|
||||
if (isset($config['cli_eventId'])) { $problemData['eventId'] = $config['cli_eventId']; }
|
||||
if (isset($config['cli_duration'])) { $problemData['duration'] = $config['cli_duration']; }
|
||||
if (isset($config['cli_subject'])) { $problemData['subject'] = $config['cli_subject']; }
|
||||
if (isset($config['cli_period'])) { $problemData['period'] = $config['cli_period']; }
|
||||
if (isset($config['cli_period_header'])) { $problemData['period_header'] = $config['cli_period_header']; }
|
||||
@ -614,7 +547,6 @@
|
||||
$cCRLF.json_encode($problemData,JSON_PRETTY_PRINT|JSON_NUMERIC_CHECK));
|
||||
|
||||
// --- CHECK AND SET P_ VARIABLES ---
|
||||
|
||||
// FROM POST OR CLI DATA
|
||||
|
||||
if (!isset($problemData['eventId'])) { echo "Missing EVENT ID?\n"; die; }
|
||||
@ -623,8 +555,8 @@
|
||||
if (!isset($problemData['recipient'])) { echo "Missing RECIPIENT?\n"; die; }
|
||||
$p_recipient = $problemData['recipient'];
|
||||
|
||||
$p_duration = 0;
|
||||
if (isset($problemData['duration'])) { $p_duration = intval($problemData['duration']); }
|
||||
if (!isset($problemData['duration'])) { echo "Missing DURATION?\n"; die; }
|
||||
$p_duration = intval($problemData['duration']);
|
||||
|
||||
if (!isset($problemData['baseURL'])) { echo "Missing URL?\n"; die; }
|
||||
$p_URL = $problemData['baseURL'];
|
||||
@ -664,10 +596,6 @@
|
||||
$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']; }
|
||||
|
||||
@ -698,9 +626,6 @@
|
||||
$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
|
||||
@ -714,7 +639,7 @@
|
||||
$z_tmp_cookies = $z_path.'tmp/';
|
||||
$z_log_path = $z_path.'log/';
|
||||
|
||||
// If tmp, log, or images does not exist, create them
|
||||
// If tmp or log does not exist, create them
|
||||
if (!is_dir($z_tmp_cookies))
|
||||
{
|
||||
mkdir($z_tmp_cookies);
|
||||
@ -727,19 +652,6 @@
|
||||
_log('+ created LOG directory "'.$z_log_path.'"');
|
||||
}
|
||||
|
||||
if (!is_dir($z_images_path))
|
||||
{
|
||||
mkdir($z_images_path);
|
||||
_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'];
|
||||
@ -778,6 +690,8 @@
|
||||
// Fetch information via API ////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
$mailData = array();
|
||||
|
||||
$mailData['BASE_URL'] = $p_URL;
|
||||
$mailData['SUBJECT'] = $p_subject;
|
||||
|
||||
@ -785,8 +699,6 @@
|
||||
// --- LOGIN ---
|
||||
// -------------
|
||||
|
||||
// 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',
|
||||
@ -810,13 +722,6 @@
|
||||
}
|
||||
|
||||
_log('> Token = '.$token);
|
||||
} else {
|
||||
if ($cDebug) {
|
||||
_log('# Using API bearer token authentication to access Zabbix');
|
||||
}
|
||||
|
||||
$token = '';
|
||||
}
|
||||
|
||||
// -----------------------
|
||||
// --- LOG API VERSION ---
|
||||
@ -832,7 +737,6 @@
|
||||
$result = postJSON($z_url_api, $request);
|
||||
|
||||
$apiVersion = $result['result'];
|
||||
$apiVersionMajor = substr($apiVersion,0,01);
|
||||
|
||||
_log('> API version '.$apiVersion);
|
||||
|
||||
@ -847,15 +751,11 @@
|
||||
$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));
|
||||
|
||||
@ -866,7 +766,7 @@
|
||||
$request = array('jsonrpc'=>'2.0',
|
||||
'method'=>'problem.get',
|
||||
'params'=>array('output'=>'extend',
|
||||
'recent'=>FALSE,
|
||||
'recent'=>'false',
|
||||
'limit'=>1),
|
||||
'auth'=>$token,
|
||||
'id'=>nextRequestID());
|
||||
@ -891,27 +791,14 @@
|
||||
|
||||
_log('# Retreiving EVENT information');
|
||||
|
||||
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'),
|
||||
'selectSuppressionData'=>'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));
|
||||
@ -938,17 +825,6 @@
|
||||
break;
|
||||
}
|
||||
|
||||
// --- Collect and attach acknowledge messages for this event
|
||||
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']);
|
||||
$mailData['ACKNOWLEDGES'][$aCount]['_actions'] = zabbixActionToString($anAck['action']);
|
||||
$mailData['ACKNOWLEDGES'][$aCount]['_old_severity'] = zabbixSeverityToString($anAck['old_severity']);
|
||||
$mailData['ACKNOWLEDGES'][$aCount]['_new_severity'] = zabbixSeverityToString($anAck['new_severity']);
|
||||
}
|
||||
}
|
||||
|
||||
$p_triggerId = $thisEvent['result'][0]['relatedObject']['triggerid'];
|
||||
|
||||
// ------------------------
|
||||
@ -1035,30 +911,18 @@
|
||||
break;
|
||||
|
||||
case 'mailGraph.screen':
|
||||
if ($apiVersionMajor<="5") {
|
||||
$triggerScreen = intval($aTag['value']);
|
||||
_log('+ Trigger screen = '.$triggerScreen);
|
||||
} else {
|
||||
_log('- Trigger screen value ignored');
|
||||
}
|
||||
break;
|
||||
|
||||
case 'mailGraph.screenPeriod':
|
||||
if ($apiVersionMajor<="5") {
|
||||
$triggerScreenPeriod = $aTag['value'];
|
||||
_log('+ Trigger screen period = '.$triggerScreenPeriod);
|
||||
}
|
||||
break;
|
||||
|
||||
case 'mailGraph.screenPeriodHeader':
|
||||
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;
|
||||
}
|
||||
}
|
||||
@ -1104,11 +968,9 @@
|
||||
if (substr($mailData['ITEM_LASTVALUE'],0,5)=='<?xml') { $mailData['ITEM_LASTVALUE'] = '[record]'; }
|
||||
if (substr($mailData['ITEM_PREVIOUSVALUE'],0,5)=='<?xml') { $mailData['ITEM_PREVIOUSTVALUE'] = '[record]'; }
|
||||
|
||||
// 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).' ...'; }
|
||||
}
|
||||
// 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).' ...'; }
|
||||
|
||||
// ---------------------
|
||||
// --- GET HOST INFO ---
|
||||
@ -1338,7 +1200,6 @@
|
||||
|
||||
$result = array();
|
||||
|
||||
if (isset($screenGrahps['result'][0]['screenitems'])) {
|
||||
foreach($screenGraphs['result'][0]['screenitems'] as $anItem)
|
||||
{
|
||||
switch($anItem['resourcetype'])
|
||||
@ -1360,9 +1221,6 @@
|
||||
break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
_log('> No screen items associated to this screen?');
|
||||
}
|
||||
|
||||
// --- Sort the result according to SCREEN x,y position
|
||||
|
||||
@ -1450,7 +1308,7 @@
|
||||
{
|
||||
if ($forceGraph>0)
|
||||
{
|
||||
$theGraph = $forceGraphInfo['result'][0];
|
||||
$theGraph = $forceGraphInfo;
|
||||
$theType = 'Forced';
|
||||
}
|
||||
else
|
||||
@ -1588,12 +1446,6 @@
|
||||
$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 ///////////////////////////////////////////////////////////////////////////////
|
||||
/////////////////////////////////////////////////////////////////////////////////////////////////////////
|
||||
@ -1604,41 +1456,12 @@
|
||||
|
||||
try
|
||||
{
|
||||
// If debugging is required change to '1'
|
||||
$mail->SMTPDebug = 0;
|
||||
|
||||
// Initialize for international characters
|
||||
$mail->CharSet = "UTF-8";
|
||||
$mail->Encoding = "base64";
|
||||
|
||||
// --- 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!="")
|
||||
{
|
||||
@ -1647,6 +1470,14 @@
|
||||
$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);
|
||||
@ -1736,7 +1567,6 @@
|
||||
{
|
||||
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());
|
||||
}
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<zabbix_export>
|
||||
<version>5.4</version>
|
||||
<date>2023-08-16T20:38:38Z</date>
|
||||
<date>2023-07-02T12:48:36Z</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://myzabbix.example.com/</value>
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>duration</name>
|
||||
@ -57,21 +57,10 @@
|
||||
</parameter>
|
||||
<parameter>
|
||||
<name>URL</name>
|
||||
<value>https://myzabbix.com/mailGraph.php</value>
|
||||
<value>https://myzabbix.example.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;
|
||||
}
|
||||
}
|
||||
|
||||
<script>// mailGraph v2.14
|
||||
try {
|
||||
// Pickup parameters
|
||||
params = JSON.parse(value),
|
||||
@ -89,13 +78,21 @@ try {
|
||||
// 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
|
||||
// Pick up relevant fields for mailGraph API level call
|
||||
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!';
|
||||
}
|
||||
@ -121,30 +118,20 @@ try {
|
||||
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 blank the email address is likely incorrect
|
||||
if (resp==null) {
|
||||
throw '[MailGraph Webhook] No response received from mailGraph.php? This should not occur (check URL and your webserver!)';
|
||||
throw '[MailGraph Webhook] No data received from mailGraph! Likely the email processing failed? Check mailGraph logging';
|
||||
}
|
||||
|
||||
if (resp=='') {
|
||||
throw '[MailGraph Webhook] No data received from mailGraph - please check recipient address or mailGraph log and retry.';
|
||||
// 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';
|
||||
}
|
||||
|
||||
// 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
|
||||
// We expect the message id back from the processing script
|
||||
msg = JSON.parse(resp);
|
||||
|
||||
result.tags.__message_id = msg.messageId;
|
||||
@ -155,7 +142,7 @@ try {
|
||||
}
|
||||
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;
|
||||
}</script>
|
||||
@ -183,7 +170,11 @@ Host: {HOST.NAME}
|
||||
Severity: {EVENT.SEVERITY}
|
||||
Operational data: {EVENT.OPDATA}
|
||||
Original problem ID: {EVENT.ID}
|
||||
Trigger ID (/url): {TRIGGER.ID} {TRIGGER.URL}</message>
|
||||
{TRIGGER.URL}
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]</message>
|
||||
</message_template>
|
||||
<message_template>
|
||||
<event_source>TRIGGERS</event_source>
|
||||
@ -195,7 +186,11 @@ Problem duration: {EVENT.DURATION}
|
||||
Host: {HOST.NAME}
|
||||
Severity: {EVENT.SEVERITY}
|
||||
Original problem ID: {EVENT.ID}
|
||||
Trigger ID: {TRIGGER.ID} {TRIGGER.URL}</message>
|
||||
{TRIGGER.URL}
|
||||
|
||||
eventId: {EVENT.ID}
|
||||
TriggerId: {TRIGGER.ID}
|
||||
itemId: {ITEM.ID]</message>
|
||||
</message_template>
|
||||
<message_template>
|
||||
<event_source>TRIGGERS</event_source>
|
||||
@ -206,8 +201,9 @@ Trigger ID: {TRIGGER.ID} {TRIGGER.URL}</message>
|
||||
|
||||
Current problem status is {EVENT.STATUS}, age is {EVENT.AGE}, acknowledged: {EVENT.ACK.STATUS}.
|
||||
|
||||
Event ID: {EVENT.ID}
|
||||
Trigger ID: {TRIGGER.ID}</message>
|
||||
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,18 +112,6 @@
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{% if ACKNOWLEDGES|length > 0 %}
|
||||
<br/>
|
||||
{% for anAck in ACKNOWLEDGES %}
|
||||
<table style="border:0; text-align:left;" cellpadding="5" cellspacing="0">
|
||||
<tr>
|
||||
<td class="acknowledge">
|
||||
<b>{{ anAck._clock }}</b><br/><em>({{ anAck.username }}, {{ anAck.name }} {{ anAck.surname }})</em><br/>[{{ anAck._actions }}]<br/>{{ anAck.message }}
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -135,8 +120,7 @@
|
||||
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 %}
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user