Merge branch 'docs'

This commit is contained in:
Alexander Zobnin
2016-04-04 23:29:47 +03:00
8 changed files with 50 additions and 21 deletions

View File

@@ -3,7 +3,7 @@ site_name: Grafana-Zabbix Documentation
#site_url: / #site_url: /
site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana
repo_url: https://github.com/alexanderzobnin/grafana-zabbix/ repo_url: https://github.com/alexanderzobnin/grafana-zabbix/
copyright: Copyright © 2014-2015, Alexander Zobnin copyright: Copyright © 2015-2016, Alexander Zobnin
docs_dir: sources docs_dir: sources
theme: readthedocs theme: readthedocs
@@ -15,6 +15,7 @@ pages:
- Installation: - Installation:
- 'Installation': 'installation/index.md' - 'Installation': 'installation/index.md'
- 'Configuration': 'installation/configuration.md' - 'Configuration': 'installation/configuration.md'
- 'Upgrade': 'installation/upgrade.md'
- 'Troubleshooting': 'installation/troubleshooting.md' - 'Troubleshooting': 'installation/troubleshooting.md'
- User Guides: - User Guides:
- 'Getting Started': 'guides/gettingstarted.md' - 'Getting Started': 'guides/gettingstarted.md'

View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1 version https://git-lfs.github.com/spec/v1
oid sha256:5275ed470657abc2c9c0d648e1a24c0f1b3a029206f8aa9594009b837f3ec2f1 oid sha256:2a0416ac20486db595be1139671679fc7177e59644f0131027f4843bfa806d71
size 50282 size 141448

View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:6c46b44d6db23e898c29e72a3c3df3f36d62d712206b3453c18c173fcbcc5529
size 139772

View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:98e41015ed5e6738645065a057af30ce46482ec6797e4cbe85d9990e1fdce5be
size 140142

View File

@@ -0,0 +1,3 @@
version https://git-lfs.github.com/spec/v1
oid sha256:fcaa6263d827d3344eb88fec28b1b3b084856af80174551e8c0725c3fd99e982
size 132477

View File

@@ -1,3 +1,3 @@
version https://git-lfs.github.com/spec/v1 version https://git-lfs.github.com/spec/v1
oid sha256:767ffe4d4385871847acb9c1b77b42f63144299810c5c97af2eee9057e19c6d7 oid sha256:3718e4470b0ac5c2eac5a775cd815ce90db49b8ac2b52414cf019079a6ae022e
size 12828 size 54039

View File

@@ -1,13 +1,21 @@
page_title: Grafana-Zabbix Configuration
page_description: Plugin configuration instructions for Grafana-Zabbix.
# Configuration # Configuration
To add new Zabbix data source open _Data Sources_ in side panel, click _Add new_ and select Zabbix ## Enable plugin
from dropdown list. Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_
tab and enable plugin.
![Add zabbix data source](../img/installation-add_datasource.png) ![Enable Zabbix App](../img/installation-enable_app.png)
Then configure a data source ## Configure Zabbix data source
After enabling plugin you can add Zabbix data source.
![Configure zabbix data source](../img/installation-datasource_config.png) To add new Zabbix data source open _Data Sources_ in side panel, click _Add data source_ and
select _Zabbix_ from dropdown list.
![Configure Zabbix data source](../img/installation-datasource_config.png)
### Http settings ### Http settings
@@ -17,31 +25,32 @@ Then configure a data source
- **Basic Auth**: - **Basic Auth**:
- **With Credentials**: - **With Credentials**:
### Zabbiz API details ### Zabbix API details
- **User** and **Password**: setup login for access to Zabbix API. Also check user's permissions - **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. in Zabbix if you can't get any groups and hosts in Grafana.
- **Trends**: enable if you use patch for trends - **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 is 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 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 updating interval in Zabbix) because few days of item history contains tons of points. Using trends
can increase Grafana performance. will increase Grafana performance.
- **Use trends from**: time after which trends will be used. Default is **7d** (7 days). - **Use trends from**: time after which trends will be used. Default is **7d** (7 days).
You can set the time in Grafana format. Valid time specificators are: You can set the time in Grafana format. Valid time specificators are:
- **h** - hours - **h** - hours
- **d** - days - **d** - days
- **M** - months - **M** - months
- **Metrics limit**: maximum items number which can be returned by one request. Helps to prevent - **Cache update interval**: plugin caches some api requests for increasing performance. Set this
Grafana slowdown due wrong request. value to desired cache lifetime (this option affect data like items list).
Then click _Add_ - datasource will be added and you can check connection using _Test Connection_ button. 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.
![Test Connection](../img/installation-test_connection.png) ![Test Connection](../img/installation-test_connection.png)
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.
![Test Connection - Error](../img/installation-test_connection_error.png) ![Import dashboards](../img/installation-plugin-dashboards.png)
## Note about Zabbix 2.2 or less ## 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 Zabbix API (api_jsonrpc.php) before zabbix 2.4 don't allow cross-domain requests (CORS). And you

View File

@@ -0,0 +1,10 @@
page_title: Grafana-Zabbix Upgrade
page_description: Upgrade instructions for Grafana-Zabbix.
# Upgrade
## Upgrade from 2.x
After [enabling](configuration.md#enable-plugin) Zabbix App go to _Data Sources_, open your configured Zabbix
data source end select _Zabbix_ from _Type_ list again. This is needed because plugin id was changed
in Grafana 3.0.