用于 Grafana 的 ClickHouse 数据源插件
使用 Grafana，您可以通过仪表盘探索和共享所有数据。 Grafana 需要安装一个插件才能连接到 ClickHouse，并且可以在其 UI 中轻松完成安装。
1. 收集连接详细信息
要通过原生 TCP 协议连接到 ClickHouse，需要以下信息：
| Parameter(s) | Description |
|---|---|
HOST and PORT | 通常在使用 TLS 时端口为 9440，不使用 TLS 时端口为 9000。 |
DATABASE NAME | 默认提供名为 default 的数据库，请使用您要连接的数据库名称。 |
USERNAME and PASSWORD | 默认用户名为 default。请根据您的使用场景选择合适的用户名。 |
ClickHouse Cloud 服务的详细信息可以在 ClickHouse Cloud 控制台中查看。 选择要连接的服务并点击 Connect：
选择 Native，示例 clickhouse-client 命令中会展示连接所需的详细信息。
如果您使用的是自管的 ClickHouse，连接信息由 ClickHouse 管理员进行配置。
2. 创建只读用户
在将 ClickHouse 连接到 Grafana 等数据可视化工具时，建议创建一个只读用户，以防止数据被意外或不期望地修改。
Grafana 不会验证查询是否安全。查询可以包含任意 SQL 语句，包括 DELETE 和 INSERT。
要配置只读用户，请执行以下步骤：
- 按照在 ClickHouse 中创建用户和角色指南创建一个
readonly用户配置文件。 - 确保
readonly用户具有足够的权限来修改底层使用的 clickhouse-go 客户端所需的max_execution_time设置。 - 如果你正在使用对外公开访问的 ClickHouse 实例，则不建议在
readonly配置文件中设置readonly=2。相反，应保持readonly=1，并将max_execution_time的约束类型设置为 changeable_in_readonly，以允许修改此设置。
3. 为 Grafana 安装 ClickHouse 插件
在 Grafana 能够连接到 ClickHouse 之前，需要先安装相应的 Grafana 插件。假设你已经登录 Grafana，请按照以下步骤操作：
-
在侧边栏的 Connections 页面中，选择 Add new connection 选项卡。
-
搜索 ClickHouse，然后点击由 Grafana Labs 提供的已签名插件：
-
在下一个界面中，点击 Install 按钮：
4. 定义 ClickHouse 数据源
-
安装完成后，点击 Add new data source 按钮。（也可以在 Connections 页面中的 Data sources 选项卡添加数据源。）
-
向下滚动找到 ClickHouse 数据源类型，或者在 Add data source 页面的搜索栏中搜索。选择 ClickHouse 数据源后，会出现如下页面：
- 输入服务器设置和凭据。关键设置包括：
- Server host address： ClickHouse 服务的主机名。
- Server port： ClickHouse 服务的端口号。端口会因服务器配置和协议而异。
- Protocol： 用于连接 ClickHouse 服务的协议。
- Secure connection： 如服务器要求安全连接，请启用该选项。
- Username 和 Password：输入 ClickHouse 用户凭据。如果尚未配置任何用户，可以尝试将用户名设置为
default。建议配置只读用户。
更多设置请查看 plugin configuration 文档。
-
点击 Save & test 按钮以验证 Grafana 是否能够连接到 ClickHouse 服务。如果连接成功，将会看到 Data source is working 消息：
5. 后续步骤
数据源现已可以使用！在查询构建器中了解如何构建查询。
如需更多配置细节，请参阅插件配置文档。
如果需要本文档未涵盖的更多信息，请查看 GitHub 上的插件仓库。
升级插件版本
从 v4 开始，可以在发布新版本时升级配置和查询。
v3 的配置和查询在被打开时会迁移到 v4。虽然旧的配置和仪表板会在 v4 中加载，但在你使用新版本重新保存之前，此次迁移并不会被持久化。如果你在打开旧配置/查询时发现任何问题，请放弃你的更改，并在 GitHub 上报告该问题。
如果配置/查询是由更高版本创建的，则插件无法降级到先前的版本。
