From 94c5afc5d4070d76d9f6ba016dabfc897f167f08 Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Wed, 20 Dec 2023 07:10:48 +0000 Subject: [PATCH 1/8] moved documentation --- CHANGELOG.md | 2 +- README.md | 26 +-- cspell.config.json | 1 - docs/README.md | 21 --- .../configuration-influxdb_ds_config.png | Bin .../getstarting-dashboard_1.png | Bin .../getstarting-metrics_filtering.png | Bin .../getstarting-mysql_operations_1.png | Bin .../getstarting-mysql_operations_2.png | Bin .../getstarting-mysql_operations_3.png | Bin .../getstarting-processor_load.png | Bin .../getstarting-regex_backend_system_time.png | Bin .../getstarting-regex_cpu_time.png | Bin .../getstarting-singlestat_1.png | Bin .../getstarting-singlestat_2.png | Bin .../installation-add_datasource.png | Bin .../installation-datasource_config.png | Bin .../installation-enable_app.png | Bin .../installation-mysql_ds_config.png | Bin .../installation-plugin-dashboards.png | Bin .../installation-plugins-apps.png | Bin .../installation-postgres_ds_config.png | Bin .../installation-test_connection.png | Bin .../installation-test_connection_error.png | Bin .../reference-direct-db-connection.svg | 0 docs/{src/img => images}/templating-menu.png | Bin .../templating-query_with_variables.png | Bin .../templating-variable_editor.png | Bin docs/mkdocs.yml | 42 ----- docs/{src/index.md => sources/_index.md} | 25 ++- docs/{src/reference => sources}/alerting.md | 15 +- .../index.md => sources/configuration.md} | 42 +++-- .../direct-db-connection.md | 35 +++- .../direct-db-datasource.md} | 21 ++- docs/{src => sources}/features.md | 18 +- docs/{src/reference => sources}/functions.md | 174 +++++++++++++----- .../{src/guides => sources}/gettingstarted.md | 45 +++-- .../index.md => sources/installation.md} | 19 +- docs/sources/provisioning.md | 64 +++++++ .../run_from_main.md} | 18 +- docs/{src/guides => sources}/templating.md | 48 +++-- .../troubleshooting.md | 16 +- docs/sources/upgrade.md | 20 ++ docs/src/configuration/provisioning.md | 55 ------ docs/src/css/custom.css | 115 ------------ docs/src/img/.gitattributes | 0 docs/src/installation/upgrade.md | 10 - docs/src/reference/datasource-zabbix.md | 0 docs/src/reference/panel-triggers.md | 0 docs/src/tutorials/host_dashboard.md | 0 .../FunctionEditor/FunctionEditorControls.tsx | 2 +- src/plugin.json | 8 +- 52 files changed, 451 insertions(+), 391 deletions(-) delete mode 100644 docs/README.md rename docs/{src/img => images}/configuration-influxdb_ds_config.png (100%) rename docs/{src/img => images}/getstarting-dashboard_1.png (100%) rename docs/{src/img => images}/getstarting-metrics_filtering.png (100%) rename docs/{src/img => images}/getstarting-mysql_operations_1.png (100%) rename docs/{src/img => images}/getstarting-mysql_operations_2.png (100%) rename docs/{src/img => images}/getstarting-mysql_operations_3.png (100%) rename docs/{src/img => images}/getstarting-processor_load.png (100%) rename docs/{src/img => images}/getstarting-regex_backend_system_time.png (100%) rename docs/{src/img => images}/getstarting-regex_cpu_time.png (100%) rename docs/{src/img => images}/getstarting-singlestat_1.png (100%) rename docs/{src/img => images}/getstarting-singlestat_2.png (100%) rename docs/{src/img => images}/installation-add_datasource.png (100%) rename docs/{src/img => images}/installation-datasource_config.png (100%) rename docs/{src/img => images}/installation-enable_app.png (100%) rename docs/{src/img => images}/installation-mysql_ds_config.png (100%) rename docs/{src/img => images}/installation-plugin-dashboards.png (100%) rename docs/{src/img => images}/installation-plugins-apps.png (100%) rename docs/{src/img => images}/installation-postgres_ds_config.png (100%) rename docs/{src/img => images}/installation-test_connection.png (100%) rename docs/{src/img => images}/installation-test_connection_error.png (100%) rename docs/{src/img => images}/reference-direct-db-connection.svg (100%) rename docs/{src/img => images}/templating-menu.png (100%) rename docs/{src/img => images}/templating-query_with_variables.png (100%) rename docs/{src/img => images}/templating-variable_editor.png (100%) delete mode 100644 docs/mkdocs.yml rename docs/{src/index.md => sources/_index.md} (83%) rename docs/{src/reference => sources}/alerting.md (78%) rename docs/{src/configuration/index.md => sources/configuration.md} (70%) rename docs/{src/reference => sources}/direct-db-connection.md (86%) rename docs/{src/configuration/direct_db_datasource.md => sources/direct-db-datasource.md} (68%) rename docs/{src => sources}/features.md (78%) rename docs/{src/reference => sources}/functions.md (81%) rename docs/{src/guides => sources}/gettingstarted.md (56%) rename docs/{src/installation/index.md => sources/installation.md} (90%) create mode 100644 docs/sources/provisioning.md rename docs/{src/installation/run_from_master.md => sources/run_from_main.md} (66%) rename docs/{src/guides => sources}/templating.md (70%) rename docs/{src/configuration => sources}/troubleshooting.md (58%) create mode 100644 docs/sources/upgrade.md delete mode 100644 docs/src/configuration/provisioning.md delete mode 100644 docs/src/css/custom.css delete mode 100644 docs/src/img/.gitattributes delete mode 100644 docs/src/installation/upgrade.md delete mode 100644 docs/src/reference/datasource-zabbix.md delete mode 100644 docs/src/reference/panel-triggers.md delete mode 100644 docs/src/tutorials/host_dashboard.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8a24811bd..a5fe3ac94 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -661,7 +661,7 @@ option description for more information. ### Changed - Template query format. New format is `{group}{host}{app}{item}`. It allows to use names with dot. Updated - [templating docs](https://alexanderzobnin.github.io/grafana-zabbix/guides/templating/#query-format), + [templating docs](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/templating#query-format), [#254](https://github.com/alexanderzobnin/grafana-zabbix/issues/254) - Update included dashboards. Add templated zabbix datasource and use it for all metrics. - Improved performance of groupBy() functions (at 6-10x faster than old). diff --git a/README.md b/README.md index b63c60133..df1986234 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,18 @@ [![Version](https://badge.fury.io/gh/grafana%2Fgrafana-zabbix.svg)](https://github.com/grafana/grafana-zabbix/releases) [![Change Log](https://img.shields.io/badge/change-log-blue.svg?style=flat)](https://github.com/grafana/grafana-zabbix/blob/master/CHANGELOG.md) -[![Docs](https://img.shields.io/badge/docs-latest-red.svg?style=flat)](https://grafana.github.io/grafana-zabbix) +[![Docs](https://img.shields.io/badge/docs-latest-red.svg?style=flat)](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) ![Dashboard](https://user-images.githubusercontent.com/4932851/53799185-e1cdc700-3f4a-11e9-9cb4-8330f501b32e.png) ## Features -- Select multiple metrics [by using Regex](https://grafana.github.io/grafana-zabbix/guides/gettingstarted/#multiple-items-on-one-graph) -- Create interactive and reusable dashboards with [template variables](https://grafana.github.io/grafana-zabbix/guides/templating/) +- Select multiple metrics [by using Regex](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted/#multiple-items-on-one-graph) +- Create interactive and reusable dashboards with [template variables](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/templating/) - Show events on graphs with [Annotations](http://docs.grafana.org/reference/annotations/) - Display active problems with Triggers panel -- Transform and shape your data with [metric processing functions](https://grafana.github.io/grafana-zabbix/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) -- Find problems faster with [Alerting](https://grafana.github.io/grafana-zabbix/reference/alerting/) feature +- Transform and shape your data with [metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) +- Find problems faster with [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/alerting/) feature - Mix metrics from multiple data sources in the same dashboard or even graph - Discover and share [dashboards](https://grafana.com/dashboards) in the official library @@ -28,20 +28,20 @@ Install by using `grafana-cli` grafana-cli plugins install alexanderzobnin-zabbix-app ``` -Or see more installation options in [docs](https://grafana.github.io/grafana-zabbix/installation/). +Or see more installation options in [docs](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/installation/). ## Getting started -First, [configure](https://grafana.github.io/grafana-zabbix/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](https://grafana.github.io/grafana-zabbix/guides/gettingstarted/). +First, [configure](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted/). ## Documentation -- [About](https://grafana.github.io/grafana-zabbix) -- [Installation](https://grafana.github.io/grafana-zabbix/installation) -- [Getting Started](https://grafana.github.io/grafana-zabbix/guides/gettingstarted) -- [Templating](https://grafana.github.io/grafana-zabbix/guides/templating) -- [Alerting](https://grafana.github.io/grafana-zabbix/reference/alerting/) -- [Metric processing functions](https://grafana.github.io/grafana-zabbix/reference/functions/) +- [About](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) +- [Installation](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/installation) +- [Getting Started](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted) +- [Templating](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/templating) +- [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/alerting/) +- [Metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/) ## Community Resources, Feedback, and Support diff --git a/cspell.config.json b/cspell.config.json index 72380660b..5e2750673 100644 --- a/cspell.config.json +++ b/cspell.config.json @@ -63,7 +63,6 @@ "templating", "singlestat", "iowait", - "mkdocs", "submatch", "Gleb", "Ivanovsky", diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 837f516b9..000000000 --- a/docs/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Grafana-Zabbix Documentation - -## Building docs -To build this docs on your computer you need [git-lfs](https://git-lfs.github.com/) and [mkdocs](http://www.mkdocs.org/) installed. - -Clone repo -``` -git clone https://github.com/alexanderzobnin/grafana-zabbix -``` -Check images in `docs/sources/img/`. If this folder is empty, run -``` -git lfs fetch --all -``` - -Build docs -``` -cd docs/ -mkdocs build --clean -``` - -Built docs will be placed in `site/` directory. diff --git a/docs/src/img/configuration-influxdb_ds_config.png b/docs/images/configuration-influxdb_ds_config.png similarity index 100% rename from docs/src/img/configuration-influxdb_ds_config.png rename to docs/images/configuration-influxdb_ds_config.png diff --git a/docs/src/img/getstarting-dashboard_1.png b/docs/images/getstarting-dashboard_1.png similarity index 100% rename from docs/src/img/getstarting-dashboard_1.png rename to docs/images/getstarting-dashboard_1.png diff --git a/docs/src/img/getstarting-metrics_filtering.png b/docs/images/getstarting-metrics_filtering.png similarity index 100% rename from docs/src/img/getstarting-metrics_filtering.png rename to docs/images/getstarting-metrics_filtering.png diff --git a/docs/src/img/getstarting-mysql_operations_1.png b/docs/images/getstarting-mysql_operations_1.png similarity index 100% rename from docs/src/img/getstarting-mysql_operations_1.png rename to docs/images/getstarting-mysql_operations_1.png diff --git a/docs/src/img/getstarting-mysql_operations_2.png b/docs/images/getstarting-mysql_operations_2.png similarity index 100% rename from docs/src/img/getstarting-mysql_operations_2.png rename to docs/images/getstarting-mysql_operations_2.png diff --git a/docs/src/img/getstarting-mysql_operations_3.png b/docs/images/getstarting-mysql_operations_3.png similarity index 100% rename from docs/src/img/getstarting-mysql_operations_3.png rename to docs/images/getstarting-mysql_operations_3.png diff --git a/docs/src/img/getstarting-processor_load.png b/docs/images/getstarting-processor_load.png similarity index 100% rename from docs/src/img/getstarting-processor_load.png rename to docs/images/getstarting-processor_load.png diff --git a/docs/src/img/getstarting-regex_backend_system_time.png b/docs/images/getstarting-regex_backend_system_time.png similarity index 100% rename from docs/src/img/getstarting-regex_backend_system_time.png rename to docs/images/getstarting-regex_backend_system_time.png diff --git a/docs/src/img/getstarting-regex_cpu_time.png b/docs/images/getstarting-regex_cpu_time.png similarity index 100% rename from docs/src/img/getstarting-regex_cpu_time.png rename to docs/images/getstarting-regex_cpu_time.png diff --git a/docs/src/img/getstarting-singlestat_1.png b/docs/images/getstarting-singlestat_1.png similarity index 100% rename from docs/src/img/getstarting-singlestat_1.png rename to docs/images/getstarting-singlestat_1.png diff --git a/docs/src/img/getstarting-singlestat_2.png b/docs/images/getstarting-singlestat_2.png similarity index 100% rename from docs/src/img/getstarting-singlestat_2.png rename to docs/images/getstarting-singlestat_2.png diff --git a/docs/src/img/installation-add_datasource.png b/docs/images/installation-add_datasource.png similarity index 100% rename from docs/src/img/installation-add_datasource.png rename to docs/images/installation-add_datasource.png diff --git a/docs/src/img/installation-datasource_config.png b/docs/images/installation-datasource_config.png similarity index 100% rename from docs/src/img/installation-datasource_config.png rename to docs/images/installation-datasource_config.png diff --git a/docs/src/img/installation-enable_app.png b/docs/images/installation-enable_app.png similarity index 100% rename from docs/src/img/installation-enable_app.png rename to docs/images/installation-enable_app.png diff --git a/docs/src/img/installation-mysql_ds_config.png b/docs/images/installation-mysql_ds_config.png similarity index 100% rename from docs/src/img/installation-mysql_ds_config.png rename to docs/images/installation-mysql_ds_config.png diff --git a/docs/src/img/installation-plugin-dashboards.png b/docs/images/installation-plugin-dashboards.png similarity index 100% rename from docs/src/img/installation-plugin-dashboards.png rename to docs/images/installation-plugin-dashboards.png diff --git a/docs/src/img/installation-plugins-apps.png b/docs/images/installation-plugins-apps.png similarity index 100% rename from docs/src/img/installation-plugins-apps.png rename to docs/images/installation-plugins-apps.png diff --git a/docs/src/img/installation-postgres_ds_config.png b/docs/images/installation-postgres_ds_config.png similarity index 100% rename from docs/src/img/installation-postgres_ds_config.png rename to docs/images/installation-postgres_ds_config.png diff --git a/docs/src/img/installation-test_connection.png b/docs/images/installation-test_connection.png similarity index 100% rename from docs/src/img/installation-test_connection.png rename to docs/images/installation-test_connection.png diff --git a/docs/src/img/installation-test_connection_error.png b/docs/images/installation-test_connection_error.png similarity index 100% rename from docs/src/img/installation-test_connection_error.png rename to docs/images/installation-test_connection_error.png diff --git a/docs/src/img/reference-direct-db-connection.svg b/docs/images/reference-direct-db-connection.svg similarity index 100% rename from docs/src/img/reference-direct-db-connection.svg rename to docs/images/reference-direct-db-connection.svg diff --git a/docs/src/img/templating-menu.png b/docs/images/templating-menu.png similarity index 100% rename from docs/src/img/templating-menu.png rename to docs/images/templating-menu.png diff --git a/docs/src/img/templating-query_with_variables.png b/docs/images/templating-query_with_variables.png similarity index 100% rename from docs/src/img/templating-query_with_variables.png rename to docs/images/templating-query_with_variables.png diff --git a/docs/src/img/templating-variable_editor.png b/docs/images/templating-variable_editor.png similarity index 100% rename from docs/src/img/templating-variable_editor.png rename to docs/images/templating-variable_editor.png diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 76a01fe13..000000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,42 +0,0 @@ -site_name: Grafana-Zabbix Documentation -site_description: Documentation for Grafana-Zabbix, Zabbix monitoring system plugin bundle for Grafana -site_url: https://alexanderzobnin.github.io/grafana-zabbix/ -repo_url: https://github.com/alexanderzobnin/grafana-zabbix/ -edit_uri: blob/docs/docs/sources/ -copyright: Copyright © 2015-2020, Alexander Zobnin - -docs_dir: sources - -theme: - name: readthedocs - highlightjs: true - hljs_languages: - - yaml - - sql -extra_css: - - css/custom.css - -nav: - - Project: - - 'About Grafana-Zabbix': 'index.md' - - 'Feature Highlights': 'features.md' - - Installation: - - 'Installation': 'installation/index.md' - - 'Building from sources': 'installation/run_from_master.md' - - 'Upgrade': 'installation/upgrade.md' - - Configuration: - - 'Configuration': 'configuration/index.md' - - 'Direct DB Connection Configuration': 'configuration/direct_db_datasource.md' - - 'Provisioning': 'configuration/provisioning.md' - - 'Troubleshooting': 'configuration/troubleshooting.md' - - User Guides: - - 'Getting Started': 'guides/gettingstarted.md' - - 'Templating': 'guides/templating.md' - - Reference: - - 'Zabbix Datasource': 'reference/datasource-zabbix.md' - - 'Triggers Panel': 'reference/panel-triggers.md' - - 'Functions': 'reference/functions.md' - - 'Alerting': 'reference/alerting.md' - - 'Direct DB Connection': 'reference/direct-db-connection.md' - # - Tutorials: - # - 'Building Host Dashboard': 'tutorials/host_dashboard.md' diff --git a/docs/src/index.md b/docs/sources/_index.md similarity index 83% rename from docs/src/index.md rename to docs/sources/_index.md index 5cb4ec7ef..b2f490047 100644 --- a/docs/src/index.md +++ b/docs/sources/_index.md @@ -1,7 +1,17 @@ -page_title: About Grafana-Zabbix -page_description: Introduction to Grafana-Zabbix plugin. - -# About Grafana-Zabbix plugin +--- +title: Grafana Zabbix +menuTitle: About Grafana-Zabbix +description: Introduction to Grafana-Zabbix plugin. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 100 +--- 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 @@ -25,14 +35,15 @@ a number of ways to get help: Or you can send me [email](mailto:alexanderzobnin@gmail.com). ## Support Project + I develop this project in my free time, but if you really find it helpful and promising, you can -support me. There are some ways to do this. You can [donate](https://www.paypal.me/alexanderzobnin) -any reasonable amount, or you can request a feature development, interesting for you (for example, +support me. There are some ways to do this. You can [donate](https://www.paypal.me/alexanderzobnin) +any reasonable amount, or you can request a feature development, interesting for you (for example, Triggers panel was sponsored by [Core IT Project](http://coreit.fr/)). ## License 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/master/LICENSE) for the full +[LICENSE](https://github.com/alexanderzobnin/grafana-zabbix/blob/min/LICENSE) for the full license terms. diff --git a/docs/src/reference/alerting.md b/docs/sources/alerting.md similarity index 78% rename from docs/src/reference/alerting.md rename to docs/sources/alerting.md index fe2c4fdcd..82e8a3dc0 100644 --- a/docs/src/reference/alerting.md +++ b/docs/sources/alerting.md @@ -1,4 +1,17 @@ -# Alerting +--- +title: Alerting +menuTitle: Alerting +description: Alerting +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 520 +--- ## Alerting overview diff --git a/docs/src/configuration/index.md b/docs/sources/configuration.md similarity index 70% rename from docs/src/configuration/index.md rename to docs/sources/configuration.md index 797aa13ee..d177cad1c 100644 --- a/docs/src/configuration/index.md +++ b/docs/sources/configuration.md @@ -1,14 +1,24 @@ -page_title: Grafana-Zabbix Configuration -page_description: Plugin configuration instructions for Grafana-Zabbix. - -# Configuration +--- +title: Configuration +menuTitle: Configuration +description: Plugin configuration instructions for Grafana-Zabbix. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 300 +--- ## Enable plugin Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_ tab and enable plugin. -![Enable Zabbix App](../img/installation-enable_app.png) +![Enable Zabbix App](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-enable_app.png) ## Configure Zabbix data source @@ -16,7 +26,7 @@ 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. -![Configure Zabbix data source](../img/installation-datasource_config.png) +![Configure Zabbix data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-datasource_config.png) ### HTTP settings @@ -29,22 +39,22 @@ To add new Zabbix data source open _Data Sources_ in side panel, click _Add data ### Zabbix API details - **Username** and **Password**: setup login for access to Zabbix API. Also check user's permissions - in Zabbix if you cannot get any groups and hosts in Grafana. + in Zabbix if you cannot get any groups and hosts in Grafana. - **Trends**: enable if you use Zabbix 3.x or newer. This option 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 - will increase Grafana performance. + 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 specifiers are: + 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 specifiers 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. + 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). + value to desired cache lifetime (this option affect data like items list). - **Timeout**: Zabbix connection timeout in seconds. Default is 30. ### Direct DB Connection @@ -75,7 +85,7 @@ Then click _Add_ - data source will be added and you can check connection using You can import dashboard examples from _Dashboards_ tab in the data source config. -![Import dashboards](../img/installation-plugin-dashboards.png) +![Import dashboards](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-plugin-dashboards.png) ## Note about Browser Cache diff --git a/docs/src/reference/direct-db-connection.md b/docs/sources/direct-db-connection.md similarity index 86% rename from docs/src/reference/direct-db-connection.md rename to docs/sources/direct-db-connection.md index a33e1dcda..1e60471fd 100644 --- a/docs/src/reference/direct-db-connection.md +++ b/docs/sources/direct-db-connection.md @@ -1,4 +1,17 @@ -# Direct DB Connection +--- +title: Direct DB Connection +menuTitle: Direct DB Connection +description: Direct DB Connection +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 530 +--- Since version 4.3 Grafana can use MySQL as a native data source. The idea of Direct DB Connection is that Grafana-Zabbix plugin can use this data source for querying data directly from a Zabbix database. @@ -18,13 +31,14 @@ This chart illustrates how the plugin uses both Zabbix API and the MySQL data so of data from Zabbix. MySQL data source is used only for pulling history and trend data instead of `history.get` and `trend.get` API calls. -[![Direct DB Connection](../img/reference-direct-db-connection.svg)](../img/reference-direct-db-connection.svg) +[![Direct DB Connection](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/reference-direct-db-connection.svg)](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/reference-direct-db-connection.svg) ## Query structure Below is an example query for getting history in the Grafana-Zabbix Plugin: **MySQL**: + ```sql SELECT itemid AS metric, clock AS time_sec, {aggFunc}(value) as value FROM {historyTable} @@ -35,9 +49,10 @@ ORDER BY time_sec ASC ``` **PostgreSQL**: + ```sql -SELECT to_char(itemid, 'FM99999999999999999999') AS metric, - clock / {intervalSec} * {intervalSec} AS time, +SELECT to_char(itemid, 'FM99999999999999999999') AS metric, + clock / {intervalSec} * {intervalSec} AS time, {aggFunc}(value) AS value FROM {historyTable} WHERE itemid IN ({itemids}) @@ -53,6 +68,7 @@ When getting trends, the plugin additionally queries a particular value column ( depends on `consolidateBy` function value: **MySQL**: + ```sql SELECT itemid AS metric, clock AS time_sec, {aggFunc}({valueColumn}) as value FROM {trendsTable} @@ -63,9 +79,10 @@ ORDER BY time_sec ASC ``` **PostgreSQL**: + ```sql -SELECT to_char(itemid, 'FM99999999999999999999') AS metric, - clock / {intervalSec} * {intervalSec} AS time, +SELECT to_char(itemid, 'FM99999999999999999999') AS metric, + clock / {intervalSec} * {intervalSec} AS time, {aggFunc}({valueColumn}) AS value FROM {trendsTable} WHERE itemid IN ({itemids}) @@ -79,9 +96,11 @@ ORDER BY time ASC As you can see, the Grafana-Zabbix plugin uses aggregation by a given time interval. This interval is provided by Grafana and depends on the panel width in pixels. Thus, Grafana displays the data in the proper resolution. ## InfluxDB + Zabbix supports loadable modules which makes possible to write history data into an external database. There's a [module](https://github.com/i-ky/effluence) for InfluxDB written by [Gleb Ivanovsky](https://github.com/i-ky) which can export history into InfluxDB in real-time. -#### InfluxDB retention policy +### InfluxDB retention policy + In order to keep database size under control, you should use InfluxDB retention policy mechanism. It's possible to create retention policy for long-term data and write aggregated data in the same manner as Zabbix does (trends). Then this retention policy can be used in plugin for getting data after a certain period ([Retention Policy](../../configuration/#direct-db-connection) option in data source config). Read more about how to configure retention policy for using with plugin in effluence module [docs](https://github.com/i-ky/effluence#database-sizing). #### InfluxDB Query @@ -98,6 +117,6 @@ GROUP BY time(10s), "itemid" fill(none) ## Functions usage with Direct DB Connection -There's only one function that directly affects the backend data. This function is `consolidateBy`. Other functions work on the client side and transform data that comes from the backend. So you should clearly understand that this is pre-aggregated data (by AVG, MAX, MIN, etc). +There's only one function that directly affects the backend data. This function is `consolidateBy`. Other functions work on the client side and transform data that comes from the backend. So you should clearly understand that this is pre-aggregated data (by AVG, MAX, MIN, etc). For example, say you want to group values by 1 hour interval and `max` function. If you just apply `groupBy(10m, max)` function, your result will be wrong, because you would transform data aggregated by default `AVG` function. You should use `consolidateBy(max)` coupled with `groupBy(10m, max)` in order to get a precise result. diff --git a/docs/src/configuration/direct_db_datasource.md b/docs/sources/direct-db-datasource.md similarity index 68% rename from docs/src/configuration/direct_db_datasource.md rename to docs/sources/direct-db-datasource.md index 78d6246cc..474235ac7 100644 --- a/docs/src/configuration/direct_db_datasource.md +++ b/docs/sources/direct-db-datasource.md @@ -1,4 +1,17 @@ -# Direct DB Data Source Configuration +--- +title: Direct DB Data Source Configuration +menuTitle: Direct DB Data Source Configuration +description: Direct DB Data Source Configuration +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 310 +--- ## Security notes @@ -13,7 +26,7 @@ GRANT SELECT ON zabbix.* TO 'grafana'@'grafana-host' identified by 'password'; In order to use _Direct DB Connection_ feature you should configure SQL data source first. -![Configure MySQL data source](../img/installation-mysql_ds_config.png) +![Configure MySQL data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-mysql_ds_config.png) Select _MySQL_ data source type and provide your database host address and port (3306 is default for MySQL). Fill database name (usually, `zabbix`) and specify credentials. @@ -23,11 +36,11 @@ database name (usually, `zabbix`) and specify credentials. Select _PostgreSQL_ data source type and provide your database host address and port (5432 is default). Fill database name (usually, `zabbix`) and specify credentials. -![Configure PostgreSQL data source](../img/installation-postgres_ds_config.png) +![Configure PostgreSQL data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-postgres_ds_config.png) ## InfluxDB Select _InfluxDB_ data source type and provide your InfluxDB instance host address and port (8086 is default). Fill database name you configured in the [effluence](https://github.com/i-ky/effluence) module config (usually, `zabbix`) and specify credentials. -![Configure InfluxDB data source](../img/configuration-influxdb_ds_config.png) +![Configure InfluxDB data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/configuration-influxdb_ds_config.png) diff --git a/docs/src/features.md b/docs/sources/features.md similarity index 78% rename from docs/src/features.md rename to docs/sources/features.md index d78998288..9079eea3d 100644 --- a/docs/src/features.md +++ b/docs/sources/features.md @@ -1,7 +1,17 @@ -page_title: Feature Highlights -page_description: Grafana-Zabbix Feature Highlights. - -# Feature Highlights +--- +title: Feature Highlights +menuTitle: Feature Highlights +description: Grafana-Zabbix Feature Highlights. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 110 +--- Grafana in couple with Grafana-Zabbix plugin allows to create great dashboards. There is some features: diff --git a/docs/src/reference/functions.md b/docs/sources/functions.md similarity index 81% rename from docs/src/reference/functions.md rename to docs/sources/functions.md index 316e5d6cf..55768ae83 100644 --- a/docs/src/reference/functions.md +++ b/docs/sources/functions.md @@ -1,5 +1,17 @@ -Functions reference -=================== +--- +title: Functions reference +menuTitle: Functions reference +description: Functions reference +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 510 +--- ## Functions Variables @@ -11,7 +23,8 @@ There are some built-in template variables available for using in functions: - `$__range_series` - invoke function over all series values Examples: -``` + +```sh groupBy($__range, avg) percentile($__range_series, 95) - 95th percentile over all values ``` @@ -20,70 +33,85 @@ percentile($__range_series, 95) - 95th percentile over all values ## Transform - ### _groupBy_ -``` +```sh groupBy(interval, function) ``` Takes each timeseries and consolidate its points fallen in the given _interval_ into one point using _function_, which can be one of: _avg_, _min_, _max_, _median_. Examples: -``` + +```sh groupBy(10m, avg) groupBy(1h, median) ``` + --- ### _scale_ -``` + +```sh scale(factor) ``` + Takes timeseries and multiplies each point by the given _factor_. Examples: -``` + +```sh scale(100) scale(0.01) ``` + --- ### _delta_ -``` + +```sh delta() ``` + Converts absolute values to delta. This function just calculate difference between values. For the per-second calculation use `rate()`. --- ### _rate_ -``` + +```sh rate() ``` + Calculates the per-second rate of increase of the time series. Resistant to counter reset. Suitable for converting of growing counters into the per-second rate. --- ### _movingAverage_ -``` + +```sh movingAverage(windowSize) ``` + Graphs the moving average of a metric over a fixed number of past points, specified by `windowSize` param. Examples: -``` + +```sh movingAverage(60) calculates moving average over 60 points (if metric has 1 second resolution it matches 1 minute window) ``` + --- ### _exponentialMovingAverage_ -``` + +```sh exponentialMovingAverage(windowSize) ``` + Takes a series of values and a window size and produces an exponential moving average utilizing the following formula: `ema(current) = constant * (Current Value) + (1 - constant) * ema(previous)` @@ -99,50 +127,63 @@ hack: assume, previous N points have the same average values as first N (windowS in mind and don't rely on first N points interval. Examples: -``` + +```sh movingAverage(60) calculates moving average over 60 points (if metric has 1 second resolution it matches 1 minute window) ``` + --- ### _percentile_ -``` + +```sh percentile(interval, N) ``` + Takes a series of values and a window size and consolidate all its points fallen in the given _interval_ into one point by Nth percentile. Examples: -``` + +```sh percentile(1h, 99) percentile($__range_series, 95) - 95th percentile over all series values ``` + --- ### _removeAboveValue_ -``` + +```sh removeAboveValue(N) ``` + Replaces series values with `null` if value > N Examples: -``` + +```sh removeAboveValue(1) ``` --- ### _removeBelowValue_ -``` + +```sh removeBelowValue(N) ``` + Replaces series values with `null` if value < N --- ### _transformNull_ -``` + +```sh transformNull(N) ``` + Replaces `null` values with N --- @@ -150,21 +191,25 @@ Replaces `null` values with N ## Aggregate ### _aggregateBy_ -``` + +```sh aggregateBy(interval, function) ``` Takes all timeseries and consolidate all its points fallen in the given _interval_ into one point using _function_, which can be one of: _avg_, _min_, _max_, _median_. Examples: -``` + +```sh aggregateBy(10m, avg) aggregateBy(1h, median) ``` + --- ### _sumSeries_ -``` + +```sh sumSeries() ``` @@ -173,13 +218,16 @@ This will add metrics together and return the sum at each datapoint. This method --- ### _percentileAgg_ -``` + +```sh percentileAgg(interval, N) ``` + Takes all timeseries and consolidate all its points fallen in the given _interval_ into one point by Nth percentile. Examples: -``` + +```sh percentileAgg(1h, 99) percentileAgg($__range_series, 95) - 95th percentile over all values ``` @@ -187,25 +235,31 @@ percentileAgg($__range_series, 95) - 95th percentile over all values --- ### _average_ -``` + +```sh average(interval) ``` + **Deprecated**, use `aggregateBy(interval, avg)` instead. --- ### _min_ -``` + +```sh min(interval) ``` + **Deprecated**, use `aggregateBy(interval, min)` instead. --- ### _max_ -``` + +```sh max(interval) ``` + **Deprecated**, use `aggregateBy(interval, max)` instead. --- @@ -214,37 +268,42 @@ max(interval) ### _top_ -``` +```sh top(N, value) ``` Returns top N series, sorted by _value_, which can be one of: _avg_, _min_, _max_, _median_. Examples: -``` + +```sh top(10, avg) top(5, max) ``` + --- ### _bottom_ -``` +```sh bottom(N, value) ``` Returns bottom N series, sorted by _value_, which can be one of: _avg_, _min_, _max_, _median_. Examples: -``` + +```sh bottom(5, avg) ``` + --- ## Trends ### _trendValue_ -``` + +```sh trendValue(valueType) ``` @@ -255,16 +314,20 @@ Specifying type of trend value returned by Zabbix when trends are used (avg, min ## Time ### _timeShift_ -``` + +```sh timeShift(interval) ``` + Draws the selected metrics shifted in time. If no sign is given, a minus sign ( - ) is implied which will shift the metric back in time. If a plus sign ( + ) is given, the metric will be shifted forward in time. Examples: -``` + +```sh timeShift(24h) - shift metric back in 24h hours timeShift(-24h) - the same result as for timeShift(24h) timeShift(+1d) - shift metric forward in 1 day ``` + --- ## Alias @@ -277,57 +340,66 @@ Following template variables available for using in `setAlias()` and `replaceAli - `$__zbx_host` - technical name of the host Examples: -``` + +```sh setAlias($__zbx_host_name: $__zbx_item) -> backend01: CPU user time setAlias(Item key: $__zbx_item_key) -> Item key: system.cpu.load[percpu,avg1] setAlias($__zbx_host_name) -> backend01 ``` ### _setAlias_ -``` + +```sh setAlias(alias) ``` Returns given alias instead of the metric name. Examples: -``` + +```sh setAlias(load) ``` + --- ### _setAliasByRegex_ -``` + +```sh setAliasByRegex(regex) ``` Returns part of the metric name matched by regex. Examples: -``` + +```sh setAlias(Zabbix busy [a-zA-Z]+) ``` + --- ### _replaceAlias_ -``` + +```sh replaceAlias(pattern, newAlias) ``` Replace metric name using pattern. Pattern is regex or regular string. If regex is used, following special replacement patterns are supported: -|Pattern | Inserts| -----------|--------- -|$$ | Inserts a "$". | -|$& | Inserts the matched substring. | -|$` | Inserts the portion of the string that precedes the matched substring. | -|$' | Inserts the portion of the string that follows the matched substring. | -|$n | Where n is a non-negative integer less than 100, inserts the nth parenthesized submatch string, provided the first argument was a RegExp object. | +| Pattern | Inserts | +| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| $$ | Inserts a "$". | +| $& | Inserts the matched substring. | +| $` | Inserts the portion of the string that precedes the matched substring. | +| $' | Inserts the portion of the string that follows the matched substring. | +| $n | Where n is a non-negative integer less than 100, inserts the nth parenthesized submatch string, provided the first argument was a RegExp object. | For more details see [String.prototype.replace()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace) function. Examples: -``` + +```sh CPU system time replaceAlias(/CPU (.*) time/, $1) -> system @@ -340,12 +412,14 @@ replaceAlias(/.*CPU (.*) time/, $1) -> system backend01: CPU system time replaceAlias(/(.*): CPU (.*) time/, $1 - $2) -> backend01 - system ``` + --- ## Special ### _consolidateBy_ -``` + +```sh consolidateBy(consolidationFunc) ``` diff --git a/docs/src/guides/gettingstarted.md b/docs/sources/gettingstarted.md similarity index 56% rename from docs/src/guides/gettingstarted.md rename to docs/sources/gettingstarted.md index c5597ca6d..0f8791f9c 100644 --- a/docs/src/guides/gettingstarted.md +++ b/docs/sources/gettingstarted.md @@ -1,55 +1,74 @@ -# Getting Started with Grafana-Zabbix +--- +title: Getting Started with Grafana-Zabbix +menuTitle: Getting Started with Grafana-Zabbix +description: Getting Started with Grafana-Zabbix +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 400 +--- + After you [installed and configured](../installation/index.md) Grafana-Zabbix data source let's create a simple dashboard. ## Simple Graph + Add new Graph panel to dashboard. Select metrics from dropdown or start to type to filter results -![Metrics filtering](../img/getstarting-metrics_filtering.png) +![Metrics filtering](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-metrics_filtering.png) Let's create _15 min avg processor load_ graph. Select Host Group, Host, Application (optional - you can leave it blank) and Item. -![Processor load](../img/getstarting-processor_load.png) +![Processor load](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-processor_load.png) ## Multiple Items On One Graph -You can build graphs with lots of items using Regular Expressions inside metric field. Grafana uses JavaScript regex implementation. For example, if you need to show CPU time (user, system, iowait, etc) you may create graph using this regex in Item field: + +You can build graphs with lots of items using Regular Expressions inside metric field. Grafana uses JavaScript regex implementation. For example, if you need to show CPU time (user, system, iowait, etc) you may create graph using this regex in Item field: + ```js -/CPU (?!idle).* time/ +/CPU (?!idle).* time/; ``` -![CPU time](../img/getstarting-regex_cpu_time.png) +![CPU time](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-regex_cpu_time.png) Another case to use regex is comparing the same metrics for different hosts. Use `/.*/` regex for showing all metrics or write your own filter. For example, I want to show _CPU system time_ for all hosts which name started with _backend_ from all host groups. I use `/.*/` for Group, `/^backend/` for Host and `CPU system time` for Item. -![Backend system time](../img/getstarting-regex_backend_system_time.png) +![Backend system time](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-regex_backend_system_time.png) ## Bar Chart + Let's create a graph which show queries stats for MySQL database. Select Group, Host, Application (_MySQL_ in my case) and Items. I use `/MySQL .* operations/` regex for filtering different types of operations. -![MySQL operations 1](../img/getstarting-mysql_operations_1.png) +![MySQL operations 1](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_1.png) To show graph as Bar Chart, go to the **Display** tab, uncheck **Lines** and set **Bars**. Also, enable **Stack** checkbox for showing stacked bars. -![MySQL operations 2](../img/getstarting-mysql_operations_2.png) +![MySQL operations 2](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_2.png) But this graph doesn't look good because it contains too many bars. We can fix it by using **Max data points** parameter. Go to the **Metrics** tab and set **Max data points** to 50 for example. -![MySQL operations 3](../img/getstarting-mysql_operations_3.png) +![MySQL operations 3](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_3.png) Ok, looks pretty! ## Singlestat and Gauges + Sometimes you may need to show just a big single value for particular metric. Use Grafana's **Singlestat** panel in this case. Let's create panel which shows _CPU user time_ metric. -![Singlestat 1](../img/getstarting-singlestat_1.png) +![Singlestat 1](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-singlestat_1.png) Suppose that you want to set units as percents and show **Gauge** for this value. Go to the **Options** tab and set units to _percent (0-100)_. Then enable _Show_ option for _Gauge_ and set Min and Max values for your metric (0-100 in our case). Set thresholds if you want to see it on Gauge (`50,80` for example). -![Singlestat 2](../img/getstarting-singlestat_2.png) +![Singlestat 2](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-singlestat_2.png) Great, looks cool. Read more about Singlestat panel in [Grafana docs](http://docs.grafana.org/reference/singlestat/). And all together: -![Dashboard](../img/getstarting-dashboard_1.png) +![Dashboard](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-dashboard_1.png) diff --git a/docs/src/installation/index.md b/docs/sources/installation.md similarity index 90% rename from docs/src/installation/index.md rename to docs/sources/installation.md index 167162696..6ba889a79 100644 --- a/docs/src/installation/index.md +++ b/docs/sources/installation.md @@ -1,7 +1,17 @@ -page_title: Grafana-Zabbix Installation -page_description: Installation instructions for Grafana-Zabbix. - -# Installation +--- +title: Installation +menuTitle: Installation +description: Installation instructions for Grafana-Zabbix. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 200 +--- ## Choosing plugin version @@ -22,6 +32,7 @@ grafana-cli plugins install alexanderzobnin-zabbix-app ``` Restart grafana after installing plugins + ```sh systemctl restart grafana-server ``` diff --git a/docs/sources/provisioning.md b/docs/sources/provisioning.md new file mode 100644 index 000000000..6ece225ae --- /dev/null +++ b/docs/sources/provisioning.md @@ -0,0 +1,64 @@ +--- +title: Provisioning Grafana-Zabbix plugin +menuTitle: Provisioning Grafana-Zabbix plugin +description: Grafana-Zabbix plugin provisioning instructions. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 320 +--- + +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 + +```yaml +apiVersion: 1 +datasources: + - name: Zabbix + type: alexanderzobnin-zabbix-datasource + access: proxy + url: http://localhost/zabbix/api_jsonrpc.php + isDefault: true + jsonData: + # Zabbix API credentials + username: zabbix + password: zabbix + # Trends options + trends: true + trendsFrom: '7d' + trendsRange: '4d' + # Cache update interval + cacheTTL: '1h' + # Alerting options + alerting: true + addThresholds: false + alertingMinSeverity: 3 + # Direct DB Connection options + dbConnectionEnable: true + # Name of existing datasource for Direct DB Connection + dbConnectionDatasourceName: MySQL Zabbix + # Retention policy name (InfluxDB only) for fetching long-term stored data. + # Leave it blank if only default retention policy used. + dbConnectionRetentionPolicy: one_year + # Disable acknowledges for read-only users + disableReadOnlyUsersAck: true + # Disable time series data alignment + disableDataAlignment: false + # Use value mapping from Zabbix + useZabbixValueMapping: true + version: 1 + editable: false + + - name: MySQL Zabbix + type: mysql + url: localhost:3306 + database: zabbix + user: grafana + password: password +``` diff --git a/docs/src/installation/run_from_master.md b/docs/sources/run_from_main.md similarity index 66% rename from docs/src/installation/run_from_master.md rename to docs/sources/run_from_main.md index 6c0f93363..b9480d18c 100644 --- a/docs/src/installation/run_from_master.md +++ b/docs/sources/run_from_main.md @@ -1,7 +1,17 @@ -page_title: Run Grafana-Zabbix from master -page_description: Building instructions for Grafana-Zabbix. - -# Run from master +--- +title: Run Grafana-Zabbix from main branch +menuTitle: Run Grafana-Zabbix from main branch +description: Building instructions for Grafana-Zabbix. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 210 +--- If you want to build a package yourself, or contribute - here is a guide for how to do that. diff --git a/docs/src/guides/templating.md b/docs/sources/templating.md similarity index 70% rename from docs/src/guides/templating.md rename to docs/sources/templating.md index f9fe42056..c0a668d78 100644 --- a/docs/src/guides/templating.md +++ b/docs/sources/templating.md @@ -1,14 +1,29 @@ -# Templating Guide +--- +title: Templating Guide +menuTitle: Templating Guide +description: Templating Guide +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 410 +--- + 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 + To create template variable click the cog icon on the top navigation bar and choose _Templating_. -![Templating menu](../img/templating-menu.png) +![Templating menu](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-menu.png) When you click _New_ button, you'll see template variable editor. It contains these sections: -![Variable editor](../img/templating-variable_editor.png) +![Variable editor](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-variable_editor.png) ### Variable @@ -16,7 +31,7 @@ When you click _New_ button, you'll see template variable editor. It contains th Name of the variable. You should use this name in queries. **Label** -Visible label for variable. Use when you want to display different name on dashboard. For instance, _Host Group_ instead *host_group*. +Visible label for variable. Use when you want to display different name on dashboard. For instance, _Host Group_ instead _host_group_. **Type** By default _Query_ type is selected. It means that Grafana asks data source for values of variable. But there are some other types: _Interval_ (just a time interval), _Data source_ (You can switch data source, for example, if you have more than one Zabbix instance and each added into Grafana as data source), _Custom_ (you can set any predefined values for variable) and _Constant_. @@ -43,15 +58,17 @@ Enable, if you want to select multiple values at the same time. ### Value groups/tags (Experimental feature) ## Query Format + Template variable query in Zabbix data source is a string which contains 4 parts wrapped in braces (`{}`). You still can use a period (`.`), but it's deprecated and will be removed in future. -``` +```sh {host group}{host}{application}{item name} ``` -For example, -``` +For example, + +```sh {Zabbix servers}{Zabbix server}{CPU}{*} {Frontend}{web01.mydomain.com}{*}{*} ``` @@ -60,15 +77,16 @@ Each part can be a name of corresponding metric or `*`, which means _all metrics Examples: - - `{*}` returns list of all available Host Groups - - `{*}{*}` all hosts in Zabbix - - `{Network}{*}` returns all hosts in group Network - - `{Linux servers}{*}{*}` returns all applications from hosts in Linux servers group - - `{Linux servers}{backend01}{CPU}{*}` returns all items from backend01 belonging to CPU application. +- `{*}` returns list of all available Host Groups +- `{*}{*}` all hosts in Zabbix +- `{Network}{*}` returns all hosts in group Network +- `{Linux servers}{*}{*}` returns all applications from hosts in Linux servers group +- `{Linux servers}{backend01}{CPU}{*}` returns all items from backend01 belonging to CPU application. -You can use another variable as a part of query. For instance, you have variable _group_, which returns list of +You can use another variable as a part of query. For instance, you have variable _group_, which returns list of host groups and want to use it for querying hosts in selected group only. Here's a query for this case: -``` + +```sh {$group}{*} ``` @@ -76,7 +94,7 @@ host groups and want to use it for querying hosts in selected group only. Here's When you create a variable, you can use it as a part of data source query. Grafana also supports variables in different places like panel's and row's titles, Text panel's content, etc. -![Query with variables](../img/templating-query_with_variables.png) +![Query with variables](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-query_with_variables.png) > Note, that you should add `$` sign before variable's name (**$host** for _host_ variable). diff --git a/docs/src/configuration/troubleshooting.md b/docs/sources/troubleshooting.md similarity index 58% rename from docs/src/configuration/troubleshooting.md rename to docs/sources/troubleshooting.md index a84d15c00..8b08a3d68 100644 --- a/docs/src/configuration/troubleshooting.md +++ b/docs/sources/troubleshooting.md @@ -1,4 +1,18 @@ -# Troubleshooting +--- +title: Troubleshooting +menuTitle: Troubleshooting +description: Troubleshooting guide for Grafana-Zabbix plugin. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 330 +--- + 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/upgrade.md b/docs/sources/upgrade.md new file mode 100644 index 000000000..289d49701 --- /dev/null +++ b/docs/sources/upgrade.md @@ -0,0 +1,20 @@ +--- +title: Upgrade +menuTitle: Upgrade +description: Upgrade instructions for Grafana-Zabbix. +aliases: +keywords: + - data source + - zabbix +labels: + products: + - oss + - grafana cloud +weight: 220 +--- + +## Upgrade from 2.x + +After [enabling](../../configuration/#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. diff --git a/docs/src/configuration/provisioning.md b/docs/src/configuration/provisioning.md deleted file mode 100644 index 4a3209419..000000000 --- a/docs/src/configuration/provisioning.md +++ /dev/null @@ -1,55 +0,0 @@ -page_title: Provisioning Grafana-Zabbix plugin -page_description: Grafana-Zabbix plugin provisioning instructions. - -# 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 - -```yaml -apiVersion: 1 - -datasources: -- name: Zabbix - type: alexanderzobnin-zabbix-datasource - access: proxy - url: http://localhost/zabbix/api_jsonrpc.php - isDefault: true - jsonData: - # Zabbix API credentials - username: zabbix - password: zabbix - # Trends options - trends: true - trendsFrom: "7d" - trendsRange: "4d" - # Cache update interval - cacheTTL: "1h" - # Alerting options - alerting: true - addThresholds: false - alertingMinSeverity: 3 - # Direct DB Connection options - dbConnectionEnable: true - # Name of existing datasource for Direct DB Connection - dbConnectionDatasourceName: MySQL Zabbix - # Retention policy name (InfluxDB only) for fetching long-term stored data. - # Leave it blank if only default retention policy used. - dbConnectionRetentionPolicy: one_year - # Disable acknowledges for read-only users - disableReadOnlyUsersAck: true - # Disable time series data alignment - disableDataAlignment: false - # Use value mapping from Zabbix - useZabbixValueMapping: true - version: 1 - editable: false - -- name: MySQL Zabbix - type: mysql - url: localhost:3306 - database: zabbix - user: grafana - password: password -``` diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css deleted file mode 100644 index 94fcc7392..000000000 --- a/docs/src/css/custom.css +++ /dev/null @@ -1,115 +0,0 @@ -@import url('https://fonts.googleapis.com/css?family=Roboto|Source+Code+Pro'); - -.wy-side-nav-search, .wy-nav-top { - background-color: #8e3030; -} - -.wy-side-nav-search input[type=text] { - border-radius: 2px; - width: 100%; - border-color: #e3e3e3; -} - -/* Content container */ -.wy-nav-content { - max-width: 1200px; -} - -.rst-content .section { - color: #404040; - font-family: 'Roboto', 'Lato', 'proxima-nova', 'Helvetica Neue', Arial, sans-serif; -} - -.rst-content p { - margin-bottom: 16px; - line-height: 24px; -} - -.rst-content li { - margin-top: 6px; - margin-bottom: 6px; - line-height: 24px; -} - -.rst-content img { - max-width: 80%; - max-height: 800px; -} - -.rst-content blockquote { - max-width: 80%; - margin-left: 0em; - padding: 0 1em; - color: #757575; - border-left: 6px solid #e0e0e0; -} - -/* Source code highlighting */ - -code, .rst-content tt { - font-family: 'Source Code Pro', monospace; - font-size: 90%; - color: #404040; - background-color: #f4f4f4; - padding: 1px 5px; - border-radius: 2px; - border-width: 0; -} - -.hljs { - max-width: 100%; - - /* Colors are from solarized scheme. */ - background-color: #fdf6e3; - color: #657b83; - - border-width: 0 0 0 4px; - border-color: #eee8d5; - border-left-color: #268bd2; - - font-size: 90%; - line-height: 1.5; - padding: 0.5em 1em; -} - -.hljs-keyword { - color: #dc322f; -} - -.hljs-built_in { - color: #268bd2; -} - -.hljs-string { - color: #859900; -} - -.hljs-variable { - color: #6c71c4; -} - -.btn-neutral:hover { - background-color: #8e3030 !important; - color: #f4f4f4 !important; - box-shadow: - 0px 1px 2px -1px rgba(255,255,255,0.5) inset, - 0px -2px 0px 0px rgba(0, 0, 0, 0.2) inset; -} - -/* Functions list tweaks */ - -h3 em { - font-family: 'Source Code Pro', monospace; - line-height: 2; - padding-top: 20px; - font-style: normal; - padding-bottom: 2px; - border-bottom: 2px; - border-bottom-style: solid; - border-bottom-color: #2aa198; - color: #01579b; -} - -hr { - margin: 24px 0 48px 0; -} diff --git a/docs/src/img/.gitattributes b/docs/src/img/.gitattributes deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/src/installation/upgrade.md b/docs/src/installation/upgrade.md deleted file mode 100644 index 045724aaa..000000000 --- a/docs/src/installation/upgrade.md +++ /dev/null @@ -1,10 +0,0 @@ -page_title: Grafana-Zabbix Upgrade -page_description: Upgrade instructions for Grafana-Zabbix. - -# Upgrade - -## Upgrade from 2.x - -After [enabling](../../configuration/#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. diff --git a/docs/src/reference/datasource-zabbix.md b/docs/src/reference/datasource-zabbix.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/src/reference/panel-triggers.md b/docs/src/reference/panel-triggers.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/src/tutorials/host_dashboard.md b/docs/src/tutorials/host_dashboard.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx b/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx index 7cb1f4cd5..e775d4f72 100644 --- a/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx +++ b/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx @@ -2,7 +2,7 @@ import React from 'react'; import { Icon } from '@grafana/ui'; import { MetricFunc } from '../../types'; -const DOCS_FUNC_REF_URL = 'https://grafana.github.io/grafana-zabbix/reference/functions/'; +const DOCS_FUNC_REF_URL = 'https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/'; export interface FunctionEditorControlsProps { onMoveLeft: (func: MetricFunc) => void; diff --git a/src/plugin.json b/src/plugin.json index 67df813b1..fe1f6524a 100644 --- a/src/plugin.json +++ b/src/plugin.json @@ -8,9 +8,7 @@ "name": "Grafana Labs", "url": "https://grafana.com" }, - "keywords": [ - "zabbix" - ], + "keywords": ["zabbix"], "logos": { "small": "img/icn-zabbix-app.svg", "large": "img/icn-zabbix-app.svg" @@ -22,11 +20,11 @@ }, { "name": "Docs", - "url": "https://grafana.github.io/grafana-zabbix" + "url": "https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/" }, { "name": "License", - "url": "https://github.com/grafana/grafana-zabbix/blob/master/LICENSE" + "url": "https://github.com/grafana/grafana-zabbix/blob/main/LICENSE" } ], "screenshots": [ From 36c08ea1710cf6dc2d6973432cf83bad4df80b42 Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Wed, 20 Dec 2023 07:15:13 +0000 Subject: [PATCH 2/8] bumped the version and updated changelog --- CHANGELOG.md | 4 ++++ package.json | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a5fe3ac94..164666e29 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Change Log +## [4.4.5] - 2023-12-20 + +- ⚙️ **Docs**: Documentation website moved from [github pages](https://grafana.github.io/grafana-zabbix) to [grafana.com/docs/plugins](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) page + ## [4.4.4] - 2023-11-21 ### Feature diff --git a/package.json b/package.json index e7fb600fe..6702cdd64 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "grafana-zabbix", - "version": "4.4.4", + "version": "4.4.5", "description": "Zabbix plugin for Grafana", "homepage": "http://grafana-zabbix.org", "bugs": { From a6b91bbd86e4972258993abc3b30915863a43c3e Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Wed, 20 Dec 2023 07:18:16 +0000 Subject: [PATCH 3/8] fix references of master branch --- .github/pull_request_template.md | 2 +- README.md | 2 +- docs/sources/installation.md | 2 +- docs/sources/{run_from_main.md => run-from-main.md} | 0 4 files changed, 3 insertions(+), 3 deletions(-) rename docs/sources/{run_from_main.md => run-from-main.md} (100%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 7d8fa8d57..b51ba9ef9 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,6 @@ * Link the PR to the related issue * If there's no issue for the PR, please, create it first -* Rebase your PR if it gets out of sync with master +* Rebase your PR if it gets out of sync with main * Ensure your PR does not include dist/ directory **REMOVE THE TEXT ABOVE BEFORE CREATING THE PULL REQUEST** diff --git a/README.md b/README.md index df1986234..6d00f43bf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Zabbix plugin for Grafana [![Version](https://badge.fury.io/gh/grafana%2Fgrafana-zabbix.svg)](https://github.com/grafana/grafana-zabbix/releases) -[![Change Log](https://img.shields.io/badge/change-log-blue.svg?style=flat)](https://github.com/grafana/grafana-zabbix/blob/master/CHANGELOG.md) +[![Change Log](https://img.shields.io/badge/change-log-blue.svg?style=flat)](https://github.com/grafana/grafana-zabbix/blob/main/CHANGELOG.md) [![Docs](https://img.shields.io/badge/docs-latest-red.svg?style=flat)](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) ![Dashboard](https://user-images.githubusercontent.com/4932851/53799185-e1cdc700-3f4a-11e9-9cb4-8330f501b32e.png) diff --git a/docs/sources/installation.md b/docs/sources/installation.md index 6ba889a79..2634a832b 100644 --- a/docs/sources/installation.md +++ b/docs/sources/installation.md @@ -49,4 +49,4 @@ Starting from version 4.0, each plugin release on GitHub contains packaged plugi ## Building from sources -If you want to build a package yourself, or contribute - read [building instructions](./run_from_master). +If you want to build a package yourself, or contribute - read [building instructions](./run-from-main). diff --git a/docs/sources/run_from_main.md b/docs/sources/run-from-main.md similarity index 100% rename from docs/sources/run_from_main.md rename to docs/sources/run-from-main.md From ef24d1fcb4c1df0bb023333d95d405d80da2f587 Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Wed, 20 Dec 2023 11:32:04 +0000 Subject: [PATCH 4/8] setup docs hirearchy --- README.md | 18 +++++++++--------- .../_index.md} | 0 .../direct-db-datasource.md | 0 .../{ => configuration}/provisioning.md | 0 .../{ => configuration}/troubleshooting.md | 0 docs/sources/{ => guides}/gettingstarted.md | 0 docs/sources/{ => guides}/templating.md | 0 .../_index.md} | 2 +- .../building-from-sources.md} | 4 ++-- docs/sources/{ => installation}/upgrade.md | 0 docs/sources/{ => reference}/alerting.md | 0 .../{ => reference}/direct-db-connection.md | 0 docs/sources/{ => reference}/functions.md | 0 .../FunctionEditor/FunctionEditorControls.tsx | 2 +- 14 files changed, 13 insertions(+), 13 deletions(-) rename docs/sources/{configuration.md => configuration/_index.md} (100%) rename docs/sources/{ => configuration}/direct-db-datasource.md (100%) rename docs/sources/{ => configuration}/provisioning.md (100%) rename docs/sources/{ => configuration}/troubleshooting.md (100%) rename docs/sources/{ => guides}/gettingstarted.md (100%) rename docs/sources/{ => guides}/templating.md (100%) rename docs/sources/{installation.md => installation/_index.md} (97%) rename docs/sources/{run-from-main.md => installation/building-from-sources.md} (88%) rename docs/sources/{ => installation}/upgrade.md (100%) rename docs/sources/{ => reference}/alerting.md (100%) rename docs/sources/{ => reference}/direct-db-connection.md (100%) rename docs/sources/{ => reference}/functions.md (100%) diff --git a/README.md b/README.md index 6d00f43bf..75205e4e9 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,12 @@ ## Features -- Select multiple metrics [by using Regex](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted/#multiple-items-on-one-graph) -- Create interactive and reusable dashboards with [template variables](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/templating/) +- Select multiple metrics [by using Regex](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/guides/gettingstarted/#multiple-items-on-one-graph) +- Create interactive and reusable dashboards with [template variables](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/guides/templating/) - Show events on graphs with [Annotations](http://docs.grafana.org/reference/annotations/) - Display active problems with Triggers panel -- Transform and shape your data with [metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) -- Find problems faster with [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/alerting/) feature +- Transform and shape your data with [metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/reference/functions/) (Avg, Median, Min, Max, Multiply, Summarize, Time shift, Alias) +- Find problems faster with [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/reference/alerting/) feature - Mix metrics from multiple data sources in the same dashboard or even graph - Discover and share [dashboards](https://grafana.com/dashboards) in the official library @@ -32,16 +32,16 @@ Or see more installation options in [docs](https://grafana.com/docs/plugins/alex ## Getting started -First, [configure](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted/). +First, [configure](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/configuration/) Zabbix data source. Then you can create your first dashboard with step-by-step [Getting started guide](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/guides/gettingstarted/). ## Documentation - [About](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) - [Installation](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/installation) -- [Getting Started](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/gettingstarted) -- [Templating](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/templating) -- [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/alerting/) -- [Metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/) +- [Getting Started](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/guides/gettingstarted) +- [Templating](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/guides/templating) +- [Alerting](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/reference/alerting/) +- [Metric processing functions](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/reference/functions/) ## Community Resources, Feedback, and Support diff --git a/docs/sources/configuration.md b/docs/sources/configuration/_index.md similarity index 100% rename from docs/sources/configuration.md rename to docs/sources/configuration/_index.md diff --git a/docs/sources/direct-db-datasource.md b/docs/sources/configuration/direct-db-datasource.md similarity index 100% rename from docs/sources/direct-db-datasource.md rename to docs/sources/configuration/direct-db-datasource.md diff --git a/docs/sources/provisioning.md b/docs/sources/configuration/provisioning.md similarity index 100% rename from docs/sources/provisioning.md rename to docs/sources/configuration/provisioning.md diff --git a/docs/sources/troubleshooting.md b/docs/sources/configuration/troubleshooting.md similarity index 100% rename from docs/sources/troubleshooting.md rename to docs/sources/configuration/troubleshooting.md diff --git a/docs/sources/gettingstarted.md b/docs/sources/guides/gettingstarted.md similarity index 100% rename from docs/sources/gettingstarted.md rename to docs/sources/guides/gettingstarted.md diff --git a/docs/sources/templating.md b/docs/sources/guides/templating.md similarity index 100% rename from docs/sources/templating.md rename to docs/sources/guides/templating.md diff --git a/docs/sources/installation.md b/docs/sources/installation/_index.md similarity index 97% rename from docs/sources/installation.md rename to docs/sources/installation/_index.md index 2634a832b..48fb40a1f 100644 --- a/docs/sources/installation.md +++ b/docs/sources/installation/_index.md @@ -49,4 +49,4 @@ Starting from version 4.0, each plugin release on GitHub contains packaged plugi ## Building from sources -If you want to build a package yourself, or contribute - read [building instructions](./run-from-main). +If you want to build a package yourself, or contribute - read [building instructions](./building-from-sources). diff --git a/docs/sources/run-from-main.md b/docs/sources/installation/building-from-sources.md similarity index 88% rename from docs/sources/run-from-main.md rename to docs/sources/installation/building-from-sources.md index b9480d18c..be95082fe 100644 --- a/docs/sources/run-from-main.md +++ b/docs/sources/installation/building-from-sources.md @@ -1,6 +1,6 @@ --- -title: Run Grafana-Zabbix from main branch -menuTitle: Run Grafana-Zabbix from main branch +title: Building from sources +menuTitle: Building from sources description: Building instructions for Grafana-Zabbix. aliases: keywords: diff --git a/docs/sources/upgrade.md b/docs/sources/installation/upgrade.md similarity index 100% rename from docs/sources/upgrade.md rename to docs/sources/installation/upgrade.md diff --git a/docs/sources/alerting.md b/docs/sources/reference/alerting.md similarity index 100% rename from docs/sources/alerting.md rename to docs/sources/reference/alerting.md diff --git a/docs/sources/direct-db-connection.md b/docs/sources/reference/direct-db-connection.md similarity index 100% rename from docs/sources/direct-db-connection.md rename to docs/sources/reference/direct-db-connection.md diff --git a/docs/sources/functions.md b/docs/sources/reference/functions.md similarity index 100% rename from docs/sources/functions.md rename to docs/sources/reference/functions.md diff --git a/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx b/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx index e775d4f72..1c0e8dd73 100644 --- a/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx +++ b/src/datasource/components/FunctionEditor/FunctionEditorControls.tsx @@ -2,7 +2,7 @@ import React from 'react'; import { Icon } from '@grafana/ui'; import { MetricFunc } from '../../types'; -const DOCS_FUNC_REF_URL = 'https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/functions/'; +const DOCS_FUNC_REF_URL = 'https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/reference/functions/'; export interface FunctionEditorControlsProps { onMoveLeft: (func: MetricFunc) => void; From b8c85cd5624f44ef1c17783f7adcd2c78e13ee5d Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Thu, 4 Jan 2024 11:47:08 +0000 Subject: [PATCH 5/8] tools required for docs --- docs/Makefile | 8 + docs/docs.mk | 112 +++++++ docs/make-docs | 800 ++++++++++++++++++++++++++++++++++++++++++++++ docs/variables.mk | 2 + 4 files changed, 922 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/docs.mk create mode 100755 docs/make-docs create mode 100644 docs/variables.mk diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..2ea93f455 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,8 @@ +.ONESHELL: +.DELETE_ON_ERROR: +export SHELL := bash +export SHELLOPTS := pipefail:errexit +MAKEFLAGS += --warn-undefined-variables +MAKEFLAGS += --no-builtin-rule + +include docs.mk \ No newline at end of file diff --git a/docs/docs.mk b/docs/docs.mk new file mode 100644 index 000000000..ad04633e4 --- /dev/null +++ b/docs/docs.mk @@ -0,0 +1,112 @@ +# The source of this file is https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk. +# A changelog is included in the head of the `make-docs` script. +include variables.mk +-include variables.mk.local + +.ONESHELL: +.DELETE_ON_ERROR: +export SHELL := bash +export SHELLOPTS := pipefail:errexit +MAKEFLAGS += --warn-undefined-variables +MAKEFLAGS += --no-builtin-rule + +.DEFAULT_GOAL: help + +# Adapted from https://www.thapaliya.com/en/writings/well-documented-makefiles/ +.PHONY: help +help: ## Display this help. +help: + @awk 'BEGIN { \ + FS = ": ##"; \ + printf "Usage:\n make \n\nTargets:\n" \ + } \ + /^[a-zA-Z0-9_\.\-\/%]+: ##/ { printf " %-15s %s\n", $$1, $$2 }' \ + $(MAKEFILE_LIST) + +GIT_ROOT := $(shell git rev-parse --show-toplevel) + +PODMAN := $(shell if command -v podman >/dev/null 2>&1; then echo podman; else echo docker; fi) + +ifeq ($(PROJECTS),) +$(error "PROJECTS variable must be defined in variables.mk") +endif + +# First project is considered the primary one used for doc-validator. +PRIMARY_PROJECT := $(subst /,-,$(firstword $(subst :, ,$(firstword $(PROJECTS))))) + +# Host port to publish container port to. +ifeq ($(origin DOCS_HOST_PORT), undefined) +export DOCS_HOST_PORT := 3002 +endif + +# Container image used to perform Hugo build. +ifeq ($(origin DOCS_IMAGE), undefined) +export DOCS_IMAGE := grafana/docs-base:latest +endif + +# Container image used for doc-validator linting. +ifeq ($(origin DOC_VALIDATOR_IMAGE), undefined) +export DOC_VALIDATOR_IMAGE := grafana/doc-validator:latest +endif + +# Container image used for vale linting. +ifeq ($(origin VALE_IMAGE), undefined) +export VALE_IMAGE := grafana/vale:latest +endif + +# PATH-like list of directories within which to find projects. +# If all projects are checked out into the same directory, ~/repos/ for example, then the default should work. +ifeq ($(origin REPOS_PATH), undefined) +export REPOS_PATH := $(realpath $(GIT_ROOT)/..) +endif + +# How to treat Hugo relref errors. +ifeq ($(origin HUGO_REFLINKSERRORLEVEL), undefined) +export HUGO_REFLINKSERRORLEVEL := WARNING +endif + +.PHONY: docs-rm +docs-rm: ## Remove the docs container. + $(PODMAN) rm -f $(DOCS_CONTAINER) + +.PHONY: docs-pull +docs-pull: ## Pull documentation base image. + $(PODMAN) pull -q $(DOCS_IMAGE) + +make-docs: ## Fetch the latest make-docs script. +make-docs: + if [[ ! -f "$(CURDIR)/make-docs" ]]; then + echo 'WARN: No make-docs script found in the working directory. Run `make update` to download it.' >&2 + exit 1 + fi + +.PHONY: docs +docs: ## Serve documentation locally, which includes pulling the latest `DOCS_IMAGE` (default: `grafana/docs-base:latest`) container image. See also `docs-no-pull`. +docs: docs-pull make-docs + $(CURDIR)/make-docs $(PROJECTS) + +.PHONY: docs-no-pull +docs-no-pull: ## Serve documentation locally without pulling the `DOCS_IMAGE` (default: `grafana/docs-base:latest`) container image. +docs-no-pull: make-docs + $(CURDIR)/make-docs $(PROJECTS) + +.PHONY: docs-debug +docs-debug: ## Run Hugo web server with debugging enabled. TODO: support all SERVER_FLAGS defined in website Makefile. +docs-debug: make-docs + WEBSITE_EXEC='hugo server --bind 0.0.0.0 --port 3002 --debug' $(CURDIR)/make-docs $(PROJECTS) + +.PHONY: doc-validator +doc-validator: ## Run doc-validator on the entire docs folder. +doc-validator: make-docs + DOCS_IMAGE=$(DOC_VALIDATOR_IMAGE) $(CURDIR)/make-docs $(PROJECTS) + +.PHONY: vale +vale: ## Run vale on the entire docs folder. +vale: make-docs + DOCS_IMAGE=$(VALE_IMAGE) $(CURDIR)/make-docs $(PROJECTS) + +.PHONY: update +update: ## Fetch the latest version of this Makefile and the `make-docs` script from Writers' Toolkit. + curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/docs.mk + curl -s -LO https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs + chmod +x make-docs \ No newline at end of file diff --git a/docs/make-docs b/docs/make-docs new file mode 100755 index 000000000..34d470156 --- /dev/null +++ b/docs/make-docs @@ -0,0 +1,800 @@ +#!/bin/sh +# The source of this file is https://raw.githubusercontent.com/grafana/writers-toolkit/main/docs/make-docs. +# # `make-docs` procedure changelog +# +# Updates should conform to the guidelines in https://keepachangelog.com/en/1.1.0/. +# [Semantic versioning](https://semver.org/) is used to help the reader identify the significance of changes. +# Changes are relevant to this script and the support docs.mk GNU Make interface. +# + +# ## 5.1.2 (2023-11-08) +# +# ### Added +# +# - Hide manual_mount warning messages from non-debug output. +# Set the DEBUG environment variable to see all hidden messages. +# +# ## 5.1.1 (2023-10-30) +# +# ### Added +# +# - Support for Datadog and Oracle data source plugins repositories. +# +# ## 5.1.0 (2023-10-20) +# +# ### Added +# +# - Support for the plugins monorepo. +# +# ## 5.0.0 (2023-10-18) +# +# ### Added +# +# - Improved support for website repository. +# +# Mount more content and provide some feedback to users that the build can take time. +# +# - Ability to enter the `grafana/docs-base` container with a shell using the `ENTER` environment variable. +# +# ### Fixed +# +# - Correct key combination for interrupting the process. +# +# Keyboards use capital letters so this more accurately reflects the exact key combination users are expected to press. +# +# ### Removed +# +# - Imperfect implementation of container name. +# +# Facilitates running `make vale` and `make docs` at once. +# Container names are convenient for recognition in `docker ps` but the current implementation has more downsides than upsides. +# +# - Forced platform specification now that multiple architecture images exist. +# +# Significantly speeds up build times on larger repositories. +# +# ## 4.2.2 (2023-10-05) + +# - Added support for Jira data source and MongoDB data source plugins repositories. +# +# ## 4.2.1 (2023-09-13) + +# ## Fixed +# +# - Improved consistency of the webserver request loop by polling the Hugo port rather than the proxy port. +# +# ## 4.2.0 (2023-09-01) +# +# ### Added +# +# - Retry the initial webserver request up to ten times to allow for the process to start. +# If it is still failing after ten seconds, an error message is logged. +# +# ## 4.1.1 (2023-07-20) +# +# ### Fixed +# +# - Replaced use of `realpath` with POSIX compatible alternative to determine default value for REPOS_PATH. +# +# ## 4.1.0 (2023-06-16) +# +# ### Added +# +# - Mounts of `layouts` and `config` directories for the `website` project. +# Ensures that local changes to mounts or shortcodes are reflected in the development server. +# +# ### Fixed +# +# - Version inference for versioned docs pages. +# Pages in versioned projects now have the `versioned: true` front matter set to ensure that "version" in $.Page.Scratch is set on builds. +# +# ## 4.0.0 (2023-06-06) +# +# ### Removed +# +# - `doc-validator/%` target. +# The behavior of the target was not as described. +# Instead, to limit `doc-validator` to only specific files, refer to https://grafana.com/docs/writers-toolkit/writing-guide/tooling-and-workflows/validate-technical-documentation/#run-on-specific-files. +# +# ## 3.0.0 (2023-05-18) +# +# ### Fixed +# +# - Compatibility with the updated Make targets in the `website` repository. +# `docs` now runs this script itself, `server-docs` builds the site with the `docs` Hugo environment. +# +# ## 2.0.0 (2023-05-18) +# +# ### Added +# +# - Support for the grafana-cloud/frontend-observability/faro-web-sdk project. +# - Use of `doc-validator` v2.0.x which includes breaking changes to command line options. +# +# ### Fixed +# +# - Source grafana-cloud project from website repository. +# +# ### Added +# +# - Support for running the Vale linter with `make vale`. +# +# ## 1.2.1 (2023-05-05) +# +# ### Fixed +# +# - Use `latest` tag of `grafana/vale` image by default instead of hardcoded older version. +# - Fix mounting multiple projects broken by the changes in 1.0.1 +# +# ## 1.2.0 (2023-05-05) +# +# ### Added +# +# - Support for running the Vale linter with `make vale`. +# +# ### Fixed +# +# ## 1.1.0 (2023-05-05) +# +# ### Added +# +# - Rewrite error output so it can be followed by text editors. +# +# ### Fixed +# +# - Fix `docs-debug` container process port. +# +# ## 1.0.1 (2023-05-04) +# +# ### Fixed +# +# - Ensure complete section hierarchy so that all projects have a visible menu. +# +# ## 1.0.0 (2023-05-04) +# +# ### Added +# +# - Build multiple projects simultaneously if all projects are checked out locally. +# - Run [`doc-validator`](https://github.com/grafana/technical-documentation/tree/main/tools/cmd/doc-validator) over projects. +# - Redirect project root to mounted version. +# For example redirect `/docs/grafana/` to `/docs/grafana/latest/`. +# - Support for Podman or Docker containers with `PODMAN` environment variable. +# - Support for projects: +# - agent +# - enterprise-logs +# - enterprise-metrics +# - enterprise-traces +# - grafana +# - grafana-cloud +# - grafana-cloud/machine-learning +# - helm-charts/mimir-distributed +# - helm-charts/tempo-distributed +# - incident +# - loki +# - mimir +# - oncall +# - opentelemetry +# - phlare +# - plugins +# - slo +# - tempo +# - writers-toolkit + + +set -ef + +readonly DOCS_HOST_PORT="${DOCS_HOST_PORT:-3002}" +readonly DOCS_IMAGE="${DOCS_IMAGE:-grafana/docs-base:latest}" + +readonly DOC_VALIDATOR_INCLUDE="${DOC_VALIDATOR_INCLUDE:-.+\.md$}" +readonly DOC_VALIDATOR_SKIP_CHECKS="${DOC_VALIDATOR_SKIP_CHECKS:-^image-}" + +readonly HUGO_REFLINKSERRORLEVEL="${HUGO_REFLINKSERRORLEVEL:-WARNING}" +readonly VALE_MINALERTLEVEL="${VALE_MINALERTLEVEL:-error}" +readonly WEBSITE_EXEC="${WEBSITE_EXEC:-make server-docs}" +# If set, the docs-base image will run a prebuild script that sets up Hugo mounts. +readonly WEBSITE_MOUNTS="${WEBSITE_MOUNTS:-}" + +PODMAN="$(if command -v podman >/dev/null 2>&1; then echo podman; else echo docker; fi)" + +if ! command -v curl >/dev/null 2>&1; then + if ! command -v wget >/dev/null 2>&1; then + errr 'either `curl` or `wget` must be installed for this script to work.' + + exit 1 + fi +fi + +if ! command -v "${PODMAN}" >/dev/null 2>&1; then + errr 'either `podman` or `docker` must be installed for this script to work.' + + exit 1 +fi + + +about() { + cat <...]> $0 [[:[:[:]]]...] + +Examples: + REPOS_PATH=~/ext/grafana/ $0 writers-toolkit tempo:latest helm-charts/mimir-distributed:latest:mimir:docs/sources/mimir-distributed +EOF +} + +if [ $# -lt 1 ]; then + cat <&2 +ERRR: arguments required but not supplied. + +$(about) + +$(usage) +EOF + exit 1 +fi + +readonly REPOS_PATH="${REPOS_PATH:-$(cd "$(git rev-parse --show-toplevel)/.." && echo "${PWD}")}" + +if [ -z "${REPOS_PATH}" ]; then + cat <&2 +ERRR: REPOS_PATH environment variable is required but has not been provided. + +$(usage) +EOF + exit 1 +fi + +SOURCES_as_code='as-code-docs' +SOURCES_enterprise_metrics='backend-enterprise' +SOURCES_enterprise_metrics_='backend-enterprise' +SOURCES_grafana_cloud='website' +SOURCES_grafana_cloud_alerting_and_irm_machine_learning='machine-learning' +SOURCES_grafana_cloud_alerting_and_irm_slo='slo' +SOURCES_grafana_cloud_k6='k6-docs' +SOURCES_grafana_cloud_data_configuration_integrations='cloud-onboarding' +SOURCES_grafana_cloud_frontend_observability_faro_web_sdk='faro-web-sdk' +SOURCES_helm_charts_mimir_distributed='mimir' +SOURCES_helm_charts_tempo_distributed='tempo' +SOURCES_opentelemetry='opentelemetry-docs' +SOURCES_plugins_grafana_datadog_datasource='datadog-datasource' +SOURCES_plugins_grafana_jira_datasource='jira-datasource' +SOURCES_plugins_grafana_mongodb_datasource='mongodb-datasource' +SOURCES_plugins_grafana_oracle_datasource='oracle-datasource' +SOURCES_plugins_grafana_splunk_datasource='splunk-datasource' +SOURCES_plugins_yesoreyeram_infinity_datasource='infinity' +SOURCES_plugins_alexanderzobnin_zabbix_app='zabbix' + +VERSIONS_as_code='UNVERSIONED' +VERSIONS_grafana_cloud='UNVERSIONED' +VERSIONS_grafana_cloud_alerting_and_irm_machine_learning='UNVERSIONED' +VERSIONS_grafana_cloud_alerting_and_irm_slo='UNVERSIONED' +VERSIONS_grafana_cloud_k6='UNVERSIONED' +VERSIONS_grafana_cloud_data_configuration_integrations='UNVERSIONED' +VERSIONS_grafana_cloud_frontend_observability_faro_web_sdk='UNVERSIONED' +VERSIONS_opentelemetry='UNVERSIONED' +VERSIONS_plugins_grafana_datadog_datasource='latest' +VERSIONS_plugins_grafana_jira_datasource='latest' +VERSIONS_plugins_grafana_mongodb_datasource='latest' +VERSIONS_plugins_grafana_oracle_datasource='latest' +VERSIONS_plugins_grafana_splunk_datasource='latest' +VERSIONS_plugins_yesoreyeram_infinity_datasource='latest' +VERSIONS_plugins_alexanderzobnin_zabbix_app='latest' +VERSIONS_technical_documentation='UNVERSIONED' +VERSIONS_website='UNVERSIONED' +VERSIONS_writers_toolkit='UNVERSIONED' + +PATHS_grafana_cloud='content/docs/grafana-cloud' +PATHS_helm_charts_mimir_distributed='docs/sources/helm-charts/mimir-distributed' +PATHS_helm_charts_tempo_distributed='docs/sources/helm-charts/tempo-distributed' +PATHS_mimir='docs/sources/mimir' +PATHS_plugins_grafana_datadog_datasource='docs/sources' +PATHS_plugins_grafana_jira_datasource='docs/sources' +PATHS_plugins_grafana_mongodb_datasource='docs/sources' +PATHS_plugins_grafana_oracle_datasource='docs/sources' +PATHS_plugins_grafana_splunk_datasource='docs/sources' +PATHS_plugins_yesoreyeram_infinity_datasource='docs/sources' +PATHS_plugins_alexanderzobnin_zabbix_app='docs/sources' +PATHS_tempo='docs/sources/tempo' +PATHS_website='content' + +# identifier STR +# Replace characters that are not valid in an identifier with underscores. +identifier() { + echo "$1" | tr -C '[:alnum:]_\n' '_' +} + +# aget ARRAY KEY +# Get the value of KEY from associative array ARRAY. +# Characters that are not valid in an identifier are replaced with underscores. +aget() { + eval echo '$'"$(identifier "$1")_$(identifier "$2")" +} + +# src returns the project source repository name for a project. +src() { + _project="$1" + + case "${_project}" in + plugins/*) + if [ -z "$(aget SOURCES "${_project}")" ]; then + echo plugins-private + else + aget SOURCES "${_project}" + fi + ;; + *) + if [ -z "$(aget SOURCES "${_project}")" ]; then + echo "${_project}" + else + aget SOURCES "${_project}" + fi + ;; + esac + + unset _project +} + +# path returns the relative path within the repository that contain the docs for a project. +path() { + _project="$1" + + case "${_project}" in + plugins/*) + if [ -z "$(aget PATHS "${_project}")" ]; then + echo "${_project}/docs/sources" + else + aget PATHS "${_project}" + fi + ;; + *) + if [ -z "$(aget PATHS "${_project}")" ]; then + echo "docs/sources" + else + aget PATHS "${_project}" + fi + esac + + unset _project +} + +# version returns the version for a project. Unversioned projects return the special value 'UNVERSIONED'. +version() { + _project="$1" + + case "${_project}" in + plugins/*) + if [ -z "$(aget VERSIONS "${_project}")" ]; then + echo "UNVERSIONED" + else + aget VERSIONS "${_project}" + fi + ;; + *) + if [ -z "$(aget VERSIONS "${_project}")" ]; then + echo latest + else + aget VERSIONS "${_project}" + fi + esac + + unset _project +} + + +# new_proj populates a new project structure. +new_proj() { + _project="$1" + _version="$2" + _repo="$3" + _path="$4" + + # If version is not set, use the script mapping of project to default versions if it exists. + # Fallback to 'latest'. + if [ -z "${_version}" ]; then + _version="$(version "${_project}")" + fi + + # If repo is not set, use the script mapping of project to repo name if it exists. + # Fallback to using the project name. + if [ -z "${_repo}" ]; then + _repo="$(src "${_project}")" + fi + + # If path is not set, use the script mapping of project to docs sources path if it exists. + # Fallback to using 'docs/sources'. + if [ -z "${_path}" ]; then + _path="$(path "${_project}")" + fi + + echo "${_project}:${_version}:${_repo}:${_path}" + unset _project _version _repo _path +} + +# proj_url returns the webserver URL for a project. +# It expects a complete project structure as input. +proj_url() { + IFS=: read -r _project _version _ _ <&2 + fi +} + +errr() { + echo "ERRR: $1" >&2 +} + +note() { + echo "NOTE: $1" >&2 +} + +url_src_dst_vers="$(url_src_dst_vers "$@")" + +volumes="" +redirects="" + +for arg in "$@"; do + IFS=: read -r _project _ _repo _ <"${tempfile}" +#!/usr/bin/env bash + +tc() { + set \${*,,} + echo \${*^} +} + +for redirect in ${redirects}; do + IFS='^' read -r path ver <<<"\${redirect}" + echo -e "---\\nredirectURL: \"\${path/\/hugo\/content/}\"\\ntype: redirect\\nversioned: true\\n---\\n" > "\${path/\${ver}/_index.md}" +done + +for x in "${url_src_dst_vers}"; do + IFS='^' read -r _ _ dst _ <<<"\${x}" + + title="\${dst%/*}" + title="\$(tc \${title##*/})" + while [[ -n "\${dst}" ]]; do + if [[ ! -f "\${dst}/_index.md" ]]; then + echo -e "---title: \${title}\\n---\\n\\n# \${title}\\n\\n{{< section >}}" > "\${dst}/_index.md" + fi + dst="\${dst%/*}" + done +done + +if [[ -n "${WEBSITE_MOUNTS}" ]]; then + unset WEBSITE_SKIP_MOUNTS +fi + +${WEBSITE_EXEC} +EOF + chmod +x "${tempfile}" + volumes="${volumes} --volume=${tempfile}:/entrypoint" + readonly volumes + + IFS='' read -r cmd <&1\ + | sed -u \ + -e '/Web Server is available at http:\/\/localhost:3003\/ (bind address 0.0.0.0)/ d' \ + -e '/^hugo server/ d' \ + -e '/fatal: not a git repository (or any parent up to mount point \/)/ d' \ + -e '/Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set)./ d' \ + -e "/Makefile:[0-9]*: warning: overriding recipe for target 'docs'/ d" \ + -e "/docs.mk:[0-9]*: warning: ignoring old recipe for target 'docs'/ d" \ + -e '/\/usr\/bin\/make -j 2 proxy hserver-docs HUGO_PORT=3003/ d' \ + -e '/website-proxy/ d' \ + -e '/rm -rf dist*/ d' \ + -e '/Press Ctrl+C to stop/ d' \ + -e '/make/ d' \ + -e '/WARNING: The manual_mount source directory/ d' + fi + ;; +esac \ No newline at end of file diff --git a/docs/variables.mk b/docs/variables.mk new file mode 100644 index 000000000..85a45a5d4 --- /dev/null +++ b/docs/variables.mk @@ -0,0 +1,2 @@ +# List of projects to provide to the make-docs script. +PROJECTS = plugins/alexanderzobnin-zabbix-app \ No newline at end of file From 2af45e8f847cd2d2296c9253308aa1dade84508c Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Thu, 4 Jan 2024 11:47:29 +0000 Subject: [PATCH 6/8] title updates for docs --- docs/sources/_index.md | 8 +++++--- docs/sources/configuration/_index.md | 2 ++ .../configuration/direct-db-datasource.md | 2 ++ docs/sources/configuration/provisioning.md | 4 +++- docs/sources/configuration/troubleshooting.md | 2 ++ docs/sources/features.md | 2 ++ .../guides/{gettingstarted.md => _index.md} | 6 ++++-- docs/sources/guides/templating.md | 2 ++ docs/sources/installation/_index.md | 2 ++ .../installation/building-from-sources.md | 2 ++ docs/sources/installation/upgrade.md | 2 ++ docs/sources/reference/_index.md | 20 +++++++++++++++++++ 12 files changed, 48 insertions(+), 6 deletions(-) rename docs/sources/guides/{gettingstarted.md => _index.md} (97%) create mode 100644 docs/sources/reference/_index.md diff --git a/docs/sources/_index.md b/docs/sources/_index.md index b2f490047..455cafb94 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 d177cad1c..24b4b99e9 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 474235ac7..67648481c 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 6ece225ae..1e0cc5028 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 8b08a3d68..d52d8d11d 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 9079eea3d..8d228bfc9 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 0f8791f9c..578b7f045 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 c0a668d78..8a4ae6daf 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 48fb40a1f..902c55730 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 be95082fe..017e2de85 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 289d49701..f77088b7e 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 000000000..6d5e921a8 --- /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 From a3daff76e93d9323e41567626810eaa20a907692 Mon Sep 17 00:00:00 2001 From: Sriramajeyam Sugumaran <153843+yesoreyeram@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:45:55 +0000 Subject: [PATCH 7/8] License and docs index page update --- LICENSE | 2 +- docs/sources/_index.md | 12 +----------- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/LICENSE b/LICENSE index d7b33b675..d59f1f8f0 100644 --- a/LICENSE +++ b/LICENSE @@ -186,7 +186,7 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright 2015-2016 Alexander Zobnin + Copyright 2024 Grafana Labs (https://grafana.com) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 455cafb94..4656ec5dc 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -30,18 +30,8 @@ If you have any troubles with Grafana or you just want clarification on a featur a number of ways to get help: - [Troubleshooting guide](./configuration/troubleshooting/) -- Search closed and open [issues on GitHub](https://github.com/grafana/grafana/issues) +- Search closed and open [issues on GitHub](https://github.com/grafana/grafana-zabbix/issues) - [Grafana Community](https://community.grafana.com) -- [Twitter](https://twitter.com/AlexanderZobnin) - -Or you can send me [email](mailto:alexanderzobnin@gmail.com). - -## Support Project - -I develop this project in my free time, but if you really find it helpful and promising, you can -support me. There are some ways to do this. You can [donate](https://www.paypal.me/alexanderzobnin) -any reasonable amount, or you can request a feature development, interesting for you (for example, -Triggers panel was sponsored by [Core IT Project](http://coreit.fr/)). ## License From 79810c76e87d66dbf22b0adde28ee2689904e510 Mon Sep 17 00:00:00 2001 From: Sriram <153843+yesoreyeram@users.noreply.github.com> Date: Wed, 10 Jan 2024 13:23:29 +0000 Subject: [PATCH 8/8] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 164666e29..e06b7c28f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Change Log -## [4.4.5] - 2023-12-20 +## [4.4.5] - 2024-01-10 - ⚙️ **Docs**: Documentation website moved from [github pages](https://grafana.github.io/grafana-zabbix) to [grafana.com/docs/plugins](https://grafana.com/docs/plugins/alexanderzobnin-zabbix-app/latest/) page