> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> ClickHouse 与 Grafana 集成简介
# Grafana 的 ClickHouse 数据源插件
export const ClickHouseSupportedBadge = () => {
return ;
};
export const Image = ({img, alt, size}) => {
return
;
};
借助 Grafana，您可以通过仪表盘探索并共享所有数据。
Grafana 需要通过插件连接到 ClickHouse，您可以在其 UI 中轻松完成安装。
## 1. 收集连接信息
要通过原生 TCP 连接到 ClickHouse，你需要以下信息：
| Parameters | 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`。
要配置只读用户，请按以下步骤操作：
1. 按照[在 ClickHouse 中创建用户和角色](/zh/concepts/features/security/access-rights)指南创建一个 `readonly` 用户 profile。
2. 确保 `readonly` 用户拥有足够的权限，以修改底层 [clickhouse-go client](https://github.com/ClickHouse/clickhouse-go) 所需的 `max_execution_time` 设置。
3. 如果您使用的是公共 ClickHouse 实例，不建议在 `readonly` profile 中设置 `readonly=2`。请改为保留 `readonly=1`，并将 `max_execution_time` 的约束类型设置为 [changeable\_in\_readonly](/zh/concepts/features/configuration/settings/constraints-on-settings)，以允许修改此设置。
## 3. 安装 Grafana 的 ClickHouse 插件
在 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. 输入服务器设置和凭据。关键设置包括：
* **Server host address:** 您的 ClickHouse 服务的主机名。
* **Server port:** 您的 ClickHouse 服务使用的端口。具体端口取决于服务器配置和所用协议。
* **Protocol**：用于连接到您的 ClickHouse 服务的协议。
* **Secure connection**：如果您的服务器要求安全连接，请启用此项。
* **Username** 和 **Password**：输入您的 ClickHouse 用户凭据。如果您尚未配置任何用户，可尝试使用 `default` 作为用户名。建议[配置只读用户](#2-making-a-read-only-user)。
有关更多设置，请参阅[插件配置](/zh/integrations/connectors/data-visualization/grafana/config)文档。
4. 点击 **Save & test** 按钮，验证 Grafana 能否连接到您的 ClickHouse 服务。如果连接成功，您将看到 **Data source is working** 消息：
## 5. 后续步骤
您的数据源现在已可使用！了解如何使用[查询构建器](/zh/integrations/connectors/data-visualization/grafana/query-builder)构建查询。
有关配置的更多信息，请参阅[插件配置](/zh/integrations/connectors/data-visualization/grafana/config)文档。
如果这些文档未涵盖您需要的信息，请查看 [GitHub 上的插件仓库](https://github.com/grafana/clickhouse-datasource)。
## 升级插件版本
从 v4 开始，配置和查询可随着新版本的发布进行升级。
v3 中的配置和查询会在打开时迁移到 v4。虽然旧版配置和仪表盘可以在 v4 中加载，但迁移结果在新版中重新保存之前不会被保留。如果你在打开旧配置/查询时发现任何问题，请放弃更改，并[在 GitHub 上报告该问题](https://github.com/grafana/clickhouse-datasource/issues)。
如果配置/查询是使用较新版本创建的，插件将无法降级到旧版本。