Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add content for clinic us server #10362

Merged
merged 15 commits into from
Jul 13, 2022
Merged

add content for clinic us server #10362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
759f782
add content for clinic us server
qqqdan Jul 5, 2022
0ebac3c
add content
qqqdan Jul 9, 2022
b6fdd74
make ci happy
Oreoxmt Jul 11, 2022
5864879
update format
Oreoxmt Jul 11, 2022
c7cf77c
update format
Oreoxmt Jul 11, 2022
2114c0b
update us and cn
qqqdan Jul 11, 2022
5d6b576
remove technical preview
Oreoxmt Jul 11, 2022
d040978
update description
Oreoxmt Jul 11, 2022
5cbe974
add release related content
qqqdan Jul 12, 2022
2892249
fix format
Oreoxmt Jul 13, 2022
e9a373b
fix format
Oreoxmt Jul 13, 2022
f9312fd
use note format
Oreoxmt Jul 13, 2022
f8e35d7
Update clinic-introduction.md
qqqdan Jul 13, 2022
5a27bf6
Update clinic/clinic-introduction.md
Oreoxmt Jul 13, 2022
e462144
Apply suggestions from code review
Oreoxmt Jul 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion TOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@
- [tiup-cluster 部署运维生产集群](/tiup/tiup-cluster.md)
- [tiup-mirror 定制离线镜像](/tiup/tiup-mirror.md)
- [tiup-bench 进行 TPCC/TPCH 压力测试](/tiup/tiup-bench.md)
- PingCAP Clinic 诊断服务 (Technical Preview)
- PingCAP Clinic 诊断服务
- [概述](/clinic/clinic-introduction.md)
- [快速上手](/clinic/quick-start-with-clinic.md)
- [使用 PingCAP Clinic 诊断 TiDB 集群](/clinic/clinic-user-guide-for-tiup.md)
Expand Down
5 changes: 3 additions & 2 deletions clinic/clinic-data-instruction-for-tiup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ summary: 详细说明 PingCAP Clinic 诊断服务在使用 TiUP 部署的 TiDB

通过 PingCAP Clinic 在使用 TiUP 部署的集群中采集的数据**仅**用于诊断和分析集群问题。

Clinic Server 是部署在云端的云服务，位于 PingCAP 内网（中国境内）。如果你把采集的数据上传到了 Clinic Server 供 PingCAP 技术人员远程定位集群问题，这些数据将存储于 PingCAP 设立在 AWS S3 中国区（北京）的服务器。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。
Clinic Server 是部署在云端的云服务，根据数据存储的位置不同，分为以下两个独立的服务：

在对应的技术支持 Case 关闭后，PingCAP 会在 90 天内对相关数据进行永久删除或匿名化处理。
- [Clinic Server 中国区](https://clinic.pingcap.com.cn)：如果你把采集的数据上传到了 Clinic Server 中国区，这些数据将存储于 PingCAP 设立在 AWS 中国区（北京）的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。
- [Clinic Server 美国区](https://clinic.pingcap.com)：如果你把采集的数据上传到了 Clinic Server 美国区，这些数据将存储于 PingCAP 设立在 AWS 美国区的 S3 服务。PingCAP 对数据访问权限进行了严格的访问控制，只有经授权的内部技术人员可以访问该数据。

## TiDB 集群

Expand Down
27 changes: 22 additions & 5 deletions clinic/clinic-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,27 @@ summary: 介绍 PingCAP Clinic 诊断服务，包括工具组件、使用场景

PingCAP Clinic 诊断服务（以下简称为 PingCAP Clinic）是 PingCAP 为 TiDB 集群提供的诊断服务，支持对使用 TiUP 或 TiDB Operator 部署的集群进行远程定位集群问题和本地快速检查集群状态，用于从全生命周期确保 TiDB 集群稳定运行、预测可出现的集群问题、降低问题出现概率、快速定位并修复问题。

PingCAP Clinic 目前处于 Technical Preview 阶段。该服务提供以下两个组件进行集群诊断：
PingCAP Clinic 服务提供以下两个组件进行集群诊断：

- Diag 诊断客户端：部署在集群侧的工具，用于采集集群的诊断数据 (collect)、上传诊断数据到 Clinic Server、对集群进行本地快速健康检查 (check)。如需了解 Diag 工具可采集的详细的数据列表，请参阅 [PingCAP Clinic 数据采集说明](/clinic/clinic-data-instruction-for-tiup.md)。

> **注意：**
>
> Diag 诊断客户端暂时**不支持**对使用 TiDB Ansible 部署的集群进行数据采样。
> Diag 诊断客户端支持 TiDB v4.0 及以上的集群，**不支持**使用 TiDB Ansible 部署的集群。

- [Clinic Server](https://clinic.pingcap.com.cn)：部署在云端的云服务。Clinic Server 提供 SaaS 模式的诊断服务，不仅能接收上传到该组件的诊断数据，也可以提供在线诊断环境，用于存储、查看和诊断已上传的诊断数据，并提供集群诊断报告。
- Clinic Server：部署在云端的云服务。Clinic Server 提供 SaaS 模式的诊断服务，不仅能接收上传到该组件的诊断数据，也可以提供在线诊断环境，用于存储、查看和诊断已上传的诊断数据，并提供集群诊断报告。根据数据存储的位置不同，Clinic Server 分为以下两个独立的服务：
- [Clinic Server 中国区](https://clinic.pingcap.com.cn)，数据存储在 AWS 中国区（北京）。
- [Clinic Server 美国区](https://clinic.pingcap.com)，数据存储在 AWS 美国区。

## 使用场景

- 远程定位集群问题

当集群出现无法快速修复的问题时，可以求助社区论坛或者联系 PingCAP 技术支持。当申请远程协助时，你需要先保存问题现场的各种诊断数据，然后将其转发给相关技术人员。此时，你可以使用 Diag 诊断客户端，对诊断数据进行一键采集，快速收集完整的诊断数据，替代复杂的手动数据采集操作。随后，你可以将其诊断数据上传到 Clinic Server，供 PingCAP 技术人员查看。Clinic Server 为诊断数据提供了安全的存储，并支持在线诊断，提升了技术人员进行问题定位的效率。

- 本地快速检查集群状态
- 快速检查集群状态

即使集群可以正常运行，也需要定期检查集群是否有潜在的稳定性风险。PingCAP Clinic 提供的本地快速诊断功能，用于检查集群潜在的健康风险。目前 PingCAP Clinic Technical Preview 版本主要提供对集群配置项的合理性检查，用于发现不合理的配置，并提供修改建议。
即使集群可以正常运行，也需要定期检查集群是否有潜在的稳定性风险。PingCAP Clinic 提供的本地和 Server 端的快速诊断功能，用于检查集群潜在的健康风险。

## 工作原理

Expand All @@ -50,6 +52,21 @@ PingCAP Clinic 目前处于 Technical Preview 阶段。该服务提供以下两

通过 SQL 语句，Diag 可以查询 TiDB 数据库的系统参数等信息。对于这种方式，你需要在采集数据时**额外提供**访问 TiDB 数据库的用户名和密码。

## Clinic Server 使用限制

> **注意：**
>
> - Clinic Server 诊断服务在 2022 年 7 月 15 日至 2023 年 1 月 14 日期间提供免费服务。后续如需收取相关费用，PingCAP Clinic 运营团队将在 2023 年 1 月 14 日前通过邮件通知用户。
> - 如果需要调整使用限制，可以联系 PingCAP 技术支持。

| 诊断服务类型| 使用限制 |
| :------ | :------ |
| 每个组织最多可以创建的集群数量 | 10 个 |
| 诊断数据存储容量 | 50 GB/集群 |
| 诊断数据最长存储时间 | 180 天 |
| 数据包最大大小 | 3 GB |
| 诊断数据重建保存时间| 最长 3 天|

## 探索更多

- 在 TiUP 部署环境使用 PingCAP Clinic
Expand Down
102 changes: 63 additions & 39 deletions clinic/clinic-user-guide-for-tiup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

# 使用 PingCAP Clinic 诊断 TiDB 集群

对于使用 TiUP 部署的 TiDB 集群和 DM 集群，PingCAP Clinic 诊断服务（以下简称为 PingCAP Clinic）可以通过 Diag 诊断客户端（以下简称为 Diag）与 [Clinic Server 云诊断平台](https://clinic.pingcap.com.cn)（以下简称为 Clinic Server）实现远程定位集群问题和本地快速检查集群状态。

目前，PingCAP Clinic 处于 Technical Preview 阶段。
对于使用 TiUP 部署的 TiDB 集群和 DM 集群，PingCAP Clinic 诊断服务（以下简称为 PingCAP Clinic）可以通过 Diag 诊断客户端（以下简称为 Diag）与 Clinic Server 云诊断平台（以下简称为 Clinic Server）实现远程定位集群问题和本地快速检查集群状态。

> **注意：**
>
> PingCAP Clinic 暂时**不支持**对使用 TiDB Ansible 部署的集群进行数据采集。
> - 本文档**仅**适用于使用 TiUP 部署的集群。如需查看适用于使用 Operator 部署的集群，请参阅 [在 TiDB Operator 部署环境使用 PingCAP Clinic](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/clinic-user-guide)。
>
> - PingCAP Clinic 暂时**不支持**对使用 TiDB Ansible 部署的集群进行数据采集。

## 使用场景

Expand All @@ -22,7 +22,7 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

- [本地快速检查集群状态](#本地快速检查集群状态)

即使集群可以正常运行，也需要定期检查集群是否有潜在的稳定性风险。PingCAP Clinic 提供的本地快速诊断功能，用于检查集群潜在的健康风险。目前 PingCAP Clinic Technical Preview 版本主要对集群配置项提供合理性检查，用于发现不合理的配置，并提供修改建议。
即使集群可以正常运行，也需要定期检查集群是否有潜在的稳定性风险。PingCAP Clinic 提供的本地快速诊断功能，用于检查集群潜在的健康风险，本地诊断只覆盖配置项检查。如果需要更全面的检查，推荐上传诊断数据包到 Clinic Server，使用 Clinic Server 提供的 Health Report 对 Metrics、日志和配置项进行全面的快速检查。

## 准备工作

Expand All @@ -32,16 +32,12 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

- 如果你的中控机上已经安装了 TiUP，可以使用以下命令一键安装 Diag：

{{< copyable "shell-regular" >}}

```bash
tiup install diag
```

- 若已安装了 Diag，你可以通过以下命令，将本地的 Diag 一键升级至最新版本：

{{< copyable "shell-regular" >}}

```bash
tiup update diag
```
Expand All @@ -55,25 +51,73 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

使用 Diag 上传采集到的数据时，你需要通过 Token 进行用户认证，以保证数据上传到组织后被安全地隔离。获取一个 Token 后，你可以重复使用该 Token。如果你已经获取过并在 Diag 上设置过 Token，可跳过此步骤。

首先，通过以下方法获取 Token：登录 [Clinic Server](https://clinic.pingcap.com.cn)，点击 Cluster 页面右下角的图标，选择 **Get Access Token For Diag Tool**，在弹出窗口中点击 **+** 符号获取 Token 后，复制并保存 Token 信息。
首先，通过以下方法获取 Token：

- 登录 Clinic Server。

<SimpleTab>
<div label="Clinic Server 中国区">

[Clinic Server 中国区](https://clinic.pingcap.com.cn)，数据存储在亚马逊云服务中国区。

</div>

<div label="Clinic Server 美国区">

[Clinic Server 美国区](https://clinic.pingcap.com)，数据存储在亚马逊云服务美国区。

![Token 示例](/media/clinic-get-token.png)
</div>
</SimpleTab>

- 点击 Cluster 页面右下角的图标，选择 **Get Access Token For Diag Tool**，在弹出窗口中点击 **+** 符号获取 Token 后，复制并保存 Token 信息。

![Token 示例](/media/clinic-get-token.png)

> **注意：**
>
> - 如果你第一次访问 Clinic Server，请参考[快速上手指南：准备数据上传环境](/clinic/quick-start-with-clinic.md#准备工作)的相关步骤。
> - 为了确保数据的安全性，TiDB 只在创建 Token 时显示 Token 信息。如果丢失了 Token 信息，你可以删除旧 Token 后重新创建。
> - Token 只用于上传数据。

然后，参考以下命令行，在 Diag 中设置该 Token：

{{< copyable "shell-regular" >}}
然后，参考以下命令，在 Diag 中设置该 Token：

```bash
tiup diag config clinic.token ${token-value}
```

3. 开启日志脱敏配置（可选步骤）。
3. 在 Diag 中设置 `region`。

`region` 决定数据打包时使用的加密证书和上传的目标 Clinic Server 地址。参考以下命令，根据你的 Clinic Server 在 Diag 中设置 `clinic.region`。

> **注意：**
>
> - Diag v0.9.0 及以后的版本支持 `region` 设置。
> - 对于 Diag v0.9.0 之前的版本，数据默认上传到 Clinic Server 中国区。
> - 如果你的 Diag 是 v0.9.0 之前的版本，你可以通过 `tiup update diag` 命令将其升级至最新版本后设置 `region`。

<SimpleTab>
<div label="Clinic Server 中国区">

对于 Clinic Server 中国区，参考以下命令，将 `region` 设置为 `CN`：

```bash
tiup diag config clinic.region CN
```

</div>

<div label="Clinic Server 美国区">

对于 Clinic Server 美国区，参考以下命令，将 `region` 设置为 `US`：

```bash
tiup diag config clinic.region US
```

</div>
</SimpleTab>

4. 开启日志脱敏配置（可选步骤）。

TiDB 在提供详细的日志信息时可能会打印数据库的敏感信息（例如用户数据）。如果希望本地日志及上传到 Clinic Server 的日志中不带有敏感信息，你可以开启日志脱敏配置。具体操作请参考[日志脱敏](/log-redaction.md#tidb-组件日志脱敏)。

Expand All @@ -97,8 +141,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

例如，如需采集从当前时间的 4 小时前到 2 小时前的诊断数据，可以运行以下命令：

{{< copyable "shell-regular" >}}

```bash
tiup diag collect ${cluster-name} -f="-4h" -t="-2h"
```
Expand All @@ -125,8 +167,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

运行 Diag 数据采集命令后，Diag 不会立即开始采集数据，而会在输出中提供预估数据量大小和数据存储路径，并询问你是否进行数据收集。例如：

{{< copyable "shell-regular" >}}

```bash
Estimated size of data to collect:
Host Size Target
Expand All @@ -146,8 +186,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

采集完成后，Diag 会提示采集数据所在的文件夹路径。例如：

{{< copyable "shell-regular" >}}

```bash
Collected data are stored in /home/qiaodan/diag-fNTnz5MGhr6
```
Expand All @@ -158,8 +196,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

例如，如需采集从当前时间的 4 小时前到 2 小时前的诊断数据，可以运行以下命令：

{{< copyable "shell-regular" >}}

```bash
tiup diag collectdm ${cluster-name} -f="-4h" -t="-2h"
```
Expand All @@ -174,8 +210,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

采集完成后，Diag 会提示采集数据所在的文件夹路径。例如：

{{< copyable "shell-regular" >}}

```bash
Collected data are stored in /home/qiaodan/diag-fNTnz5MGhr6
```
Expand Down Expand Up @@ -204,7 +238,7 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

> **注意：**
>
> 如果在上传前没有在 Diag 中设置 Token，Diag 会提示上传失败，并提醒你设置 Token。关于 Token 获取方法，请参考[准备工作：第 2 步](#准备工作)。
> 如果在上传前没有在 Diag 中设置 Token 或 `region`，Diag 会提示上传失败，并提醒你进行设置。关于 Token 获取方法，请参考[准备工作：第 2 步](#准备工作)。

#### 方式 1：直接上传

Expand All @@ -224,8 +258,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

1. 打包在[第 2 步：采集数据](#第-2-步采集数据)中采集的数据，并对其数据包进行压缩和加密：

{{< copyable "shell-regular" >}}

```bash
tiup diag package ${filepath}
```
Expand All @@ -241,8 +273,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

2. 使用可以访问互联网的机器上传数据压缩包。

{{< copyable "shell-regular" >}}

```bash
tiup diag upload ${filepath}
```
Expand All @@ -255,8 +285,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

1. 采集配置数据：

{{< copyable "shell-regular" >}}

```bash
tiup diag collect ${cluster-name} --include="config"
```
Expand All @@ -265,8 +293,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

2. 诊断配置数据：

{{< copyable "shell-regular" >}}

```bash
tiup diag check ${subdir-in-output-data}
```
Expand All @@ -277,8 +303,6 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

诊断结果会在命令行中返回，示例如下：

{{< copyable "shell-regular" >}}

```bash
Starting component `diag`: /root/.tiup/components/diag/v0.7.0/diag check diag-fNTnz5MGhr6

Expand Down Expand Up @@ -322,7 +346,7 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini
Result report and record are saved at diag-fNTnz5MGhr6/report-220125153215
```

在上述示例诊断结果信息的最后一部分（即 '#### 诊断结果文档的保存路径'）中，对于被发现的每一条潜在的配置问题，Diag 都会提供对应的知识库链接，以便查看详细的配置建议。在上面示例中，相关链接为 `https://s.tidb.io/msmo6awg`。
在上述示例诊断结果信息的最后一部分（即“#### 诊断结果文档的保存路径”）中，对于被发现的每一条潜在的配置问题，Diag 都会提供对应的知识库链接，以便查看详细的配置建议。在上面示例中，相关链接为 `https://s.tidb.io/msmo6awg`。

## 常见问题

Expand All @@ -332,8 +356,8 @@ summary: 详细介绍在使用 TiUP 部署的集群上如何通过 PingCAP Clini

2. 数据上传后，无法打开返回的数据访问链接，怎么办？

你可以先尝试登录 [Clinic Server](https://clinic.pingcap.com.cn)。如果登录后依然无法打开链接，请确认你是否拥有访问该数据的权限。如果没有权限，你需要联系数据所有人给你添加权限后，重新登录 Clinic Server 并访问数据链接。
你可以先尝试登录 Clinic Server。如果登录后依然无法打开链接，请确认你是否拥有访问该数据的权限。如果没有权限，你需要联系数据所有人给你添加权限后，重新登录 Clinic Server 并访问数据链接。

3. 上传到 Clinic Server 的数据后会保存多久？

在对应的技术支持 Case 关闭后，PingCAP 会在 90 天内对相关数据进行永久删除或匿名化处理。
最长 180 天，用户可以随时通过 Clinic Server 页面删除自己上传的集群诊断数据。
Loading