Added installation docs.
This commit is contained in:
Alexander Zobnin
@@ -1,5 +1,5 @@
|
||||
site_name: Grafana-Zabbix Documentation
|
||||
#site_url: http://docs.grafana.com/
|
||||
#site_url: http://docs.grafana-zabbix.org/
|
||||
#site_url: /
|
||||
site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana
|
||||
repo_url: https://github.com/alexanderzobnin/grafana-zabbix/
|
||||
@@ -8,31 +8,16 @@ copyright: Copyright © 2014-2015, Alexander Zobnin
|
||||
docs_dir: sources
|
||||
theme: readthedocs
|
||||
|
||||
|
||||
pages:
|
||||
- Project:
|
||||
- 'About Grafana-Zabbix': 'index.md'
|
||||
- Installation:
|
||||
- 'Installation': 'installation/index.md'
|
||||
|
||||
# - ['project/cla.md', 'Project', 'Contributor License Agreement']
|
||||
|
||||
# - ['installation/index.md', 'Installation', 'Installation']
|
||||
# - ['installation/troubleshooting.md', 'Installation', 'Troubleshooting']
|
||||
# - ['installation/migrating_to2.md', 'Installation', 'Migrating from v1.x to v2.x']
|
||||
|
||||
# - ['guides/basic_concepts.md', 'User Guides', 'Basic Concepts']
|
||||
# - ['guides/gettingstarted.md', 'User Guides', 'Getting Started']
|
||||
# - ['guides/whats-new-in-v2-6.md', 'User Guides', "What's New in Grafana v2.6"]
|
||||
# - ['guides/whats-new-in-v2-5.md', 'User Guides', "What's New in Grafana v2.5"]
|
||||
# - ['guides/whats-new-in-v2-1.md', 'User Guides', "What's New in Grafana v2.1"]
|
||||
# - ['guides/whats-new-in-v2.md', 'User Guides', "What's New in Grafana v2.0"]
|
||||
# - ['guides/screencasts.md', 'User Guides', 'Screencasts']
|
||||
|
||||
# - ['reference/graph.md', 'Reference', 'Graph Panel']
|
||||
# - ['reference/singlestat.md', 'Reference', 'Singlestat Panel']
|
||||
# - ['reference/table_panel.md', 'Reference', 'Table Panel']
|
||||
# - ['reference/dashlist.md', 'Reference', 'Dashboard List Panel']
|
||||
|
||||
# - ['tutorials/index.md', 'Tutorials', 'Tutorials']
|
||||
# - ['tutorials/hubot_howto.md', 'Tutorials', 'How To integrate Hubot and Grafana']
|
||||
- 'Installation and Configuration': 'installation/index.md'
|
||||
- 'Troubleshooting': 'installation/troubleshooting.md'
|
||||
- User Guides:
|
||||
- 'Getting Started': 'guides/gettingstarted.md'
|
||||
- Reference:
|
||||
- 'Zabbix Datasource': 'reference/datasource-zabbix.md'
|
||||
- 'Triggers Panel': 'reference/panel-triggers.md'
|
||||
- Tutorials:
|
||||
- 'Building Host Dashboard': 'tutorials/host_dashboard.md'
|
||||
|
||||
3
docs/sources/img/installation-add_datasource.png
Normal file
3
docs/sources/img/installation-add_datasource.png
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:62deb035e0d9241c2ae9825b101c86d329766cf421a5e2555449f71420cb9891
|
||||
size 58575
|
||||
3
docs/sources/img/installation-datasource_config.png
Normal file
3
docs/sources/img/installation-datasource_config.png
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:5275ed470657abc2c9c0d648e1a24c0f1b3a029206f8aa9594009b837f3ec2f1
|
||||
size 50282
|
||||
3
docs/sources/img/installation-test_connection.png
Normal file
3
docs/sources/img/installation-test_connection.png
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:767ffe4d4385871847acb9c1b77b42f63144299810c5c97af2eee9057e19c6d7
|
||||
size 12828
|
||||
3
docs/sources/img/installation-test_connection_error.png
Normal file
3
docs/sources/img/installation-test_connection_error.png
Normal file
@@ -0,0 +1,3 @@
|
||||
version https://git-lfs.github.com/spec/v1
|
||||
oid sha256:ee8a5b214d169eb70f8c591cb0e64910b280ce1a8abe1fbf8ee4de26af81a809
|
||||
size 14287
|
||||
@@ -6,7 +6,7 @@ page_description: Introduction to Grafana-Zabbix.
|
||||
Grafana-Zabbix is a plugin bundle for Grafana allowing to visualize monitoring data from Zabbix
|
||||
and create dashboards for analyzing metrics and realtime monitoring.
|
||||
|
||||
## Community resources, feedback, and support
|
||||
## Community Resources, Feedback, and Support
|
||||
|
||||
Thousands of organizations large and small rely on Grafana, and we have a vibrant and active community that constantly inspires us.
|
||||
|
||||
|
||||
@@ -1,2 +1,118 @@
|
||||
page_title: About Grafana-Zabbix
|
||||
page_description: Introduction to Grafana-Zabbix.
|
||||
page_title: Grafana-Zabbix Installation
|
||||
page_description: Installation instructions for Grafana-Zabbix.
|
||||
|
||||
# Installation
|
||||
Download [latest release](https://github.com/alexanderzobnin/grafana-zabbix/releases/latest)
|
||||
for relative Grafana version or just clone a repo:
|
||||
```
|
||||
git clone https://github.com/alexanderzobnin/grafana-zabbix.git
|
||||
```
|
||||
|
||||
## Copy into plugins directory
|
||||
Copy content of `plugins` into your grafana plugins directory (default `/var/lib/grafana/plugins`
|
||||
if your installing grafana with package).
|
||||
Restart grafana-server and the plugin should be automatically detected and used.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/alexanderzobnin/grafana-zabbix.git
|
||||
cp -r ./grafana-zabbix/plugins/* /your/grafana/plugins/directory/
|
||||
sudo service grafana-server restart
|
||||
```
|
||||
|
||||
|
||||
## Use directory of your choice
|
||||
|
||||
By this way you can update plugin by simple `git pull` command.
|
||||
|
||||
Edit your grafana.ini config file (Default location is at `/etc/grafana/grafana.ini`)
|
||||
and add paths to plugins:
|
||||
|
||||
```ini
|
||||
[plugin.zabbix]
|
||||
path = /home/your/clone/dir/plugins/datasource-zabbix
|
||||
|
||||
[plugin.triggers]
|
||||
path = /home/your/clone/dir/plugins/panel-triggers
|
||||
```
|
||||
|
||||
Note that if you copy it into the grafana plugins directory you do not need to add the above
|
||||
config option. That is only
|
||||
if you want to place the plugin in a directory outside the standard plugins directory.
|
||||
Be aware that grafana-server
|
||||
needs read access to the directory.
|
||||
|
||||
# Configuration
|
||||
|
||||
To add new Zabbix data source open _Data Sources_ in side panel, click _Add new_ and select Zabbix
|
||||
from dropdown list.
|
||||
|
||||
|
||||
|
||||
Then configure a data source
|
||||
|
||||
|
||||
|
||||
### Http settings
|
||||
|
||||
- **Url**: set Zabbix API url (full path with `api_jsonrpc.php`).
|
||||
- **Access**: can be either _proxy_ or _direct_.
|
||||
- **Http Auth**: configure if you use proxy authentication.
|
||||
- **Basic Auth**:
|
||||
- **With Credentials**:
|
||||
|
||||
### Zabbiz 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
|
||||
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.
|
||||
- **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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
5
docs/sources/installation/troubleshooting.md
Normal file
5
docs/sources/installation/troubleshooting.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Troubleshooting
|
||||
See [Grafana troubleshooting](http://docs.grafana.org/installation/troubleshooting/) for general
|
||||
connection issues. If you have a problem with Zabbix datasource, you should open
|
||||
a [support issue](https://github.com/alexanderzobnin/grafana-zabbix/issues). Before you do that
|
||||
please search the existing closed or open issues.
|
||||
Reference in New Issue
Block a user