diff --git a/TOC.md b/TOC.md index 68625eaab6914..b88fca5d406f6 100644 --- a/TOC.md +++ b/TOC.md @@ -191,10 +191,10 @@ - [tiup-cluster](/tiup/tiup-cluster.md) - [tiup-mirror](/tiup/tiup-mirror.md) - [tiup-bench](/tiup/tiup-bench.md) - - TiDB Clinic Diagnostic Service (Beta) - - [Overview](/clinic/clinic-introduction.md) - - [Use TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md) - - [TiDB Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md) + - TiDB Clinic Diagnostic Service (Beta) + - [Overview](/clinic/clinic-introduction.md) + - [Use TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md) + - [TiDB Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md) - [TiDB Operator](/tidb-operator-overview.md) - Backup & Restore (BR) - [BR Tool Overview](/br/backup-and-restore-tool.md) diff --git a/clinic/clinic-data-instruction-for-tiup.md b/clinic/clinic-data-instruction-for-tiup.md index 785276ff1f3f0..80bb0647e322a 100644 --- a/clinic/clinic-data-instruction-for-tiup.md +++ b/clinic/clinic-data-instruction-for-tiup.md @@ -17,7 +17,7 @@ After a technical support case is closed, PingCAP permanently deletes or anonymi This section lists the types of diagnostic data that can be collected by Diag from the TiDB clusters deployed using TiUP. -### Basic information of the cluster +### TiDB cluster information | Data type | Exported file | Parameter for data collection by TiDB Clinic | | :------ | :------ |:-------- | @@ -85,7 +85,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr | TiDB system variables (Diag does not collect this data type by default; if you need to collect this data type, database credential is required) | `mysql.tidb.csv` | `--include=db_vars` | | | `global_variables.csv` | `--include=db_vars` | -### System information of the cluster +### System information of the cluster node | Data type | Exported file | Parameter for data collection by TiDB Clinic | | :------ | :------ |:-------- | @@ -99,7 +99,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr This section lists the types of diagnostic data that can be collected by Diag from the DM clusters deployed using TiUP. -### Basic information of the cluster +### DM cluster information | Data type | Exported file | Parameter for data collection by TiDB Clinic | | :------ | :------ |:-------- | @@ -129,7 +129,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr | All metrics data | `{metric_name}.json` | `--include=monitor` | | All alerts data | `alerts.json` | `--include=monitor` | -### System information of the cluster +### System information of the cluster node | Data type | Exported file | Parameter for data collection by TiDB Clinic | | :------ | :------ |:-------- | diff --git a/clinic/clinic-introduction.md b/clinic/clinic-introduction.md index ba375691990c5..fac53242dfaec 100644 --- a/clinic/clinic-introduction.md +++ b/clinic/clinic-introduction.md @@ -1,9 +1,9 @@ --- -title: Overview of TiDB Clinic +title: TiDB Clinic Overview summary: Learn about the TiDB Clinic Diagnostic Service (TiDB Clinic), including tool components, user scenarios, and implementation principles. --- -## Overview of TiDB Clinic +## TiDB Clinic Overview TiDB Clinic Diagnostic Service (TiDB Clinic) is a diagnostic service provided by PingCAP for TiDB clusters that are deployed using either TiUP or TiDB Operator. This service helps to troubleshoot cluster problems remotely and provides a quick check of cluster status locally. With TiDB Clinic, you can ensure the stable operation of your TiDB cluster for its full life-cycle, predict potential problems, reduce the probability of problems, troubleshoot cluster problems quickly, and fix cluster problems.