将 ProbeDeck 连接到 ClickHouse

ProbeDeck 是一款适用于 iOS 和 iPadOS 的客户端，可用于检查 ClickHouse server 的健康状况、查看 system 表以及运行 SQL。它可通过设备网络或 SSH 堡垒机连接到 ClickHouse HTTP 接口， 无需中继服务器。

• 从 App Store 安装 ProbeDeck。
• 使用 iOS 或 iPadOS 17.0 或更高版本。
• 确保设备可通过网络、VPN 或 SSH 堡垒机访问 ClickHouse 的 HTTP 或 HTTPS 端点。
• 创建一个可访问要查询数据库的 ClickHouse 用户。
• 授予该用户相关 system 表的 SELECT 权限，以便进行监控。

某些监控部分依赖可选的日志表或较新的系统表。例如， ProbeDeck 用于获取已配置内存限制的 system.server_settings 需要 ClickHouse 23.3 或更高版本。当其数据源不可用时，ProbeDeck 会将受影响的部分标记为受限。

1. ProbeDeck 向 ClickHouse HTTP(S) 端点发送 SQL 请求。
2. 它使用已配置的 ClickHouse 用户从 system 表读取监控数据。
3. 应用会在设备上显示查询结果和监控视图。当设备无法直接访问端点时，可通过 SSH 堡垒机建立相同的 HTTP(S) 连接。

获取服务连接详细信息

在 ClickHouse Cloud 控制台中，打开您的服务，选择 Connect，然后选择 HTTPS。

要通过 HTTP(S) 连接到 ClickHouse，你需要以下信息：

Parameter(s)	Description
HOST and PORT	通常，使用 TLS 时端口为 8443；不使用 TLS 时端口为 8123。
DATABASE NAME	默认情况下，存在一个名为 default 的数据库。请使用你要连接的数据库名称。
USERNAME and PASSWORD	默认情况下，用户名为 default。请根据你的使用场景使用相应的用户名。

你的 ClickHouse Cloud 服务的连接信息可在 ClickHouse Cloud 控制台中查看。 选择一个服务，然后点击 Connect：

选择 HTTPS。连接信息会显示在示例 curl 命令中。

如果你使用的是自管理 ClickHouse，则连接信息由你的 ClickHouse 管理员配置。

在 ProbeDeck 中添加连接

1. 在 Connections 页面中，点击 +。
2. 输入连接名称和主机地址 (不含 https://) 。
3. 将 Port 设置为 8443，并启用 TLS。
4. 输入 Connect 对话框中的数据库用户名和密码。数据库名称为 可选。
5. 点击 Test Connection。检查成功后，ProbeDeck 会显示服务器版本和往返时间。
6. 点击 Save。

ProbeDeck 使用这些数据库凭据对发送至服务端点的 SQL 请求进行身份验证。 ClickHouse Cloud 使用 API Keys 页面中的组织级密钥来访问 Cloud API 和查询 API 端点。 ProbeDeck 的 SQL 连接流程不使用这些密钥。

在连接表单中启用 SSH 隧道，然后输入：

1. 堡垒机主机地址和 SSH 端口 (默认为 22) 。
2. SSH 用户名。
3. SSH 密码或私钥。

ProbeDeck 会通过 SSH direct-tcpip 通道，从堡垒机连接到 服务器 部分中指定的 ClickHouse 主机和 HTTP(S) 端口。首次连接时，在接受前请将堡垒机的 SHA-256 主机密钥指纹与服务器管理员提供的值进行核对。

ProbeDeck 会通过 X-ClickHouse-User 和 X-ClickHouse-Key 请求头发送数据库用户名和密码，不会将凭据置于 URL 中。

如需使用双向 TLS，请启用 TLS Client Certificate，然后导入包含 客户端证书和私钥的 PKCS#12 (.p12) 文件，并输入其密码短语。

当自托管端点提供自签名证书或由私有 CA 签发的证书时，ProbeDeck 会显示其 SHA-256 指纹、签发方、主体和有效期。接受前，请将该 指纹与服务器管理员提供的值进行比对。ProbeDeck 会将此决定绑定到该连接；如果证书发生变更，连接会停止，直至您完成审核。

ProbeDeck 会将连接密钥和导入的密钥材料存储在设备的 iOS Keychain 中。

打开已保存的连接，然后选择 监控。该仪表板汇总以下数据源：

点击 正在运行的查询，按耗时对活动查询排序，并查看内存和读取行数。

本示例使用 UK property price dataset。 将数据集加载到 uk_price_paid，然后：

1. 打开连接，然后选择 数据。
2. 打开 SQL 编辑器。
3. 运行以下有界只读查询：

SELECT
    town,
    count() AS sales,
    round(avg(price)) AS average_price
FROM uk_price_paid
GROUP BY town
ORDER BY sales DESC
LIMIT 10

结果应包含十个城镇及其交易数量和平均价格。

• ProbeDeck 支持 iOS 和 iPadOS 17.0 及更高版本。
• 免费用户一次只能保存一个连接。删除该连接即可释放名额；ProbeDeck Pro 支持 保存不限数量的连接。
• 它支持 ClickHouse HTTP(S) 接口，不支持原生协议。
• ProbeDeck 会按每页 200 行加载 SQL 查询结果，并将每个请求最多限制为 10,000 行。对于大型表，请使用 有选择性的 WHERE 子句和 LIMIT。
• 监控的可见性取决于 ClickHouse 用户的授权以及可选的日志表。
• 设备需要能够通过其网络、VPN 或内置 SSH 隧道访问端点。
• 监控和只读 SQL 无需应用内购买。KILL QUERY、KILL MUTATION、 写入和 DDL 语句以及其他运维操作需要 ProbeDeck Pro。

• 有关 ProbeDeck 的详细信息，请访问 ProbeDeck 网站。
• 有关服务器配置，请参阅 ClickHouse HTTP 接口文档。