You need to enable JavaScript to run this app.
导航
ByteHouse云数仓版
  • 文档首页
    • /ByteHouse云数仓版/用户指南/生态工具/BI工具/Grafana
Grafana
最近更新时间：2025.08.21 16:15:56首次发布时间：2024.12.17 14:55:03
复制全文
我的收藏
有用
有用
无用
无用

Grafana 支持以公网的方式连接 ByteHouse，本文为您介绍如何在 Grafana 中添加 ByteHouse 数据源。
您可以通过 Altinity plugin for ClickHouse插件 或增加 ClickHouse 数据源 的方式连接到 Grafana。

背景信息

ByteHouse 支持通过 IAM 用户或数据库用户连接 Grafana。IAM 用户与数据库用户二者差异说明如下，您可按需选择。

  • IAM 用户为火山引擎访问控制（IAM）中创建的用户，其权限由 IAM 权限策略及您授予的 ByteHouse 资源和数据权限决定。IAM 用户可访问 ByteHouse 控制台，也支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。
  • 数据库用户为 ByteHouse 中创建的数据库级别用户，可为其授予环境、资源和数据权限。数据库用户不可访问 ByteHouse 控制台，但支持通过 CLI、连接驱动、生态工具、API 等方式访问 ByteHouse。

更多 IAM 用户和数据库用户的介绍请参见以下文档：

前提条件
  1. 拥有 ByteHouse 账户。
  2. 已拥有 Grafana Cloud 账户。或已安装 Grafana，可以访问 官网链接 获取。

通过 Altinity plugin for ClickHouse 连接

安装

在 Grafana Cloud 上安装 Altinity plugin for ClickHouse 插件

在 Grafana Cloud 实例上可以一键安装 Altinity plugin for ClickHouse插件；最多可能需要 1 分钟才能看到插件出现在您的 Grafana 中。

在本地 Grafana 上安装

对于本地实例，通过简单的 CLI 命令安装和更新插件。插件不会自动更新，但是当您的 Grafana 中有可用更新时，您会收到通知。
使用 grafana-cli 工具从命令行安装：

grafana-cli plugins install vertamedia-clickhouse-datasource

该插件将安装到您的 grafana plugins 目录中；默认值为 /var/lib/grafana/plugins。
点击访问有关 CLI 工具的更多信息。
或者，您可以手动下载 . zip 文件并将其解压缩到您的 grafana 插件目录中，请点击 下载 获取。

连接到 ByteHouse

通过 Setting 页面配置连接参数。

连接参数

Image

参数

使用 IAM 用户连接

使用数据库用户连接

URL

您的租户对应的连接域名 https://{host}:8123，请参考步骤二：配置网络信息。

AUTH

开启Basic auth。

USERNAME & PASSWORD

  • USERNAME 默认为 bytehouse。
  • PASSWORD为 <API_Key>，可以在 ByteHouse 控制台 > 租户管理 > 连接信息中获取的 API Key。详情请参见获取 API Key。
  • USERNAME 配置为 {accountID_or_accountName}::{username}[::{envID}]，详情请参见步骤三：获取 ByteHouse 连接串信息：
    • {accountID_or_accountName}：指火山引擎用户账号 ID 或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号ID 或名称。
    • {username}：登录 ByteHouse 数据库账号用户名。可在 ByteHouse 控制台 > 权限管理 > 用户 > 查看数据库用户名。
    • {envID}：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置；如需使用其他环境，需指定环境名称，配置时无需添加[]。您可登录 ByteHouse 控制台，在租户管理 > 基本信息 > 当前环境中获取。
      使用示例如下：
      • 配置环境 ID：21xxxxxxxx::demouser::demoenv
      • 不配置环境 ID：21xxxxxxxx::demouser
  • PASSWORD：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。

配置完成后即可在查询区域写入SQL语句。
Image

通过 ClickHouse 数据源连接

此功能当前仅支持 V2 账户。请联系 ByteHouse 支持人员了解 Account 类型。

安装

在 Grafana Cloud 上安装插件

在 Grafana Cloud 实例上可以一键安装 ClickHouse 数据源插件；最多可能需要 1 分钟才能看到插件出现在您的 Grafana 中。

在本地 Grafana 上安装

对于本地实例，通过简单的 CLI 命令安装和更新插件。插件不会自动更新，但是当您的 Grafana 中有可用更新时，您会收到通知。
使用 grafana-cli 工具从命令行安装：

grafana-cli plugins install grafana-clickhouse-datasource

该插件将安装到您的 grafana plugins 目录中；默认值为 /var/lib/grafana/plugins。
点击访问有关 CLI 工具的更多信息。
或者，您可以手动下载下面适合您架构的 .zip 文件并将其解压到您的 grafana 插件目录中。

连接到 ByteHouse

通过 Setting 页面配置连接参数。
从 Grafana 主菜单访问，可以在数据源部分立即添加新安装的数据源。
接下来，点击右上角的添加数据源按钮。数据源将在类型选择框中可供选择。
要查看已安装数据源的列表，请单击主菜单中的插件项。核心数据源和已安装的数据源都会出现。

连接参数

细项

参数

配置说明

基础配置

Server address

您的租户对应的连接域名，请参考步骤二：配置网络信息。

Server port

8123

Protocol

HTTP

Secure Connection

Enable

Skip TLS Verify

Enable

USERNAME & PASSWORD

登录 ByteHouse 数据库的用户名和密码。您可使用 IAM 账号或数据库账号登录，获取相关连接信息详情请参见获取 ByteHouse 连接信息。

  • 使用 IAM 账号
    • 用户名默认为 bytehouse。
    • 密码为 <API_Key>，可以在 ByteHouse 控制台 > 租户管理 > 连接信息中获取的 API Key。详情请参见获取 API Key。
  • 使用数据库账号
    • username 由 {accountID_or_accountName}::{username}[::{envID}] 构成，详情请参见步骤三：获取 ByteHouse 连接串信息：
      • accountID_or_accountName：指火山引擎用户账号或名称，可登录 ByteHouse 控制台，单击右上角个人中心查看并复制账号ID 或名称。
      • username：登录 ByteHouse 数据库账号用户名。可通过 ByteHouse 控制台 > 权限管理 > 用户 > 查看数据库用户名。
      • {envID}：可选配置，数据库所在的环境名称。如果使用 default 环境，可不配置；如需使用其他环境，需指定环境名称，配置时无需添加[]。您可登录 ByteHouse 控制台，在租户管理 > 基本信息 > 当前环境中获取。
        使用示例如下：
        • 配置环境 ID：21xxxxxxxx::demouser::demoenv
        • 不配置环境 ID：21xxxxxxxx::demouser
    • password：数据库账号的密码由管理员创建数据库账号时自定义配置，您可联系管理员获取密码。如果密码丢失或遗忘，可通联系管理员重置密码，详情请参考重置密码。

高级配置

Dial Timeout (seconds)

600

Query Timeout (seconds)

600

自定义设置

virtual_warehouse

您的计算组 ID，可通过 ByteHouse 控制台 > 租户管理 > 参数设置，查看默认计算组 ID。

执行 SQL 语句

通过 MySQL 数据源连接

  1. 通过 Home > Connections > Data Sources > Add data source 路径，搜索并添加 MySQL 数据源。
    Image

  2. 填写连接信息。

    参数

    使用 IAM 用户连接

    Host URL

    配置为 ByteHouse 的网络域名。您可以在 ByteHouse 控制台的 租户管理 > 基本信息 > 网络信息中查看对应信息。详情请参见 步骤二：配置网络信息。

    Database name

    部署 ByteHouse 数据库时自定义的数据库名称。

    Username & Password

    您可在 ByteHouse 控制台 > 租户管理 > 连接信息中获取的 API Key。详情请参见获取 API Key。

    • User 为 API Key 的前半部分，比如获取的 API Key xxxx.yyyy，则 User 需填写 xxxx。
    • 密码为 API Key 的前半部分，比如获取的 API Key xxxx.yyyy，则 User 需填写 yyyy。

    Use TLS Client Auth

    启用

    Skip TLS Verification

    启用

    Allow Cleartext Passwords

    可选配置，启用后，Username & Password 的配置信息如下：

    • User Name 默认为 bytehouse。
    • 密码为 <API_Key>，可以在 ByteHouse 控制台 > 租户管理 > 连接信息中获取的 API Key。详情请参见获取 API Key。