跳至主要内容

Grafana 的 ClickHouse 数据源插件

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

1. 收集您的连接详细信息

要使用原生 TCP 连接到 ClickHouse,您需要以下信息

  • HOST 和 PORT:通常,使用 TLS 时端口为 9440,不使用 TLS 时端口为 9000。

  • DATABASE NAME:默认情况下有一个名为 default 的数据库,请使用您要连接到的数据库的名称。

  • USERNAME 和 PASSWORD:默认情况下用户名为 default。请使用适合您用例的用户名。

您的 ClickHouse Cloud 服务的详细信息可在 ClickHouse Cloud 控制台中找到。选择您要连接到的服务,然后单击**连接**

ClickHouse Cloud service connect button

选择**原生**,详细信息将在 clickhouse-client 命令示例中提供。

ClickHouse Cloud Native TCP connection details

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

2. 创建只读用户

将 ClickHouse 连接到像 Grafana 这样的数据可视化工具时,建议创建一个只读用户来保护您的数据免受意外修改。

Grafana 不验证查询是否安全。查询可以包含任何 SQL 语句,包括 DELETEINSERT

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

  1. 按照ClickHouse 中创建用户和角色指南创建 readonly 用户配置文件。
  2. 确保 readonly 用户拥有足够的权限来修改底层clickhouse-go 客户端所需的 max_execution_time 设置。
  3. 如果您使用的是公共 ClickHouse 实例,建议不要在 readonly 配置文件中设置 readonly=2。相反,请保留 readonly=1,并将 max_execution_time 的约束类型设置为changeable_in_readonly,以允许修改此设置。

3. 安装 Grafana 的 ClickHouse 插件

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

  1. 在侧边栏的**连接**页面中,选择**添加新连接**选项卡。

  2. 搜索**ClickHouse**,然后单击 Grafana Labs 签名的插件

    Select the ClickHouse plugin on the connections page
  3. 在下一个屏幕上,单击**安装**按钮

    Install the ClickHouse plugin

4. 定义 ClickHouse 数据源

  1. 安装完成后,单击**添加新数据源**按钮。(您也可以从**连接**页面的**数据源**选项卡添加数据源。)

    Create a ClickHouse data source
  2. 向下滚动并找到**ClickHouse** 数据源类型,或者您可以在**添加数据源**页面的搜索栏中搜索它。选择**ClickHouse** 数据源,将显示以下页面

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

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

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

  1. 单击**保存并测试**按钮以验证 Grafana 是否可以连接到您的 ClickHouse 服务。如果成功,您将看到一条**数据源正常工作**的消息

    Select Save & test

5. 下一步

您的数据源现在已准备就绪!详细了解如何使用查询构建器构建查询。

有关配置的更多详细信息,请查看插件配置文档。

如果您正在寻找这些文档中未包含的更多信息,请查看GitHub 上的插件存储库

升级插件版本

从 v4 开始,配置和查询能够在发布新版本时进行升级。

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

如果配置/查询是在较新版本中创建的,则插件无法降级到以前的版本。