Zabbix listener
Description
The Zabbix Listener plugin sends metrics from Zabbix into 1Gateway.
Prerequisites
The Zabbix listener plugin uses 2 JSON files called items.json (metrics) and triggers.json (alarms) which includes the definition of the metrics and alarms to be retrieved. If needed, edit this files to include a valid search query.
Installation
Make sure you have the 1gateway zip file that includes the plugin files and valid licences information ready. This file has been provided to you with the installation files.
1 - Login
Login to 1gateway, and make sure you are in "Advanced mode". If this is the first time you log in, the default user and password are both 'admin' (without the quotes).
2 - System Maintenance
Click on the menu icon and choose the option "System maintenance"
3 - Upload file
In the System maintenance view you can either drag and drop the downloaded zip file or select it by clicking the "choose file" button.
4 - Restart
After the upload installation will be confirmed. Restart 1Gateway to ensure any locked files are updated.
Configuration
Open the main menu and click on "New plugin"
Select the plugin you want to configure. Use the Filter field if needed.
Field name | Supported values | Description |
|---|---|---|
Zabbix server | Valid IP address or hostname | Zabbix server |
| Zabbix port number | Valid port number | Port number to use to connect to the Zabbix server |
HTTP username | Any string | HTTP authentication user |
HTTP password | Any string | HTTP authentication password |
Server performance metrics Polling interval | Any integer | Polling interval in seconds (default is 300). For it to work, the Server performance metrics checkbox needs to be ticked |
| Events Polling interval | Any integer | Polling interval in seconds (default is 300). For it to work, the Events checkbox needs to be ticked |
Advanced configuration
The advanced configuration of the Zabbix listener plugin includes the message type of incoming messages from Zabbix to 1Gateway. This message type is used in the mappers used to convert the messages Zabbix sends into normalized formats.
Server performance Metrics
For this to take effect the Server performance metrics checkbox must be checked.
The items JSON path field is the path to the file that defines what to poll from Zabbix.
Field name | Supported values | Description |
|---|---|---|
Items JSON path | Valid path | Path to items JSON file |
Message type | Any string | Message type |
The items.json file contains the body (in JSON) used to poll for metrics.
Events
For this to take effect the Events checkbox must be checked.
The triggers JSON path field is the path to the file that defines what to poll from Zabbix.
Field name | Supported values | Description |
|---|---|---|
Triggers JSON path | Valid path | Path to triggers JSON file |
Message type | Any string | Message type |
| Send events that haven't changed | Checkbox | By default, only changed events (triggers) are fetched from Zabbix, if you enable this checkbox, you get the state for each trigger on each Interval |
The triggers.json file contains the body (in JSON) used to poll for events (triggers).
See also