diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index a11d346..687e5f6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,7 +3,7 @@ site_name: Grafana-Zabbix Documentation #site_url: / site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana repo_url: https://github.com/alexanderzobnin/grafana-zabbix/ -copyright: Copyright © 2014-2015, Alexander Zobnin +copyright: Copyright © 2015-2016, Alexander Zobnin docs_dir: sources theme: readthedocs @@ -15,6 +15,7 @@ pages: - Installation: - 'Installation': 'installation/index.md' - 'Configuration': 'installation/configuration.md' + - 'Upgrade': 'installation/upgrade.md' - 'Troubleshooting': 'installation/troubleshooting.md' - User Guides: - 'Getting Started': 'guides/gettingstarted.md' diff --git a/docs/sources/img/installation-datasource_config.png b/docs/sources/img/installation-datasource_config.png index 36a86c1..e677be1 100644 --- a/docs/sources/img/installation-datasource_config.png +++ b/docs/sources/img/installation-datasource_config.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:5275ed470657abc2c9c0d648e1a24c0f1b3a029206f8aa9594009b837f3ec2f1 -size 50282 +oid sha256:2a0416ac20486db595be1139671679fc7177e59644f0131027f4843bfa806d71 +size 141448 diff --git a/docs/sources/img/installation-enable_app.png b/docs/sources/img/installation-enable_app.png new file mode 100644 index 0000000..781e297 --- /dev/null +++ b/docs/sources/img/installation-enable_app.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:6c46b44d6db23e898c29e72a3c3df3f36d62d712206b3453c18c173fcbcc5529 +size 139772 diff --git a/docs/sources/img/installation-plugin-dashboards.png b/docs/sources/img/installation-plugin-dashboards.png new file mode 100644 index 0000000..2b82016 --- /dev/null +++ b/docs/sources/img/installation-plugin-dashboards.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:98e41015ed5e6738645065a057af30ce46482ec6797e4cbe85d9990e1fdce5be +size 140142 diff --git a/docs/sources/img/installation-plugins-apps.png b/docs/sources/img/installation-plugins-apps.png new file mode 100644 index 0000000..c931d73 --- /dev/null +++ b/docs/sources/img/installation-plugins-apps.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:fcaa6263d827d3344eb88fec28b1b3b084856af80174551e8c0725c3fd99e982 +size 132477 diff --git a/docs/sources/img/installation-test_connection.png b/docs/sources/img/installation-test_connection.png index 2260793..6543428 100644 --- a/docs/sources/img/installation-test_connection.png +++ b/docs/sources/img/installation-test_connection.png @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:767ffe4d4385871847acb9c1b77b42f63144299810c5c97af2eee9057e19c6d7 -size 12828 +oid sha256:3718e4470b0ac5c2eac5a775cd815ce90db49b8ac2b52414cf019079a6ae022e +size 54039 diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md index 824668d..9ef80e3 100644 --- a/docs/sources/installation/configuration.md +++ b/docs/sources/installation/configuration.md @@ -1,13 +1,21 @@ +page_title: Grafana-Zabbix Configuration +page_description: Plugin configuration instructions for Grafana-Zabbix. + # Configuration -To add new Zabbix data source open _Data Sources_ in side panel, click _Add new_ and select Zabbix -from dropdown list. +## Enable plugin +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 @@ -17,31 +25,32 @@ Then configure a data source - **Basic Auth**: - **With Credentials**: -### Zabbiz API details +### 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 patch for trends -support in Zabbix 2.x ([ZBXNEXT-1193](https://support.zabbix.com/browse/ZBXNEXT-1193)). This is +- **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 -can increase Grafana performance. +will increase Grafana performance. - **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: - **h** - hours - **d** - days - **M** - months -- **Metrics limit**: maximum items number which can be returned by one request. Helps to prevent -Grafana slowdown due wrong request. +- **Cache update interval**: plugin caches some api requests for increasing performance. Set this +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) -This feature can help to find some mistakes like invalid user name or password, wrong api url. - -![Test Connection - Error](../img/installation-test_connection_error.png) - +## Import example dashboards +You can import dashboard examples from _Dashboards_ tab in plugin config. +![Import dashboards](../img/installation-plugin-dashboards.png) ## 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 diff --git a/docs/sources/installation/upgrade.md b/docs/sources/installation/upgrade.md new file mode 100644 index 0000000..ad99dd8 --- /dev/null +++ b/docs/sources/installation/upgrade.md @@ -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.