Skip to content

Commit ac51b08

Browse files
authored
[IOTDB-2873] Apache IoTDB Dashboard: Grafana Metrics Template (apache#5587)
1 parent f52beec commit ac51b08

6 files changed

Lines changed: 3080 additions & 6 deletions

File tree

distribution/src/assembly/all.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,10 @@
5555
<outputDirectory>conf</outputDirectory>
5656
<directory>${maven.multiModuleProjectDirectory}/metrics/interface/src/main/assembly/resources/conf</directory>
5757
</fileSet>
58+
<fileSet>
59+
<outputDirectory>grafana-metrics-example</outputDirectory>
60+
<directory>${maven.multiModuleProjectDirectory}/grafana-metrics-example</directory>
61+
</fileSet>
5862
<fileSet>
5963
<outputDirectory>sbin</outputDirectory>
6064
<directory>${maven.multiModuleProjectDirectory}/server/src/assembly/resources/sbin</directory>

distribution/src/assembly/server.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@
4646
<outputDirectory>conf</outputDirectory>
4747
<directory>${maven.multiModuleProjectDirectory}/metrics/interface/src/main/assembly/resources/conf</directory>
4848
</fileSet>
49+
<fileSet>
50+
<outputDirectory>grafana-metrics-example</outputDirectory>
51+
<directory>${maven.multiModuleProjectDirectory}/grafana-metrics-example</directory>
52+
</fileSet>
4953
<fileSet>
5054
<outputDirectory>sbin</outputDirectory>
5155
<directory>${maven.multiModuleProjectDirectory}/server/src/assembly/resources/sbin</directory>

docs/UserGuide/Maintenance-Tools/Metric-Tool.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,8 +328,14 @@ The following documents may help you have a good journey with Prometheus and Gra
328328

329329
[Grafana query metrics from Prometheus](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus)
330330

331-
Here are two demo pictures of IoTDB's metrics data in Grafana.
331+
### 5.3. Apache IoTDB Dashboard
332+
We provide the Apache IoTDB Dashboard, and the rendering shown in Grafana is as follows:
332333

333-
![metrics_demo_1](https://raw.githubusercontent.com/apache/iotdb-bin-resources/main/docs/UserGuide/System%20Tools/Metrics/metrics_demo_1.png)
334+
![Apache IoTDB Dashboard](https://github.com/apache/iotdb-bin-resources/blob/main/docs/UserGuide/System%20Tools/Metrics/dashboard.png)
334335

335-
![metrics_demo_2](http://raw.githubusercontent.com/apache/iotdb-bin-resources/main/docs/UserGuide/System%20Tools/Metrics/metrics_demo_2.png)
336+
How to get Apache IoTDB Dashboard:
337+
338+
1. You can obtain the json files of Dashboards corresponding to different iotdb versions in the grafana-metrics-example folder.
339+
2. You can visit [Grafana Dashboard official website](https://grafana.com/grafana/dashboards/), search for `Apache IoTDB Dashboard` and use
340+
341+
When creating Grafana, you can select the json file you just downloaded to `Import` and select the corresponding target data source for Apache IoTDB Dashboard.

docs/zh/UserGuide/Maintenance-Tools/Metric-Tool.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -329,8 +329,14 @@ static_configs:
329329

330330
[Grafana从Prometheus查询数据并绘图的文档](https://prometheus.io/docs/visualization/grafana/#grafana-support-for-prometheus)
331331

332-
最后是IoTDB的metrics数据在Grafana中显示的效果图:
332+
### 5.3. Apache IoTDB Dashboard
333+
我们提供了Apache IoTDB Dashboard,在Grafana中显示的效果图如下所示:
333334

334-
![metrics_demo_1](https://raw.githubusercontent.com/apache/iotdb-bin-resources/main/docs/UserGuide/System%20Tools/Metrics/metrics_demo_1.png)
335+
![Apache IoTDB Dashboard](https://github.com/apache/iotdb-bin-resources/blob/main/docs/UserGuide/System%20Tools/Metrics/dashboard.png)
335336

336-
![metrics_demo_2](http://raw.githubusercontent.com/apache/iotdb-bin-resources/main/docs/UserGuide/System%20Tools/Metrics/metrics_demo_2.png)
337+
Apache IoTDB Dashboard的获取方式:
338+
339+
1. 您可以在grafana-metrics-example文件夹下获取到对应不同iotdb版本的Dashboard的json文件。
340+
2. 您可以访问[Grafana Dashboard官网](https://grafana.com/grafana/dashboards/)搜索`Apache IoTDB Dashboard`并使用
341+
342+
在创建Grafana时,您可以选择Import刚刚下载的json文件,并为Apache IoTDB Dashboard选择对应目标数据源。

0 commit comments

Comments
 (0)