This is an automated email from the ASF dual-hosted git repository.
zhaoqingran pushed a commit to branch grafana-doc
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/grafana-doc by this push:
new f941b3636 docs: add Grafana Dashboard integration documentation
f941b3636 is described below
commit f941b3636553b1c1f00899c819e1eba008bb5225
Author: zqr10159 <[email protected]>
AuthorDate: Thu Aug 29 23:40:00 2024 +0800
docs: add Grafana Dashboard integration documentation
Add documentation on configuring and using the Grafana Dashboard for
displaying
historical data in HertzBeat, including setup instructions and steps to
upload
Grafana monitor template JSON files within the HertzBeat monitor.
---
home/docs/help/grafana_dashboard.md | 42 ++++++++++++++++++++++
.../current/help/grafana_dashboard.md | 2 ++
home/sidebars.json | 1 +
3 files changed, 45 insertions(+)
diff --git a/home/docs/help/grafana_dashboard.md
b/home/docs/help/grafana_dashboard.md
new file mode 100644
index 000000000..8337a84cc
--- /dev/null
+++ b/home/docs/help/grafana_dashboard.md
@@ -0,0 +1,42 @@
+---
+id: grafana_dashboard
+title: Grafana Dashboard
+sidebar_label: Grafana Historical Charts
+keywords: [Grafana, Historical Dashboard]
+---
+
+> `Grafana` is an open source visualization and analytics platform that helps
you easily create, share and monitor dashboards. In this article, we will cover
how to use `Grafana` to display historical data in `HertzBeat`.
+
+### Prerequisites
+
+- The `Grafana` service is started and the account password is configured.
+- The `HertzBeat` service is started and the `VictoriaMetrics` timeseries
database is configured (note: the `VictoriaMetrics` data source is required).
+
+:::caution Caution.
+`Grafana` can only show historical data for `Prometheus` type of monitoring,
currently it does not support monitoring data defined by `yml` in `HertzBeat`.
+:::
+
+### Configuring Grafana in HertzBeat
+
+In the configuration file `hertzbeat.yml` in `HertzBeat`, configure the
`Grafana` data source.
+
+```yaml
+grafana:
+ enabled: true
+ url: http://127.0.0.1:3000
+ username: admin
+ password: admin
+```
+
+### Upload Grafana monitor template json file in HertzBeat monitor
+
+In `HertzBeat`, when creating or editing a `Prometheus` type monitor, click
Enable Grafana Templates and select the Grafana template json file to upload.
+The monitor template json file can be downloaded at
https://grafana.com/grafana/dashboards/.
+For example, create a new monitor in `HertzBeat` for `VictoriaMetrics` single
node, then open
https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/,
click `Download JSON` button on the right side. `Download JSON` button on the
right to download the template json file. Upload the template json file in the
`HertzBeat` monitor, save it.
+ 
+
+### View Grafana historical charts
+
+On the `HertzBeat` monitoring page, click the `Grafana` button, select
`Grafana` Historical Charts, select a monitoring template, and click the
`Query` button to view the `Grafana` historical charts.
+ 
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/grafana_dashboard.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/grafana_dashboard.md
index b27e6f960..eb2b03e99 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/grafana_dashboard.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/grafana_dashboard.md
@@ -33,7 +33,9 @@ grafana:
在`HertzBeat`新建或编辑`Prometheus`类型监控时,点击启用Grafana模板,选择Grafana模板json文件上传。
监控模板json文件可以在 https://grafana.com/grafana/dashboards/ 下载。
比如,在`HertzBeat`中新建一个关于`VictoriaMetrics`单节点的监控,然后打开
https://grafana.com/grafana/dashboards/10229-victoriametrics-single-node/ ,点击右侧
`Download JSON`按钮,下载模板json文件。在`HertzBeat`监控中上传模板json文件,保存。
+ 
### 查看Grafana历史图表
在`HertzBeat`监控页面,点击`Grafana`按钮,选择`Grafana`历史图表,选择监控模板,点击`查询`按钮,即可查看`Grafana`历史图表。
+ 
diff --git a/home/sidebars.json b/home/sidebars.json
index 42758160a..e8a64f622 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -359,6 +359,7 @@
"help/bulletin",
"help/plugin",
"help/time_expression",
+ "help/grafana_dashboard",
"help/issue"
]
},
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
