Clinic: add new docs

clinic/Clinic 数据采集说明 - TiUP 环境.md

@@ -0,0 +1,130 @@
+---
+title: Clinic 数据采集说明 - TiUP 环境
+summary: 详细说明 Clinic 采集哪些诊断数据
+---
+
+# Clinic 数据采集说明 - TiUP 环境
+
+## 数据用途
+仅用集群问题分析和诊断。
+
+## 数据存储和安全
+数据存储于 PingCAP 设立在 AWS S3 中国区（北京）的服务器，数据诊断分析服务器位于 PingCAP 内网，在中国境内。
+数据访问权限做了严格的访问控制，只有经授权的 PingCAP 技术人员能够访问。
+数据将在对应的技术支持 Case 关闭后90天内永久删除或匿名化处理。
+
+## TiDB 集群数据采集范围
+### Cluster 基础信息
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 集群基础信息，包括集群 ID | cluster.json | 每次收集默认采集 |
+| 集群详细信息 | meta.yaml|每次收集默认采集 |
+
+### TiDB 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+|  日志 | tidb.log | --include=log|
+|  Error 日志 | meta.yaml| --include=log|
+|  慢日志| tidb_stderr.log|--include=log |
+| 配置文件 |  tidb.toml|--include=config |
+|  实时配置| config.json |--include=config |
+
+### TiKV 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 日志 | tikv.log | --include=log|
+|  Error 日志 | tikv_stderr.log| --include=log|
+| 配置文件 |  tikv.toml|--include=config|
+|  实时配置| config.json|--include=config |
+
+### PD 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 日志 | pd.log | --include=log|
+| Error 日志 |pd_stderr.log| --include=log|
+|  配置文件 | pd.toml|--include=config|
+|  实时配置| config.json|--include=config |
+| tiup ctl pd -u http://${pd IP}:${PORT} store  输出 | store.json|--include=config|
+|  tiup ctl pd -u http://${pd IP}:${PORT} config placement-rules show 输出 |placement-rule.json|--include=config |
+
+### TiFlash 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 日志 | tiflash.log | --include=log|
+| Error 日志 |tiflash_stderr.log| --include=log|
+|  配置文件 |  tiflash-learner.toml, tiflash-preprocessed.toml, tiflash.toml| --include=config|
+|  实时配置| config.json| --include=config |
+
+### TiCDC 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 日志 | ticdc.log | --include=log|
+| Error 日志 |ticdc_stderr.log| --include=log|
+|  配置文件 |  ticdc.toml| --include=config|
+|  实时配置| config.json| --include=config |
+
+
+### Prometheus 监控数据
+|诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 所有的 Metrics 数据|XXXXX.json| --include=monitor |
+|  Alert 配置 |alerts.json| --include=monitor |
+
+### TiDB 系统变量 
+|诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 获取 tidb 系统变量（默认不采集，采集需要额外提供 db 帐号） |mysql.tidb.csv| --include=db_vars|
+| |global_variables.csv| --include=db_vars |
+
+
+### 集群系统信息
+
+|诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+|内核日志 |dmesg.log| --include=system |
+| 基础的系统和硬件信息|insight.json| --include=system |
+|  系统 /etc/security/limits.conf 中的内容|limits.conf| --include=system |
+| 内核参数列表 |sysctl.conf| --include=system |
+|  基础的系统和硬件信息|insight.json| --include=system |
+|  socket 统计信息，ss 命令结果|ss.txt| --include=system |
+
+
+
+## DM 集群数据采集范围
+
+### Cluster 基础信息
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 集群基础信息，包括集群 ID | cluster.json | 每次收集默认采集 |
+| 集群详细信息 | meta.yaml|每次收集默认采集 |
+
+### dm-master 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+|  日志 | dm-master.log| --include=log|
+|  Error 日志 | dm-master_stderr.log| --include=log|
+|  配置文件 | dm-master.toml | --include=config|
+
+### dm-worker 诊断数据
+|  诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+|  日志| dm-worker.log|--include=log |
+|  Error 日志 | dm-worker_stderr.log| --include=log|
+|  配置文件 |  dm-work.toml | --include=config|
+
+### Prometheus 监控数据
+|诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+| 所有的 Metrics 数据|XXXXX.json| --include=monitor |
+|  Alert 配置 |alerts.json| --include=monitor |
+
+### 集群系统信息
+
+|诊断数据类型 | 输出文文件 | Clinic 采集参数 |
+| :------ | :------ |:-------- |
+|内核日志 |dmesg.log| --include=system |
+| 基础的系统和硬件信息|insight.json| --include=system |
+|  系统 /etc/security/limits.conf 中的内容|limits.conf| --include=system |
+| 内核参数列表 |sysctl.conf| --include=system |
+|  基础的系统和硬件信息|insight.json| --include=system |
+|  socket 统计信息，ss 命令结果|ss.txt| --include=system |