Misthios/grafana-zabbix
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs: rename image paths (#1774)

Browse Source
This commit is contained in:
rafaeldaetwyler
2024-01-12 08:41:22 +01:00
committed by GitHub
parent a7c2672020
commit 5787afb76f
5 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/sources/configuration/_index.md
View File

@@ -20,7 +20,7 @@ weight: 300
Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_ Go to the plugins in Grafana side panel, select _Apps_ tab, then select _Zabbix_, open _Config_
tab and enable plugin. tab and enable plugin.
![Enable Zabbix App](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-enable_app.png) ![Enable Zabbix App](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/installation-enable_app.png)
## Configure Zabbix data source ## Configure Zabbix data source
@@ -28,7 +28,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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-datasource_config.png) ![Configure Zabbix data source](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/installation-datasource_config.png)
### HTTP settings ### HTTP settings
@@ -87,7 +87,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. You can import dashboard examples from _Dashboards_ tab in the data source config.
![Import dashboards](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-plugin-dashboards.png) ![Import dashboards](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/installation-plugin-dashboards.png)
## Note about Browser Cache ## Note about Browser Cache

6
docs/sources/configuration/direct-db-datasource.md
View File

@@ -28,7 +28,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. In order to use _Direct DB Connection_ feature you should configure SQL data source first.
![Configure MySQL data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-mysql_ds_config.png) ![Configure MySQL data source](https://raw.githubusercontent.com/grafana/grafana-zabbix/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 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. database name (usually, `zabbix`) and specify credentials.
@@ -38,11 +38,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 Select _PostgreSQL_ data source type and provide your database host address and port (5432 is default). Fill
database name (usually, `zabbix`) and specify credentials. database name (usually, `zabbix`) and specify credentials.
![Configure PostgreSQL data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/installation-postgres_ds_config.png) ![Configure PostgreSQL data source](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/installation-postgres_ds_config.png)
## InfluxDB ## InfluxDB
Select _InfluxDB_ data source type and provide your InfluxDB instance host address and port (8086 is default). Fill 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. database name you configured in the [effluence](https://github.com/i-ky/effluence) module config (usually, `zabbix`) and specify credentials.
![Configure InfluxDB data source](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/configuration-influxdb_ds_config.png) ![Configure InfluxDB data source](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/configuration-influxdb_ds_config.png)

20
docs/sources/guides/_index.md
View File

@@ -23,11 +23,11 @@ create a simple dashboard.
Add new Graph panel to dashboard. Add new Graph panel to dashboard.
Select metrics from dropdown or start to type to filter results Select metrics from dropdown or start to type to filter results
![Metrics filtering](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-metrics_filtering.png) ![Metrics filtering](https://raw.githubusercontent.com/grafana/grafana-zabbix/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. Let's create _15 min avg processor load_ graph. Select Host Group, Host, Application (optional - you can leave it blank) and Item.
![Processor load](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-processor_load.png) ![Processor load](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/getstarting-processor_load.png)
## Multiple Items On One Graph ## Multiple Items On One Graph
@@ -37,25 +37,25 @@ You can build graphs with lots of items using Regular Expressions inside metric
/CPU (?!idle).* time/; /CPU (?!idle).* time/;
``` ```
![CPU time](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-regex_cpu_time.png) ![CPU time](https://raw.githubusercontent.com/grafana/grafana-zabbix/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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-regex_backend_system_time.png) ![Backend system time](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/getstarting-regex_backend_system_time.png)
## Bar Chart ## 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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_1.png) ![MySQL operations 1](https://raw.githubusercontent.com/grafana/grafana-zabbix/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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_2.png) ![MySQL operations 2](https://raw.githubusercontent.com/grafana/grafana-zabbix/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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-mysql_operations_3.png) ![MySQL operations 3](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/getstarting-mysql_operations_3.png)
Ok, looks pretty! Ok, looks pretty!
@@ -63,14 +63,14 @@ Ok, looks pretty!
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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-singlestat_1.png) ![Singlestat 1](https://raw.githubusercontent.com/grafana/grafana-zabbix/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). 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-singlestat_2.png) ![Singlestat 2](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/getstarting-singlestat_2.png)
Great, looks cool. Read more about Singlestat panel in [Grafana docs](http://docs.grafana.org/reference/singlestat/). Great, looks cool. Read more about Singlestat panel in [Grafana docs](http://docs.grafana.org/reference/singlestat/).
And all together: And all together:
![Dashboard](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/getstarting-dashboard_1.png) ![Dashboard](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/getstarting-dashboard_1.png)

6
docs/sources/guides/templating.md
View File

@@ -21,11 +21,11 @@ You can use template variables for creating highly reusable and interactive dash
To create template variable click the cog icon on the top navigation bar and choose _Templating_. To create template variable click the cog icon on the top navigation bar and choose _Templating_.
![Templating menu](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-menu.png) ![Templating menu](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/templating-menu.png)
When you click _New_ button, you'll see template variable editor. It contains these sections: When you click _New_ button, you'll see template variable editor. It contains these sections:
![Variable editor](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-variable_editor.png) ![Variable editor](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/templating-variable_editor.png)
### Variable ### Variable
@@ -96,7 +96,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. 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](https://raw.githubusercontent.com/grafana/alexanderzobnin-zabbix-app/main/docs/images/templating-query_with_variables.png) ![Query with variables](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/templating-query_with_variables.png)
> Note, that you should add `$` sign before variable's name (**$host** for _host_ variable). > Note, that you should add `$` sign before variable's name (**$host** for _host_ variable).

2
docs/sources/reference/direct-db-connection.md
View File

@@ -31,7 +31,7 @@ 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` 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. and `trend.get` API calls.
[![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) [![Direct DB Connection](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/reference-direct-db-connection.svg)](https://raw.githubusercontent.com/grafana/grafana-zabbix/main/docs/images/reference-direct-db-connection.svg)
## Query structure ## Query structure