跳到主要内容
跳到主要内容

ClickHouse 数据源插件用于 Grafana

ClickHouse Supported

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

1. 收集您的连接详情​

ClickHouse にネイティブ TCP で接続するには、次の情報が必要です：

  • HOST と PORT: 通常、TLS を使用する場合はポート 9440、TLS を使用しない場合は 9000 です。

  • DATABASE NAME: デフォルトでは default というデータベースがあり、接続したいデータベースの名前を使用します。

  • USERNAME と PASSWORD: デフォルトではユーザー名は 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. 在侧边栏的 连接 页面，选择 添加新连接 选项卡。

  2. 搜索 ClickHouse 并单击 Grafana Labs 签署的插件：

  3. 在下一个屏幕上，单击 安装 按钮：

4. 定义 ClickHouse 数据源​

  1. 安装完成后，单击 添加新数据源 按钮。 （您也可以从 连接 页面上的 数据源 选项卡添加数据源。）

  2. 向下滚动并找到 ClickHouse 数据源类型，或者您也可以在 添加数据源 页面搜索框中搜索它。选择 ClickHouse 数据源，然后将出现以下页面：

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

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

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

5. 后续步骤​

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

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

如果您正在寻找其他未包含在本指南中的信息，请查看 GitHub 上的插件库。

升级插件版本​

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

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

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

相关内容​