Skip to content

Commit c9c12e3

Browse files
authored
feat: TDinsight compatible Grafana version changed from 7.5 to 8.0 (#34749)
Closes: https://project.feishu.cn/taosdata_td/feature/detail/6877052658
1 parent 6aa6d21 commit c9c12e3

File tree

7 files changed

+13
-16
lines changed

7 files changed

+13
-16
lines changed

docs/en/04-get-started/_get_started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Grafana is a popular open-source platform for data visualization and monitoring.
118118

119119
#### Prerequisites
120120

121-
- Install and start Grafana (version 7.5 or above is supported).
121+
- Install and start Grafana (version 8.0 or above is supported).
122122
- Insert test data using the following command, which creates a supertable meters in the test database with 100 subtables, each containing 1,000 records starting from one hour ago:
123123

124124
```bash

docs/en/10-third-party/03-visual/01-grafana.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document describes how to integrate the TDengine data source with the open-
1414

1515
To add the TDengine data source to Grafana normally, the following preparations are needed.
1616

17-
- Grafana service has been deployed and is running normally. TDengine currently supports Grafana version 7.5 and above. It is recommended to use the latest version.
17+
- Grafana service has been deployed and is running normally. TDengine currently supports Grafana version 8.0 and above. It is recommended to use the latest version.
1818
**Note**: Ensure that the account starting Grafana has write permissions to its installation directory, otherwise you may not be able to install plugins later.
1919
- TDengine cluster has been deployed and is running normally.
2020
- taosAdapter has been installed and is running normally. For details, please refer to the [taosAdapter user manual](../../../tdengine-reference/components/taosadapter/)
@@ -29,7 +29,7 @@ Record the following information:
2929
<Tabs defaultValue="script">
3030
<TabItem value="script" label="Installation Script">
3131

32-
For users using Grafana version 7.x or configuring with [Grafana Provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/), you can use the installation script on the Grafana server to automatically install the plugin and add the data source Provisioning configuration file.
32+
For users using Grafana version 8.x or later or configuring with [Grafana Provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/), you can use the installation script on the Grafana server to automatically install the plugin and add the data source Provisioning configuration file.
3333

3434
```shell
3535
bash -c "$(curl -fsSL \

docs/en/14-reference/01-components/12-tdinsight.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ First, check the following services:
1818
- TDengine is installed and running normally. This dashboard requires TDengine 3.0.0.0 or above, and monitoring reporting configuration enabled. For specific configurations, please refer to: [TDengine Monitoring Configuration](../taosd/).
1919
- taosAdapter is installed and running normally. For details, please refer to: [taosAdapter Reference Manual](../taosadapter)
2020
- taosKeeper is installed and running normally. For details, please refer to: [taosKeeper Reference Manual](../taoskeeper)
21-
- Grafana service is installed and running normally. We recommend using the latest version of Grafana, TDInsight supports Grafana 7.5 and above.
21+
- Grafana service is installed and running normally. We recommend using the latest version of Grafana, TDInsight supports Grafana 8.0 and above.
2222
:::info
2323

2424
In the following description, we use Grafana v11.0.0 as an example. Other versions may differ in functionality, please refer to [Grafana Official Website](https://grafana.com/docs/grafana/latest/).
@@ -163,8 +163,8 @@ There are also line charts for the above categories.
163163
### Automatic import of preconfigured alert rules
164164

165165
After summarizing user experience, 14 commonly used alert rules are sorted out. These alert rules can monitor key indicators of the TDengine cluster and report alerts, such as abnormal and exceeded indicators.
166-
Starting from TDengine-Server 3.3.4.3 (TDengine-datasource 3.6.3), TDengine Datasource supports automatic import of preconfigured alert rules. You can import 14 alert rules to Grafana (version 11 or later) with one click.
167-
In the TDengine-datasource setting interface, turn on the "Load Tengine Alert" switch, click the "Save & test" button, the plugin will automatically load the mentioned 14 alert rules. The rules will be placed in the Grafana alerts directory. If not required, turn off the "Load TDengine Alert" switch, and click the button next to "Clear TDengine Alert" to clear all the alert rules imported into this data source.
166+
Starting from TDengine-Server 3.3.4.3 (TDengine-datasource 3.6.3), TDengine Datasource supports automatic import of preconfigured alert rules. You can import 14 alert rules to Grafana (**version 11 or later**) with one click.
167+
In the TDengine-datasource setting interface, turn on the "Load TDengine Alert" switch, click the "Save & test" button, the plugin will automatically load the mentioned 14 alert rules. The rules will be placed in the Grafana alerts directory. If not required, turn off the "Load TDengine Alert" switch, and click the button next to "Clear TDengine Alert" to clear all the alert rules imported into this data source.
168168

169169
After importing, click on "Alert rules" on the left side of the Grafana interface to view all current alert rules. By configuring contact points, users can receive alert notifications.
170170

@@ -187,7 +187,7 @@ The specific configuration of the 14 alert rules is as follows:
187187
| Dnode data reporting is missing | < 3 | Trigger alert | 180 seconds | 0 seconds | `select now(), cluster_id, count(*) as dnode_report from log.taosd_cluster_info where _ts >= (now -180s) and _ts < now partition by cluster_id having timetruncate(first(_ts), 1h) > 0` |
188188
| Restart dnode | max(update_time) > last(update_time) | Trigger alert | 90 seconds | 0 seconds | `select now(), dnode_ep, max(uptime) - last(uptime) as dnode_report from log.taosd_dnodes_info where _ts >= (now - 90s) and _ts < now partition by dnode_ep` |
189189

190-
TDengine users can modify and improve these alert rules according to their own business needs. In Grafana 7.5 and below versions, the Dashboard and Alert rules functions are combined, while in subsequent new versions, the two functions are separated. To be compatible with Grafana7.5 and below versions, an Alert Used Only panel has been added to the TDinsight panel, which is only required for Grafana7.5 and below versions.
190+
TDengine users can modify and improve these alert rules according to their own business needs.
191191

192192
## Upgrade
193193

docs/zh/04-get-started/_get_started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ taosExplorer 是一个可视化工具,使用户可以通过浏览器,以直
110110

111111
#### 前置准备
112112

113-
1. 请先安装并启动 Grafana, 目前 TDengine 支持 Grafana 7.5 及以上的版本
113+
1. 请先安装并启动 Grafana, 目前 TDengine 支持 Grafana 8.0 及以上的版本
114114
2. 使用以下命令写入测试数据,这个命令将在名为 test 的数据库下,创建超级表 meters, 这个超级表包含 100 个子表,每个子表 1000 条记录,记录的开始时间为 1 小时前:
115115

116116
```bash

docs/zh/10-third-party/03-visual/01-grafana.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import TabItem from "@theme/TabItem";
1515

1616
要让 Grafana 能正常添加 TDengine TSDB 数据源,需要以下几方面的准备工作。
1717

18-
- Grafana 服务已经部署并正常运行。当前 TDengine TSDB 支持 Grafana 7.5 及以上版本,建议使用最新版本。
18+
- Grafana 服务已经部署并正常运行。当前 TDengine TSDB 支持 Grafana 8.0 及以上版本,建议使用最新版本。
1919
**注意**:要确保启动 Grafana 的账号有其安装目录的写权限,否则可能后面无法安装插件。
2020
- TDengine TSDB 集群已经部署并正常运行。
2121
- taosAdapter 已经安装并正常运行。具体细节请参考 [taosAdapter 的使用手册](../../../reference/components/taosadapter)
@@ -30,7 +30,7 @@ import TabItem from "@theme/TabItem";
3030
<Tabs defaultValue="script">
3131
<TabItem value="script" label="安装脚本">
3232

33-
对于使用 Grafana 7.x 版本或使用 [Grafana Provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/) 配置的用户,可以在 Grafana 服务器上使用安装脚本自动安装插件即添加数据源 Provisioning 配置文件。
33+
对于使用 Grafana 8.x 及以上版本或使用 [Grafana Provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/) 配置的用户,可以在 Grafana 服务器上使用安装脚本自动安装插件即添加数据源 Provisioning 配置文件。
3434

3535
```sh
3636
bash -c "$(curl -fsSL \
Binary file not shown.

docs/zh/14-reference/01-components/12-tdinsight/index.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ TDengine TSDB 通过 taosKeeper 将服务器的 CPU、内存、硬盘空间、
1818
- TDengine TSDB 已经安装并正常运行,此仪表盘需要 TDengine TSDB 3.0.0.0 及以上,并开启监控上报配置,具体配置请参考:[TDengine TSDB 监控配置](../taosd/#监控相关)
1919
- taosAdapter 已经安装并正常运行。具体细节请参考:[taosAdapter 参考手册](../taosadapter)
2020
- taosKeeper 已安装并正常运行。具体细节请参考:[taosKeeper 参考手册](../taoskeeper)
21-
- Grafana 服务已安装并正常运行。我们建议您使用最新的 Grafana 版本,TDInsight 支持 Grafana 7.5 及以上版本。
21+
- Grafana 服务已安装并正常运行。我们建议您使用最新的 Grafana 版本,TDInsight 支持 Grafana 8.0 及以上版本。
2222
:::info
2323

2424
下文介绍中,都以 Grafana v11.0.0 版本为例,其他版本功能可能有差异,请参考 [Grafana 官网](https://grafana.com/docs/grafana/latest/)
@@ -163,8 +163,8 @@ TDinsight 仪表盘旨在提供 TDengine TSDB 相关资源的使用情况和状
163163
### 预配置告警规则自动导入
164164

165165
涛思总结用户使用经验,整理出 14 个常用的告警规则(alert rule),能够对集群关键指标进行监测并及时上报指标异常、超限等告警信息。
166-
从 TDengine TSDB server 3.3.4.3 版本(tdengine-datasource 3.6.3)开始,TDengine TSDB Datasource 支持预配置告警规则自动导入功能,用户可将 14 个告警规则一键导入 Grafana(11 及以上版本),直接使用。
167-
预配置告警规则导入方法如下图所示,在 tdengine-datasource setting 界面,打开“Load Tengine Alert”开关,点击“Save & test”按钮后,插件会自动加载上述告警规则,规则会放入以数据源名称 + “-alert”的 grafana 告警目录中。如不需要,关闭“Load TDengine Alert”开关,点击“Clear TDengine Alert”旁边的按钮则会清除此数据源已导入的所有告警规则。
166+
从 TDengine TSDB server 3.3.4.3 版本(tdengine-datasource 3.6.3)开始,TDengine TSDB Datasource 支持预配置告警规则自动导入功能,用户可将 14 个告警规则一键导入 Grafana(**11 及以上版本**),直接使用。
167+
预配置告警规则导入方法如下图所示,在 tdengine-datasource setting 界面,打开“Load TDengine Alert”开关,点击“Save & test”按钮后,插件会自动加载上述告警规则,规则会放入以数据源名称 + “-alert”的 grafana 告警目录中。如不需要,关闭“Load TDengine Alert”开关,点击“Clear TDengine Alert”旁边的按钮则会清除此数据源已导入的所有告警规则。
168168

169169
![TDengine TSDB Alert](./assets/TDengine-Alert.webp)
170170

@@ -193,9 +193,6 @@ TDinsight 仪表盘旨在提供 TDengine TSDB 相关资源的使用情况和状
193193
|dnode 重启 |max(update_time) > last(update_time)|触发告警|90 秒|0 秒|`select now(), dnode_ep, max(uptime) - last(uptime) as dnode_report from log.taosd_dnodes_info where _ts >= (now - 90s) and _ts < now partition by dnode_ep`|
194194

195195
用户可参考上述告警规则,根据自己业务需求进行修改与完善。
196-
Grafana7.5 及以下版本,Dashboards 与 Alert rules 功能合在一起,而之后的新版本两个功能是分开的。为兼容 Grafana7.5 及以下版本,TDinsight 面板中增加了 Alert Used Only 面板,仅 Grafana7.5 及以下版本需要使用。
197-
198-
![Alert Used Only](./assets/Alert-Used-Only.webp)
199196

200197
## 升级
201198

0 commit comments

Comments
 (0)