diff --git a/docs/sources/_index.md b/docs/sources/_index.md index b2f49004..455cafb9 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -1,6 +1,6 @@ --- -title: Grafana Zabbix -menuTitle: About Grafana-Zabbix +title: Grafana Zabbix plugin +menuTitle: Grafana Zabbix plugin description: Introduction to Grafana-Zabbix plugin. aliases: keywords: @@ -13,6 +13,8 @@ labels: weight: 100 --- +# Grafana Zabbix plugin + Grafana-Zabbix is a plugin for Grafana allowing to visualize monitoring data from Zabbix and create dashboards for analyzing metrics and realtime monitoring. Main goals of this project are extend Zabbix capabilities for monitoring data visualization and provide quick and powerful way @@ -45,5 +47,5 @@ Triggers panel was sponsored by [Core IT Project](http://coreit.fr/)). By utilizing this software, you agree to the terms of the included license. Grafana-Zabbix plugin is licensed under the Apache 2.0 agreement. See -[LICENSE](https://github.com/alexanderzobnin/grafana-zabbix/blob/min/LICENSE) for the full +[LICENSE](https://github.com/grafana/grafana-zabbix/blob/main/LICENSE) for the full license terms. diff --git a/docs/sources/configuration/_index.md b/docs/sources/configuration/_index.md index d177cad1..24b4b99e 100644 --- a/docs/sources/configuration/_index.md +++ b/docs/sources/configuration/_index.md @@ -13,6 +13,8 @@ labels: weight: 300 --- +# Configuration + ## Enable plugin Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_ diff --git a/docs/sources/configuration/direct-db-datasource.md b/docs/sources/configuration/direct-db-datasource.md index 474235ac..67648481 100644 --- a/docs/sources/configuration/direct-db-datasource.md +++ b/docs/sources/configuration/direct-db-datasource.md @@ -13,6 +13,8 @@ labels: weight: 310 --- +# Direct DB Data Source Configuration + ## Security notes Grafana-Zabbix plugin can use MySQL, Postgres or InfluxDB (if Zabbix configured to store history data in InfluxDB) data sources to query history and trend data directly from Zabbix database. In order to execute queries, plugin needs only read access to the `history`, `history_uint`, `trends` and `trends_uint` tables. To make connection more secure and prevent unnecessary data disclosure, it's highly recommended to grant read access to only that tables. But if you want to use this data source for querying another data, you can diff --git a/docs/sources/configuration/provisioning.md b/docs/sources/configuration/provisioning.md index 6ece225a..1e0cc502 100644 --- a/docs/sources/configuration/provisioning.md +++ b/docs/sources/configuration/provisioning.md @@ -13,9 +13,11 @@ labels: weight: 320 --- +# Provisioning Grafana-Zabbix plugin + It’s now possible to configure datasources using config files with Grafana’s provisioning system. You can read more about how it works and all the settings you can set for datasources on the [provisioning docs page](http://docs.grafana.org/administration/provisioning/#datasources) -### Example Datasource Config File +## Example Datasource Config File ```yaml apiVersion: 1 diff --git a/docs/sources/configuration/troubleshooting.md b/docs/sources/configuration/troubleshooting.md index 8b08a3d6..d52d8d11 100644 --- a/docs/sources/configuration/troubleshooting.md +++ b/docs/sources/configuration/troubleshooting.md @@ -13,6 +13,8 @@ labels: weight: 330 --- +# 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 diff --git a/docs/sources/features.md b/docs/sources/features.md index 9079eea3..8d228bfc 100644 --- a/docs/sources/features.md +++ b/docs/sources/features.md @@ -13,6 +13,8 @@ labels: weight: 110 --- +# Feature Highlights + Grafana in couple with Grafana-Zabbix plugin allows to create great dashboards. There is some features: diff --git a/docs/sources/guides/gettingstarted.md b/docs/sources/guides/_index.md similarity index 97% rename from docs/sources/guides/gettingstarted.md rename to docs/sources/guides/_index.md index 0f8791f9..578b7f04 100644 --- a/docs/sources/guides/gettingstarted.md +++ b/docs/sources/guides/_index.md @@ -1,6 +1,6 @@ --- -title: Getting Started with Grafana-Zabbix -menuTitle: Getting Started with Grafana-Zabbix +title: Getting Started +menuTitle: Getting Started description: Getting Started with Grafana-Zabbix aliases: keywords: @@ -13,6 +13,8 @@ labels: weight: 400 --- +# Getting Started with Grafana-Zabbix + After you [installed and configured](../installation/index.md) Grafana-Zabbix data source let's create a simple dashboard. diff --git a/docs/sources/guides/templating.md b/docs/sources/guides/templating.md index c0a668d7..8a4ae6da 100644 --- a/docs/sources/guides/templating.md +++ b/docs/sources/guides/templating.md @@ -13,6 +13,8 @@ labels: weight: 410 --- +# Templating Guide + You can use template variables for creating highly reusable and interactive dashboards. General idea of templating is allow Grafana to get different metrics from data source and provide a way to change it on the fly without modifying dashboard. In case of Zabbix it means that you can get list of Host Groups, Hosts, Applications or Items and add it as a variables. ## Creating Variable diff --git a/docs/sources/installation/_index.md b/docs/sources/installation/_index.md index 48fb40a1..902c5573 100644 --- a/docs/sources/installation/_index.md +++ b/docs/sources/installation/_index.md @@ -13,6 +13,8 @@ labels: weight: 200 --- +# Installation + ## Choosing plugin version Currently (in version `4.x.x`) Grafana-Zabbix plugin supports Zabbix versions `4.x` and `5.x`. Zabbix `3.x` is not supported anymore. Generally, latest plugin should work with latest Grafana version, but if you have any compatibility issue, try to downgrade to previous minor release of Grafana. It's also helpful to report (but use search first to avoid duplicating issues) compatibility issues to the [GitHub](https://github.com/grafana/grafana-zabbix/issues). diff --git a/docs/sources/installation/building-from-sources.md b/docs/sources/installation/building-from-sources.md index be95082f..017e2de8 100644 --- a/docs/sources/installation/building-from-sources.md +++ b/docs/sources/installation/building-from-sources.md @@ -13,6 +13,8 @@ labels: weight: 210 --- +# Building from sources + If you want to build a package yourself, or contribute - here is a guide for how to do that. ## Prerequisites diff --git a/docs/sources/installation/upgrade.md b/docs/sources/installation/upgrade.md index 289d4970..f77088b7 100644 --- a/docs/sources/installation/upgrade.md +++ b/docs/sources/installation/upgrade.md @@ -13,6 +13,8 @@ labels: weight: 220 --- +# Upgrade + ## Upgrade from 2.x After [enabling](../../configuration/#enable-plugin) Zabbix App go to _Data Sources_, open your configured Zabbix diff --git a/docs/sources/reference/_index.md b/docs/sources/reference/_index.md new file mode 100644 index 00000000..6d5e921a --- /dev/null +++ b/docs/sources/reference/_index.md @@ -0,0 +1,20 @@ +--- +title: References +menuTitle: References +description: References +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 500 +--- + +# References + +- [Functions](./functions) +- [Direct DB Connection](./direct-db-connection) +- [Alerting](./alerting) \ No newline at end of file