83618178f0
* Use data frames for numeric data * Use data frames for text data * Use data frames for IT services * fix multiple series * Convert to the wide format if possible * Fix table format for text data * Add refId to the data frames * Align time series from Zabbix API * Fill gaps with nulls * Fix moving average functions * Option for disabling data alignment * remove unused logging * Add labels to data frames * Detect units * Set min and max for if percent unit used * Use value mapping from Zabbix * Rename unitConverter -> convertZabbixUnit * More units * Add missing points in front of each series * Fix handling table data * fix db connector data frames handling * fix it services data frames handling * Detect all known grafana units * Chore: remove unused logging * Fix problems format * Debug logging: show original units * Add global option for disabling data alignment * Add tooltip for the disableDataAlignment feature * Add note about query options * Functions for aligning timeseries on the backend
120 lines
5.6 KiB
Markdown
120 lines
5.6 KiB
Markdown
page_title: Grafana-Zabbix Configuration
|
|
page_description: Plugin configuration instructions for Grafana-Zabbix.
|
|
|
|
# Configuration
|
|
|
|
## Enable plugin
|
|
Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_
|
|
tab and enable plugin.
|
|
|
|
|
|
|
|
## Configure Zabbix data source
|
|
After enabling plugin you can add Zabbix data source.
|
|
|
|
To add new Zabbix data source open _Data Sources_ in side panel, click _Add data source_ and
|
|
select _Zabbix_ from dropdown list.
|
|
|
|
|
|
|
|
### HTTP settings
|
|
|
|
- **Url**: set Zabbix API url (full path with `api_jsonrpc.php`).
|
|
- **Access**:
|
|
- **Proxy**: access via Grafana backend
|
|
- **Direct**: access from browser.
|
|
- **Http Auth**: configure if you use proxy authentication.
|
|
- **Basic Auth**:
|
|
- **With Credentials**:
|
|
|
|
Proxy access means that the Grafana backend will proxy all requests from the browser, and send them on to the Data Source. This is useful because it can eliminate CORS (Cross Origin Site Resource) issues, as well as eliminate the need to disseminate authentication details to the Data Source to the browser.
|
|
|
|
Direct access is still supported because in some cases it may be useful to access a Data Source directly depending on the use case and topology of Grafana, the user, and the Data Source.
|
|
|
|
### Zabbix API details
|
|
|
|
- **User** and **Password**: setup login for access to Zabbix API. Also check user's permissions
|
|
in Zabbix if you can't get any groups and hosts in Grafana.
|
|
- **Trends**: enable if you use Zabbix 3.x or patch for trends
|
|
support in Zabbix 2.x ([ZBXNEXT-1193](https://support.zabbix.com/browse/ZBXNEXT-1193)). This option
|
|
strictly recommended for displaying long time periods (more than few days, depending of your item's
|
|
updating interval in Zabbix) because few days of item history contains tons of points. Using trends
|
|
will increase Grafana performance.
|
|
- **After**: time after which trends will be used.
|
|
Best practice is to set this value to your history storage period (7d, 30d, etc). Default is **7d** (7 days).
|
|
You can set the time in Grafana format. Valid time specificators are:
|
|
- **h** - hours
|
|
- **d** - days
|
|
- **M** - months
|
|
- **Range**: Time range width after which trends will be used instead of history.
|
|
It's better to set this value in range of 4 to 7 days to prevent loading large amount of history data.
|
|
Default is 4 days.
|
|
- **Cache TTL**: plugin caches some api requests for increasing performance. Set this
|
|
value to desired cache lifetime (this option affect data like items list).
|
|
|
|
### Direct DB Connection
|
|
|
|
Direct DB Connection allows plugin to use existing SQL data source for querying history data directly from Zabbix
|
|
database. This way usually faster than pulling data from Zabbix API, especially on the wide time ranges, and reduces
|
|
amount of data transferred.
|
|
|
|
Read [how to configure](./direct_db_datasource) SQL data source in Grafana.
|
|
|
|
- **Enable**: enable Direct DB Connection.
|
|
- **Data Source**: Select Data Source for Zabbix history database.
|
|
- **Retention Policy** (InfluxDB only): Specify retention policy name for fetching long-term stored data. Grafana will fetch data from this retention policy if query time range suitable for trends query. Leave it blank if only default retention policy used.
|
|
|
|
#### Supported databases
|
|
|
|
**MySQL**, **PostgreSQL**, **InfluxDB** are supported as sources of historical data for the plugin.
|
|
|
|
### Other
|
|
|
|
- **Disable data alignment**: disable time series data alignment. This feature aligns points based on item update interval. For instance, if value collected once per minute, then timestamp of the each point will be set to the start of corresponding minute. This alignment required for proper work of the stacked graphs. If you don't need stacked graphs and want to get exactly the same timestamps as in Zabbix, then you can disable this feature. Also, data alignment can be toggled for each query individually, in the query options.
|
|
|
|
Then click _Add_ - datasource will be added and you can check connection using
|
|
_Test Connection_ button. This feature can help to find some mistakes like invalid user name
|
|
or password, wrong api url.
|
|
|
|
|
|
|
|
## Import example dashboards
|
|
|
|
You can import dashboard examples from _Dashboards_ tab in plugin config.
|
|
|
|
|
|
## Note about Zabbix 2.2 or less
|
|
|
|
Zabbix API (api_jsonrpc.php) before zabbix 2.4 don't allow cross-domain requests (CORS). And you
|
|
can get HTTP error 412 (Precondition Failed).
|
|
To fix it add this code to api_jsonrpc.php immediately after the copyright:
|
|
|
|
```php
|
|
header('Access-Control-Allow-Origin: *');
|
|
header('Access-Control-Allow-Headers: Content-Type');
|
|
header('Access-Control-Allow-Methods: POST');
|
|
header('Access-Control-Max-Age: 1000');
|
|
|
|
if ($_SERVER['REQUEST_METHOD'] === 'OPTIONS') {
|
|
return;
|
|
}
|
|
```
|
|
|
|
before
|
|
|
|
```php
|
|
require_once dirname(__FILE__).'/include/func.inc.php';
|
|
require_once dirname(__FILE__).'/include/classes/core/CHttpRequest.php';
|
|
```
|
|
|
|
[Full fix listing](https://gist.github.com/alexanderzobnin/f2348f318d7a93466a0c).
|
|
For more details see zabbix issues [ZBXNEXT-1377](https://support.zabbix.com/browse/ZBXNEXT-1377)
|
|
and [ZBX-8459](https://support.zabbix.com/browse/ZBX-8459).
|
|
|
|
## Note about Browser Cache
|
|
|
|
After updating plugin, clear browser cache and reload application page. See details
|
|
for [Chrome](https://support.google.com/chrome/answer/95582),
|
|
[Firefox](https://support.mozilla.org/en-US/kb/how-clear-firefox-cache). You need to clear cache
|
|
only, not cookies, history and other data.
|