66 Commits

Author SHA1 Message Date
moudsen
8597658670 v1.31 updates 2021-10-06 13:54:11 +02:00
Mark Oudsen
b7e2062486 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-10-06 11:15:33 +02:00
Mark Oudsen
2955ffc404 (v1.31) Removal of trival errors and fix for 'json error' messages in Zabbix on clean install and default PHP settings 2021-10-06 11:15:17 +02:00
moudsen
2976a4af9c Fixed a bug when configuration file is empty 2021-07-17 23:45:50 +02:00
moudsen
2882367308 Minor bugfixes notification (fixed in current v1.29) 2021-07-07 19:54:46 +02:00
moudsen
8b4885038a Minor bugfix where HTTPProxy variable was not picked up correctly due to type 2021-07-07 19:39:02 +02:00
moudsen
f541719fbe Added example to show how Zabbix Media Type configuration looks like 2021-07-07 12:37:01 +02:00
Mark Oudsen
9edab245d8 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-07-05 22:47:37 +02:00
Mark Oudsen
341bd561ab Now shows mailGraph version when invoked from CLI (for testing) 2021-07-05 22:47:05 +02:00
moudsen
e2f657f3dd Updated to v1.29 2021-04-03 16:31:10 +02:00
Mark Oudsen
82a8fe4121 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-04-03 16:29:40 +02:00
Mark Oudsen
bee76b63c0 Bugfix - Stricter JSONRPC version check by Zabbix (v1.29) 2021-04-03 16:29:26 +02:00
moudsen
ba0d474bdb Update README.md 2021-03-24 12:35:49 +01:00
moudsen
a5a0f0ace1 Update README.md 2021-03-24 12:34:34 +01:00
moudsen
8655d4ca2c Updated to v1.28 2021-03-24 12:33:10 +01:00
moudsen
76321be3f8 Update README.md 2021-03-24 12:28:39 +01:00
Mark Oudsen
9d4f00ce87 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-24 12:27:54 +01:00
Mark Oudsen
1278d43acb Added ability to specify SMTP username/password (v1.28) 2021-03-24 12:27:44 +01:00
moudsen
18c22abf17 Updated to v1.27 2021-03-20 14:09:51 +01:00
moudsen
0a623f3137 Updated to v1.27 2021-03-20 14:08:57 +01:00
Mark Oudsen
634134b423 Ability to add additional grapgs through Tagging of Trigger of Host and associate Template update (v1.27) 2021-03-20 14:06:08 +01:00
Mark Oudsen
58668311ee Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-19 12:22:15 +01:00
Mark Oudsen
9052b71562 Bug fixes after refactoring in v1.25, maskerading usernames/passwords in logging (v1.26) 2021-03-19 12:22:01 +01:00
moudsen
74b6ee15c7 v1.26 released 2021-03-19 12:05:35 +01:00
Mark Oudsen
398637e582 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-19 12:01:50 +01:00
Mark Oudsen
9e40060cdd Bug fixes after refactoring in v1.25, maskerading usernames/passwords in logging (v1.26) 2021-03-19 12:01:41 +01:00
moudsen
e85400b0de Update README.md 2021-03-17 14:03:15 +01:00
Mark Oudsen
e05fcbfba7 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-17 13:57:34 +01:00
Mark Oudsen
66b504a66c Refactoring for optimized flow and relevant data retrieval (v1.25) 2021-03-17 13:57:25 +01:00
moudsen
bc0c83b544 Update README.md 2021-03-17 13:07:08 +01:00
Mark Oudsen
17cdbea2bd Refactoring for optimized flow and relevant data retrieval (v1.25) 2021-03-17 13:03:54 +01:00
Mark Oudsen
fb51354649 Added ability to configure HTTP proxy (v1.24) 2021-03-12 16:33:44 +01:00
Mark Oudsen
78061964c4 Added ability to configure HTTP proxy (v1.24) 2021-03-12 16:23:47 +01:00
Mark Oudsen
1c9786c549 Bugfix (v1.23) 2021-03-12 15:41:48 +01:00
Mark Oudsen
37b1ea7ea2 Added Stacked,Pie and Exploded graph type support (v1.23) 2021-03-12 15:38:46 +01:00
moudsen
cb96ecaf24 Update README.md
Moved most of README to Wiki for purpose of better documentation.
2021-03-10 21:48:30 +01:00
Mark Oudsen
71df37e612 Renewed example image (v1.22) 2021-03-10 21:47:06 +01:00
moudsen
e861d0c7d0 Delete Example-mail-message.png 2021-03-10 21:43:59 +01:00
moudsen
73ce4adb9c Update README.md 2021-03-10 21:40:40 +01:00
Mark Oudsen
e262f21dc8 Added ability to embed multiple periods of the same graph (v1.22) 2021-03-10 19:57:42 +01:00
moudsen
7f6d5ccd03 Update README.md 2021-03-10 19:34:15 +01:00
moudsen
162bf1b932 Update README.md 2021-03-10 18:22:35 +01:00
Mark Oudsen
6ff6a2c55d Optimized grapg.get and minor bugfixes (v1.21) 2021-03-09 10:21:06 +01:00
moudsen
7ee5324aeb Update README.md 2021-03-09 10:19:03 +01:00
moudsen
88d8c018f5 Update README.md 2021-03-07 22:36:40 +01:00
Mark Oudsen
b7935b0a47 Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-07 22:21:59 +01:00
Mark Oudsen
d624fa694d Revised html template to be responsive. Leaving beta mode! (v1.20) 2021-03-07 22:21:38 +01:00
moudsen
7c4d8a7ff8 Update README.md 2021-03-05 13:44:10 +01:00
moudsen
1a82a1ac85 Update README.md 2021-03-05 13:10:39 +01:00
Mark Oudsen
5797538519 Several enhancements and bugfixes - getting ready for v1.20 release (v1.19) 2021-03-05 11:57:01 +01:00
moudsen
0c7d577975 Update README.md 2021-03-05 10:25:19 +01:00
moudsen
497e7c3fe9 Update README.md
v1.18 and v1.19 updates refllected in the READ.ME.
Considering to move part of the work into the Wiki section while progressing towards the next milestone release (v1.20).
2021-03-05 10:22:37 +01:00
moudsen
fd48cb604e Update README.md 2021-03-04 14:32:07 +01:00
Mark Oudsen
f2075d161d Merge branch 'main' of github.com:moudsen/mailGraph into main 2021-03-04 14:29:50 +01:00
Mark Oudsen
2970f10be1 Added Tag processing for Triggers to set period or force different graph to be displayed (v1.18) 2021-03-04 14:29:35 +01:00
moudsen
e3913d9813 Update README.md 2021-03-03 23:29:34 +01:00
Mark Oudsen
c0e31d37be Added ability to specify the period of the graph (v1.17) 2021-03-03 23:26:35 +01:00
Mark Oudsen
42bea0df98 Fixed graph.get issue with workaround; several bugfixes and enhancements (v1.16) 2021-03-02 23:17:03 +01:00
moudsen
cb8d2cb546 Update README.md 2021-03-01 20:27:13 +01:00
Mark Oudsen
2808544170 Revised way of identifying graphs that can be embedded (v1.15)[5] 2021-03-01 20:22:42 +01:00
Mark Oudsen
995fdf0b68 Added ability to apply non-strict SSL email transportation (v1.14) 2021-03-01 19:51:11 +01:00
Mark Oudsen
db81193e17 Added transport none,ssl,tls to config.json as smtp_transport (v1.13) 2021-03-01 18:36:28 +01:00
Mark Oudsen
1fb10ed089 smtp server configuration via config.json - fixed config template bug (v1.12) 2021-03-01 18:13:32 +01:00
moudsen
7e1c5e5d98 Update README.md 2021-03-01 17:48:41 +01:00
moudsen
4f4c41f991 Merge pull request #4 from moudsen/add-code-of-conduct-1
Create CODE_OF_CONDUCT.md
2021-02-28 22:17:32 +01:00
moudsen
15512cf35a Create CODE_OF_CONDUCT.md 2021-02-28 22:16:46 +01:00
13 changed files with 1288 additions and 514 deletions

49
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,49 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at abuse@puzzl.nl. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

176
README.md
View File

@@ -1,165 +1,27 @@
# mailGraph
## Minor bugfixes to the code (2021/10/06)
Code improvements to prevent possible errors leading into a non-functional mailGraph ... (typical error within log or Zabbix: "json error").
Please inform me (raise an issue) in case you have PHP related errors in your logs - this should no longer be the case with v1.31.
## mailGraph (v1.31)
Zabbix Media module and scripts for sending e-mail alerts with graphs.
[![](images/Example-mail-message.png?raw=true)](images/Example-mail-message.png)
**Please use the Wiki for information on how to install, configure and use MailGraph in Zabbix**
# WORK IN PROGRESS
Although still under development (consider the current releases "beta"), I need feedback and interaction with other users of Zabbix that are looking for the functionality I've developed hence I'm releasing my code to the world.
## UPGRADE NOTES
### v1.31
Updated: mailGraph.pgp - Bugfixes and c
**List of item to-do**
1. Resolve macro information => _DROPPED_: Found out during development and testing this may expose sensitive information over the e-mail hence decided to drop this; clicking the EVENT DETAILS link takes any receiver to the corresponding Zabbix page.
2. Passing dynamic parameters via the Webhook for template/output usage => WORK IN PROGRESS, release 1.20
3. Finding "beta testers" to assist me in further enhancing the use cases => awaiting the first users/feedback!
4. Adding parameters to configure SwitftMailer configuration. Currently mailGraph assumes you have a localhost capable of processing the mail. => WORK IN PROGRESS, release 1.20
### v1.29
Updated: mailGraph.php
# Zabbix enhancements
https://support.zabbix.com/browse/ZBXNEXT-6534
Main ticket asking how to get this Media type onboarded in the Media type section of the manual and the associated Zabbix GitHub directory.
### 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 ...).
https://support.zabbix.com/browse/ZBXNEXT-6535
One of the major items that needs to be tackled is to resolve Macros that are in names, descriptions, etc. As this does work for the Trigger and TriggerPrototype I've examined the Zabbix source code and from here I would say it's quite "easy" to add the "expandXXX" flags to other types as well (found many existing functions to perform this).
I'm adding this to my testlab setup for Item and ItemPrototype and will share the outcome. If it is succesfull I will also arrange for other types (like Host) eventually giving back the additional code lines to Zabbix for incorporation into a release.
### 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).
# Installation pre-requisites
The suggested installation path of this script is on the same host where Zabbix lives but outside the actual Zabbix directory, although it is possible to run the script entirely somewhere else (the code is webhook based, picking up information from Zabbix is via the front-end login and API).
## Example message
The below message is just an example of what MailGraph is capable of. The template engine used ("Twig") allows for a fully customized message creation to your needs!
I've tested my code with Zabbix 5.0.5 (LTS). Not sure if it can/will run in any versions under 5.
# I'm assuming
- You are familiar with "composer"
- You know how to configure and secure a webserver/virtual host
- That you have CURL and PHP installed
# Prepare the installation
- Download or clone this repository
- Pick a directory within a (virtual) host of your webserver
- Create the directories "config", "images", "log", "templates" and "tmp" inside this directory
- Copy .htaccess to the main directory _(if not using Apache make sure your webserver denies http access to /config!)_
- Copy mailGraph.php to the main directory
- Install SwiftMailer: `composer require swiftmailer/swiftmailer`
- Install TWIG: `composer require twig/twig`
- Copy config/config.php to your /config directory
- Copy config/config.json.template to your /config/ directory and rename to "config.json" (we will configure in the next step)
- Copy templates/html.template and templates/plain.template to your templates directory
- Copy mailGraph.xml to a location where you can upload the Media Type to Zabbix (we will load into / configure in Zabbix in the next steps)
# Configuration
- Goto your /config directory
- Two ways to configure the config.json file: 1) with config.php or 2) with your favorite text editor (note that you must have knowledge of JSON format to use this option)'
- List the available configuration options with "php config.php config.json list"
- Change any option with "php config.php config.json replace 'key_name' 'new_value'" (note the usage of the single quotes from the command-line!)
**"script_baseurl"** should point to the URL of your directory where MailGraph is installed (ie. "https://mydomain.com/"). Note the ending '/'!
**"zabbix_user"** and **zabbix_user_pwd** must be a Zabbix SuperAdmin user/password you need to have/create to login to Zabbix (this is for grabbing the images via the regular Zabbix routines).
**"zabbix_user_api"** and **zabbix_user_pwd** must also be a Zabbix SuperAdmin user/password you need to have/create to login to the Zabbix API (this is for grabbing the information of the event via the Zabbix API).
**"mail_from"** must be a valid e-mail address which represents the 'from' address in the mails that are sent (ie. "zabbix.mailgraph.noreply@domain.com") that is acceptable by your mail server.
# Load the Media Type "MailGraph" into Zabbix
- Login to your Zabbix instance
- Goto "Administration" => "Media yypes"
- Import the "mailGraph.xml" file
- Edit the new media type
- Configure some of the macros associated
"baseURL" must contain your Zabbix URL (ie. "https://mydomain.com/zabbix/"). Note the ending '/'!
You can set your custom "graphWidth" and "GraphHeight" to your convenience.
You can switch the graph legend on/off with "showLegend" (0=off,1=on).
You can change the "subject" of the e-mail that is sent (note that the markup can be a combination of Zabbix MACRO or TWIG notation!).
"URL" is the url to the mailGraph script (ie. "https://mydomain.com/mailGraph.php").
# Actions configuration
At this point the Media type is ready for configuration under "actions" as per the regular way of Zabbix alert processing. Please refer to the manual how to configure.
# Template adjustments
I've picked TWIG as the template processor, where the following macros are available for your convenience. Feel free to adjust the html.template and plain.template files as you see fit for your situation!
Values available:
{{ baseURL }} - base url of the Zabbix system (use for references to API and login)
{{ TRIGGER_ID }} - id of the applicable trigger
{{ TRIGGER_DESCRIPTION }} - raw trigger description (note: macros are not parsed!)
{{ TRIGGER_COMMENTS }} - comments of the trigger
{{ TRIGGER_URL }} - url of the trigger form
{{ ITEM_ID }} - id of the associated item to the trigger
{{ ITEM_KEY }} - key of the item
{{ ITEM_NAME }} - item name
{{ ITEM_DESCRIPTION }} - description of the item
{{ ITEM_LASTVALUE }} - last value of the item
{{ ITEM_PREVIOUSVALUE }} - the value of the before LASTVALUE
{{ ITEM_URL }} - url of the item form
{{ HOST_ID }} - id of the associated host to the item
{{ HOST_NAME }} - name of the host
{{ HOST_ERROR }} - last error state of the applicable host
{{ HOST_DESCRIPTION }} - description of the host
{{ HOST_URL }} - url of the host form
{{ EVENT_ID }} - id of the associated event
{{ EVENT_NAME }} - name of the event (note: macros are parsed!)
{{ EVENT_OPDATA }} - associated operational data of the vent
{{ EVENT_VALUE }} - event state (0=Recovered, 1=Triggered/Active)
{{ EVENT_SEVERITY }} - severity of the event
{{ EVENT_STATUS }} - status of the event
{{ EVENT_URL }} - url of the event details
{{ GRAPH_ID }} - id of the (first) associated graph that contains the item
{{ GRAPH_NAME }} - name of this graph
{{ GRAPH_URL }} - URL to this graph (assuming script produces to an accessible location)
{{ GRAPH_CID }} - IMG embed string (<img src="{{ GRAPH_CID }}" />)
{{ LOG_HTML }} - script log in HTML format
{{ LOG_PLAIN }} - script log in PLAIN text format
# Troubleshooting
In general if something goes wrong (no output), use the following sequence to identify where the error has occured (and raise an issue in this repository so I can take a look at it):
- Goto Zabbix => Reports => Action Log and search for events with Status "Failed"
- Note the itemId, triggerId and eventId from this event for testing the Media Type manually
- If the popup message says "Syntax Error" something went wrong with the processing during the script. In this case you have to investigate a bit more what is happening.
The easiest way to test what is happening is to now goto Administration => Media types and hit the "Test" at the right hand side for MailGraph.
- Replace relevant macros with information (eventId, triggerId, itemId, recipient, baseUrl and URL) and hit "Test"
- The last line in the result will tell you what the problem is (most likely an access or connectivity issue)
- Fix accordingly and retry
To facilitate troubleshooting, you can (at code level):
- switch on $cDebugMail to receive processing logs as attachment of an e-mail message
- store logs in the /log directory when $cDebug is switched on
In case of an issue that happens before an e-mail is sent, you can also perform a CLI based test:
- php mailGraph.php test
Note that you have to set the configuration items starting with "cli" in config.json with actual values from a previous message to make this work!
Last resort is to raise an issue in this repository and I will try to assist as soon as possible to fix it.
[![](images/Example-mail-message-v122.png?raw=true)](images/Example-mail-message-v122.png)

View File

@@ -1,16 +1,28 @@
{
"script_baseurl": "https:\/\/domain.com\/",
"script_baseurl": "https:\/\/mydomain.com\/",
"cli_itemId": 0,
"cli_triggerId": 0,
"cli_eventId": 0,
"cli_eventValue": 0,
"cli_duration": 0,
"cli_recipient": "recipient@domain.com",
"cli_subject": "\"{{ HOST_NAME }}\": ({{ EVENT_SEVERITY }}) {{ EVENT_NAME }}"
"cli_baseURL": "https:\/\/domain.com\/zabbix\/",
"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_user": "alogicalusername",
"zabbix_api_pwd": "astrongpassword",
"mail_from": "sender@domain.com"
"mail_from": "sender@mydomain.com",
"subject": "{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
"smtp_server": "localhost",
"smtp_port": 25,
"smtp_transport": "none",
"smtp_strict": "yes",
"graph_match": "any",
"period": "20m",
"period_header": "Last 20 minutes",
"debug": 0
}

View File

@@ -0,0 +1,28 @@
{
"script_baseurl": "https:\/\/mydomain.com\/",
"cli_itemId": 0,
"cli_triggerId": 0,
"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_periods": "10m,4h,2d,7d",
"cli_periods_headers": "Last 10 minutes,Last 4 hours,Last 2 days,Last 7 days",
"cli_debug": 1,
"cli_proxy": "",
"zabbix_user": "alogicalusername",
"zabbix_user_pwd": "astrongpassword",
"zabbix_api_user": "alogicalusername",
"zabbix_api_pwd": "astrongpassword",
"mail_from": "sender@mydomain.com",
"subject": "{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}",
"smtp_server": "localhost",
"smtp_port": 25,
"smtp_transport": "none",
"smtp_strict": "yes",
"graph_match": "any",
"periods": "10m,4h,2d,7d",
"periods_headers": "Last 10 minutes,Last 4 hours,Last 2 days,Last 7 days",
"debug": 0
}

View File

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

View File

@@ -0,0 +1,61 @@
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;
}

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<zabbix_export>
<version>5.0</version>
<date>2021-02-28T20:27:03Z</date>
<date>2021-03-17T12:55:43Z</date>
<media_types>
<media_type>
<name>MailGraph</name>
@@ -9,7 +9,7 @@
<parameters>
<parameter>
<name>baseURL</name>
<value>https://domain.com/zabbix/</value>
<value>https://mydomain.com/zabbix/</value>
</parameter>
<parameter>
<name>duration</name>
@@ -19,10 +19,6 @@
<name>eventId</name>
<value>{EVENT.ID}</value>
</parameter>
<parameter>
<name>eventValue</name>
<value>{EVENT.VALUE}</value>
</parameter>
<parameter>
<name>graphHeight</name>
<value>120</value>
@@ -35,10 +31,22 @@
<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>
@@ -49,66 +57,73 @@
</parameter>
<parameter>
<name>subject</name>
<value>{{ HOST_NAME }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME }}</value>
</parameter>
<parameter>
<name>triggerId</name>
<value>{TRIGGER.ID}</value>
<value>{{ HOST_NAME|raw }}: ({{ EVENT_SEVERITY }}) {{ EVENT_NAME|raw }}</value>
</parameter>
<parameter>
<name>URL</name>
<value>https://domain.com/mailGraph.php</value>
<value>https://mydomain.com/mailGraph.php</value>
</parameter>
</parameters>
<script>try {&#13;
// Pickup parameters&#13;
params = JSON.parse(value),&#13;
req = new CurlHttpRequest(),&#13;
fields = {},&#13;
resp = '',&#13;
result = { tags: {} };&#13;
// Pickup parameters&#13;
params = JSON.parse(value),&#13;
req = new CurlHttpRequest(),&#13;
fields = {},&#13;
resp = '',&#13;
result = { tags: {} };&#13;
&#13;
// Set HTTP proxy if required&#13;
if (typeof params.HTTPProxy === 'string' &amp;&amp; params.HTTPProxy.trim() !== '') { req.setProxy(params.HTTPProxy); }&#13;
// Set HTTP proxy if required&#13;
if (typeof params.HTTPProxy === 'string' &amp;&amp; params.HTTPProxy.trim() !== '') {&#13;
req.setProxy(params.HTTPProxy);&#13;
fields.HTTPProxy = params.HTTPProxy;&#13;
}&#13;
&#13;
// Declare output type&#13;
req.AddHeader('Content-Type: application/json');&#13;
// Declare output type&#13;
req.AddHeader('Content-Type: application/json');&#13;
&#13;
// Must have fields&#13;
fields.itemId = params.itemId;&#13;
fields.triggerId = params.triggerId;&#13;
fields.eventId = params.eventId;&#13;
fields.eventValue = params.eventValue;&#13;
fields.recipient = params.recipient;&#13;
fields.baseURL = params.baseURL;&#13;
fields.duration = params.duration;&#13;
// Must have fields&#13;
fields.itemId = params.itemId;&#13;
fields.eventId = params.eventId;&#13;
fields.recipient = params.recipient;&#13;
fields.baseURL = params.baseURL;&#13;
fields.duration = params.duration;&#13;
&#13;
// Optional fields&#13;
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }&#13;
if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }&#13;
if (typeof params.subject === 'string') { fields.subject = params.subject; }&#13;
if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }&#13;
// Optional fields&#13;
if (typeof params.graphWidth === 'string') { fields.graphWidth = params.graphWidth; }&#13;
if (typeof params.graphHeight === 'string') { fields.graphHeight = params.graphHeight; }&#13;
if (typeof params.subject === 'string') { fields.subject = params.subject; }&#13;
if (typeof params.showLegend === 'string') { fields.showLegend = params.showLegend; }&#13;
if (typeof params.periods === 'string') { fields.periods = params.periods; }&#13;
if (typeof params.periods_headers === 'string') { fields.periods_headers = params.periods_headers; }&#13;
if (typeof params.debug === 'string') { fields.debug = params.debug; }&#13;
&#13;
// Post information to the processing script&#13;
Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));&#13;
var resp = req.Post(params.URL,JSON.stringify(fields));&#13;
Zabbix.Log(4, '[Mailgraph Webhook] Receiving response:' + resp);&#13;
// Add generic fields&#13;
Object.keys(params).forEach(function(key) {&#13;
if (key.substring(0, 4) == 'info') {&#13;
fields[key] = params[key];&#13;
}&#13;
});&#13;
&#13;
// If there was an error, report it&#13;
if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }&#13;
// Post information to the processing script&#13;
Zabbix.Log(4, '[MailGraph Webhook] Sending request: ' + params.URL + '?' + JSON.stringify(fields));&#13;
var resp = req.Post(params.URL,JSON.stringify(fields));&#13;
Zabbix.Log(4, '[Mailgraph Webhook] Receiving response:' + resp);&#13;
&#13;
// We expect the message id back from the processing script&#13;
resp = JSON.parse(resp);&#13;
result.tags.__message_id = resp.messageId;&#13;
// If there was an error, report it&#13;
if (req.Status() != 200) { throw JSON.parse(resp).errors[0]; }&#13;
&#13;
// Pass the result back to Zabbix&#13;
return JSON.stringify(result);&#13;
// We expect the message id back from the processing script&#13;
resp = JSON.parse(resp);&#13;
result.tags.__message_id = resp.messageId;&#13;
&#13;
// Pass the result back to Zabbix&#13;
return JSON.stringify(result);&#13;
}&#13;
catch (error)&#13;
{&#13;
// In case something went wrong in the processing, pass the error back to Zabbix&#13;
Zabbix.Log(127, 'MailGraph notification failed : '+error);&#13;
throw 'MailGraph notification failed : '+error;&#13;
// In case something went wrong in the processing, pass the error back to Zabbix&#13;
Zabbix.Log(127, 'MailGraph notification failed : '+error);&#13;
throw 'MailGraph notification failed : '+error;&#13;
}</script>
<process_tags>YES</process_tags>
<description>The &quot;URL&quot; must point to the location of the processing script. If a proxy is required, define &quot;HTTPProxy&quot; for the proxy address.&#13;
@@ -117,40 +132,12 @@ Customization:&#13;
- &quot;graphWidth&quot; and &quot;graphWidth&quot; can be defined for the image size&#13;
- &quot;showLegend&quot; can be defined to show or hide the legend of the graph&#13;
- &quot;subject&quot; can be defined for a customized subject for the mail message&#13;
- &quot;periods&quot; and &quot;periods_headers&quot; can be defined for displaying multiple periods of the same graph, or&#13;
- &quot;period&quot; and &quot;period_header&quot; can be defined to display a single graph&#13;
&#13;
The html.template and plain.template files can be adjusted (TWIG format).&#13;
&#13;
Values available:&#13;
{{ baseURL }} - base url of the Zabbix system (use for references to API and login)&#13;
{{ TRIGGER_ID }} - id of the applicable trigger&#13;
{{ TRIGGER_DESCRIPTION }} - raw trigger description (note: macros are not parsed!)&#13;
{{ TRIGGER_COMMENTS }} - comments of the trigger&#13;
{{ TRIGGER_URL }} - url of the trigger form&#13;
{{ ITEM_ID }} - id of the associated item to the trigger&#13;
{{ ITEM_KEY }} - key of the item&#13;
{{ ITEM_NAME }} - item name&#13;
{{ ITEM_DESCRIPTION }} - description of the item&#13;
{{ ITEM_LASTVALUE }} - last value of the item&#13;
{{ ITEM_PREVIOUSVALUE }} - the value of the before LASTVALUE&#13;
{{ ITEM_URL }} - url of the item form&#13;
{{ HOST_ID }} - id of the associated host to the item&#13;
{{ HOST_NAME }} - name of the host&#13;
{{ HOST_ERROR }} - last error state of the applicable host&#13;
{{ HOST_DESCRIPTION }} - description of the host&#13;
{{ HOST_URL }} - url of the host form&#13;
{{ EVENT_ID }} - id of the associated event&#13;
{{ EVENT_NAME }} - name of the event (note: macros are parsed!)&#13;
{{ EVENT_OPDATA }} - associated operational data of the vent&#13;
{{ EVENT_VALUE }} - event state (0=Recovered, 1=Triggered/Active)&#13;
{{ EVENT_SEVERITY }} - severity of the event&#13;
{{ EVENT_STATUS }} - status of the event&#13;
{{ EVENT_URL }} - url of the event details&#13;
{{ GRAPH_ID }} - id of the (first) associated graph that contains the item&#13;
{{ GRAPH_NAME }} - name of this graph&#13;
{{ GRAPH_URL }} - URL to this graph (assuming script produces to an accessible location)&#13;
{{ GRAPH_CID }} - IMG embed string (&lt;img src=&quot;{{ GRAPH_CID }}&quot; /&gt;)&#13;
{{ LOG_HTML }} - script log in HTML format&#13;
{{ LOG_PLAIN }} - script log in PLAIN text format</description>
More details are available at https://github.com/moudsen/mailGraph</description>
<message_templates>
<message_template>
<event_source>TRIGGERS</event_source>
@@ -201,4 +188,3 @@ itemId: {ITEM.ID]</message>
</media_type>
</media_types>
</zabbix_export>

View File

@@ -1,74 +1,192 @@
<html lang="en"><head><meta http-equiv=Content-Type content="text/html; charset=UTF-8">
<style>
.Resolved {
background-color:#86cc89;
border:1px solid #57bd5b;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
.Information {
background-color:#7499ff;
border:1px solid #4673f0;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
.Warning {
background-color:#FFC859;
border:1px solid #E69F10;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
.Average {
background-color:#FFA059;
border:1px solid #e66e15;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
.High {
background-color:#E97659;
border:1px solid #E45959;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
.Disaster {
background-color:#E45959;
border:1px solid #DE1E09;
font-family:Tahoma,Geneva,Arial,sans-serif;font-size:14px;
}
body {
font-family: Arial,sans-serif;
}
.Resolved {
background-color:#86cc89;
border:1px solid #57bd5b;
}
.Information {
background-color:#7499ff;
border:1px solid #4673f0;
}
.Warning {
background-color:#FFC859;
border:1px solid #E69F10;
}
.Average {
background-color:#FFA059;
border:1px solid #e66e15;
}
.High {
background-color:#E97659;
border:1px solid #E45959;
}
.Disaster {
background-color:#E45959;
border:1px solid #DE1E09;
}
a {
text-decoration: none;
color: #010059;
}
a:link {
text-decoration: none;
color: #010059;
}
a:visited {
text-decoration: none;
color: #010059;
}
a:active {
text-decoration: none;
color: #010059;
}
hr {
border: none;
height: 1px;
color: #333; /* old IE */
background-color: #333;
}
.MsgBody {
width: 100%;
}
#maintable {
width: 800px;
}
@media screen and (max-width: 800px;) {
#maintable {
width: 100%;
max-width: 790px;
}
#mainimage {
-ms-interpolation-mode: bicubic;
width: 100%;
max-width: 790px;
max-height: 450px;
}
}
.links {
font-size: 9px;
}
.header {
font-size: 16px;
font-weight: bold;
}
.graphHeader {
font-size: 14px;
font-weight: bold;
}
.content {
font-size: 14px;
}
</style>
</head>
<body>
<table style="margin: 10px;border-spacing:0 15px;border-collapse: separate;">
<tr>
<td class="{{ EVENT_SEVERITY }}" style="border-radius:10px;padding: 10px 36px 10px 36px; ">
<table class="{{ EVENT_SEVERITY }}" style="border:0; text-align:left;" cellpadding="0" cellspacing="0">
<tr><td>
<p><b>EVENT INFORMATION</b></p>
Description: <b>{{ EVENT_NAME }}</b><br/>
Host: <b>{{ HOST_NAME }}</b>
<table style="margin: 5px;border-spacing:0 10px;border-collapse: separate;" align=center>
<tr>
<td class="{{ EVENT_SEVERITY }}" style="border-radius:10px;padding:5px 18px 5px 18px; ">
<table class="{{ EVENT_SEVERITY }}" style="border:0; text-align:left;" cellpadding="0" cellspacing="0">
<tr>
<td>
<p><span class="header">EVENT INFORMATION</span></p>
<span class="content">
Description: <b>{{ EVENT_NAME }}</b><br/>
Host: <b>{{ HOST_NAME }}</b>
{% if HOST_ERROR|length > 0 %}
({{ HOST_ERROR }})
({{ HOST_ERROR }})
{% endif %}
<br/>
Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
Status: <b>{{ EVENT_STATUS }}</b><br/>
Severity: <b>{{ EVENT_SEVERITY }}</b><br/>
<br/>
{% if EVENT_OPDATE|length > 0 %}
Operational data: <b>{{ EVENT_OPDATA }}</b><br/>
{% endif %}
Status: <b>{{ EVENT_STATUS }}</b><br/>
Severity: <b>{{ EVENT_SEVERITY }}</b><br/>
{% if EVENT_SEVERITY == "Resolved" %}
Duration: <b>{{ EVENT_DURATION }}</b><br/>
Duration: <b>{{ EVENT_DURATION }}</b><br/>
{% endif %}
Item: <b>{{ ITEM_NAME }}</b><br/>
Previous/Last: {{ ITEM_PREVIOUSVALUE }} ==&gt; {{ ITEM_LASTVALUE }}
<p><a href="{{ EVENTDETAILS_URL }}">Event Details</a><br/></p>
</td></tr>
</table>
</td>
</tr>
{% if GRAPH_CID|length > 0 %}
<tr>
<td align="center"><img src="{{ GRAPH_CID }}" /></td>
</tr>
Item: <b>{{ ITEM_NAME }}</b><br/>
Previous/Last: {{ ITEM_PREVIOUSVALUE }} ==&gt; {{ ITEM_LASTVALUE }}
</span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="links">
<div align=center>
Event ID: <a href="{{ EVENTDETAILS_URL }}">{{ EVENT_ID }}</a> //
Trigger ID: <a href="{{ TRIGGER_URL }}">{{ TRIGGER_ID }}</a> //
Item ID: <a href="{{ ITEM_URL }}">{{ ITEM_ID }}</a> //
Host ID: <a href="{{ HOST_URL }}">{{ HOST_ID }}</a>
{% if GRAPH_ZABBIXLINK|length > 0 %}
// Graph ID: <a href="{{ GRAPH_ZABBIXLINK }}">{{ GRAPH_ID }}</a>
{% endif %}
</table>
<p style="font-size:10px">
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>
</p>
</div>
</td>
</tr>
{% for aGraph in GRAPHS_I %}
<tr>
<div align=justify>
<td align="center">
<span class="graphHeader">{{ aGraph.HEADER }}</span><br/>
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
</td>
</div>
</tr>
{% endfor %}
{% if TRIGGER_SCREEN > 0 %}
<tr>
<div align=justify>
<td align="center">
<span class="graphHeader">{{ GRAPHS_T_HEADER }} - {{ GRAPHS_T_PERIODHEADER }}</span>
</td>
</div>
</tr>
<tr>
<td class="links">
<div align="center">
Screen ID: <a href="{{ GRAPHS_T_LINK }}">{{ TRIGGER_SCREEN }}</a>
</div>
</td>
</tr>
{% for aGraph in GRAPHS_T %}
<tr>
<div align=justify>
<td align="center">
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
</td>
</div>
</tr>
{% endfor %}
{% endif %}
{% if HOST_SCREEN > 0 %}
<tr>
<div align=justify>
<td align="center">
<span class="graphHeader">{{ GRAPHS_H_HEADER }} - {{ GRAPHS_H_PERIODHEADER }}</span>
</td>
</div>
</tr>
<tr>
<td class="links">
<div align="center">
Screen ID: <a href="{{ GRAPHS_H_LINK }}">{{ HOST_SCREEN }}</a>
</div>
</td>
</tr>
{% for aGraph in GRAPHS_H %}
<tr>
<div align=justify>
<td align="center">
<img id="mainimage" border=0 style="width: 100%; max-width: 790px" alt="Zabbix Graph" src="{{ aGraph.CID }}" />
</td>
</div>
</tr>
{% endfor %}
{% endif %}
</table>
</body>
</html>

View File

@@ -3,10 +3,10 @@ EVENT INFORMATION #{{ EVENT_ID }}
Severity: {{ EVENT_SEVERITY }}
Description: {{ EVENT_NAME }}
{% if GRAPH_CID|length > 0 %}
GRAPH #{{ GRAPH_ID }}
{{ GRAPH_URL }}
This graph will remain available for approx. the next 2 weeks only; use HTML reader after this period to view the graph.
{% if GRAPH_CID1|length > 0 %}
GRAPH #{{ GRAPH_ID1 }}
{{ GRAPH_URL1 }}
This graph will remain available for approx. the next 2 weeks only; use HTML reader after this period to view the graph that is embedded in the attached HTML version.
{% endif %}
TRIGGER #{{ TRIGGER_ID }}