ClickHouse 数据源插件用于 Grafana

ClickHouse Supported

通过 Grafana，您可以通过仪表板探索和共享所有数据。 Grafana 需要一个插件来连接 ClickHouse，该插件可以在其用户界面中轻松安装。

1. 收集连接详情

要通过本地 TCP 连接到 ClickHouse ，您需要以下信息：

• 主机和端口：当使用 TLS 时，端口通常为 9440，当不使用 TLS 时，端口为 9000。

• 数据库名称：开箱即用有一个名为 default 的数据库，请使用您要连接的数据库的名称。

• 用户名和密码：开箱即用的用户名是 default。请使用适合您用例的用户名。

有关您的 ClickHouse Cloud 服务的详细信息，请在 ClickHouse Cloud 控制台中查看。 选择您要连接的服务，然后点击 Connect：

选择 Native，详细信息在示例 clickhouse-client 命令中提供。

如果您使用的是自管理的 ClickHouse，连接详细信息由您的 ClickHouse 管理员设置。

2. 创建只读用户

当将 ClickHouse 连接到像 Grafana 这样的数据可视化工具时，建议创建一个只读用户，以保护您的数据免受不必要的修改。

Grafana 不会验证查询是否安全。查询可以包含任何 SQL 语句，包括 DELETE 和 INSERT。

要配置只读用户，请按照以下步骤操作：

1. 创建一个 readonly 用户配置文件，遵循 在 ClickHouse 中创建用户和角色 指南。
2. 确保 readonly 用户具有足够的权限以修改底层 clickhouse-go client 所需的 max_execution_time 设置。
3. 如果您使用的是公共 ClickHouse 实例，不建议在 readonly 配置文件中设置 readonly=2。相反，保持 readonly=1 并将 max_execution_time 的约束类型设置为 changeable_in_readonly，以允许修改此设置。

3. 安装 ClickHouse 插件用于 Grafana

在 Grafana 可以连接到 ClickHouse 之前，您需要安装适当的 Grafana 插件。假设您已登录到 Grafana，按照以下步骤操作：

1. 在侧边栏的 Connections 页面，选择 Add new connection 标签。

2. 搜索 ClickHouse 并点击由 Grafana Labs 签名的插件：

   

3. 在下一个屏幕上，点击 Install 按钮：

   

4. 定义 ClickHouse 数据源

1. 安装完成后，点击 Add new data source 按钮。（您也可以从 Connections 页面的 Data sources 标签中添加数据源。）

   

2. 向下滚动找到 ClickHouse 数据源类型，或可以在 Add data source 页面上的搜索框中搜索它。选择 ClickHouse 数据源，以下页面将出现：

3. 输入您的服务器设置和凭据。关键设置包括：

• 服务器主机地址: 您的 ClickHouse 服务的主机名。
• 服务器端口: 您的 ClickHouse 服务的端口。根据服务器配置和协议，可能会有所不同。
• 协议: 用于连接到您的 ClickHouse 服务的协议。
• 安全连接: 如果您的服务器需要安全连接，请启用。
• 用户名 和 密码: 输入您的 ClickHouse 用户凭据。如果您尚未配置任何用户，请尝试 default 作为用户名。建议 配置一个只读用户。

有关更多设置，请查看 插件配置 文档。

4. 点击 Save & test 按钮以验证 Grafana 是否可以连接到您的 ClickHouse 服务。如果成功，您将看到 Data source is working 消息：

   

5. 下一步

您的数据源现在可以使用了！了解有关如何使用 查询构建器 构建查询的更多信息。

有关配置的更多详情，请查看 插件配置 文档。

如果您在这些文档中寻找的信息未包含在内，请查看 GitHub 上的插件库。

升级插件版本

从 v4 开始，配置和查询能够随着新版本的发布而升级。

v3 的配置和查询在打开时会迁移到 v4。虽然旧的配置和仪表板将在 v4 中加载，但迁移不会持久化，直到它们在新版本中再次保存。如果您在打开旧配置/查询时遇到任何问题，请放弃更改并 在 GitHub 上报告该问题。

如果配置/查询是使用新版本创建的，则插件无法降级到以前的版本。