Skip to content

Commit

Permalink
title updates for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yesoreyeram committed Jan 4, 2024
1 parent b8c85cd commit 2af45e8
Show file tree
Hide file tree
Showing 12 changed files with 48 additions and 6 deletions.
8 changes: 5 additions & 3 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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.
2 changes: 2 additions & 0 deletions docs/sources/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/configuration/direct-db-datasource.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/sources/configuration/provisioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/configuration/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions docs/sources/guides/templating.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/installation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/installation/building-from-sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/sources/installation/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 20 additions & 0 deletions docs/sources/reference/_index.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 2af45e8

Please sign in to comment.