clinic: add dm-cluster some desc (#10103) (#10752)

pingcap · Oct 11, 2022 · 3089273 · 3089273
1 parent 016226d
commit 3089273
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 39 deletions.
diff --git a/TOC.md b/TOC.md
@@ -346,7 +346,7 @@
   - PingCAP Clinic Diagnostic Service
     - [Overview](/clinic/clinic-introduction.md)
     - [Quick Start](/clinic/quick-start-with-clinic.md)
-    - [Troubleshoot TiDB Cluster Using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
+    - [Troubleshoot Clusters Using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
     - [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md)
   - [TiDB Operator](/tidb-operator-overview.md)
   - [Dumpling](/dumpling-overview.md)

diff --git a/clinic/clinic-introduction.md b/clinic/clinic-introduction.md
@@ -76,7 +76,7 @@ First, Diag gets cluster topology information from the deployment tool TiUP (tiu
 
 - Use PingCAP Clinic in an on-premise environment
     - [Quick Start with PingCAP Clinic](/clinic/quick-start-with-clinic.md)
-    - [Troubleshoot TiDB Cluster using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
+    - [Troubleshoot Clusters using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
     - [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md)
 
 - Use PingCAP Clinic in Kubernetes

diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md
@@ -1,9 +1,9 @@
 ---
-title: Troubleshoot TiDB Cluster Using PingCAP Clinic
-summary: Learn how to use the PingCAP Clinic Diagnostic Service to troubleshoot cluster problems remotely and perform a quick check of the cluster status on a cluster deployed using TiUP.
+title: Troubleshoot Clusters Using PingCAP Clinic
+summary: Learn how to use the PingCAP Clinic Diagnostic Service to troubleshoot cluster problems remotely and perform a quick check of the cluster status on a TiDB cluster or DM cluster deployed using TiUP.
 ---
 
-# Troubleshoot TiDB Cluster Using PingCAP Clinic
+# Troubleshoot Clusters Using PingCAP Clinic
 
 For TiDB clusters and DM clusters deployed using TiUP, you can use PingCAP Clinic Diagnostic Service (PingCAP Clinic) to troubleshoot cluster problems remotely and perform a quick check on cluster status locally using Diag client (Diag) and Clinic Server.
 
@@ -128,30 +128,41 @@ You can use Diag to quickly collect diagnostic data from TiDB clusters and DM cl
 
 For a full list of data that can be collected by Diag, see [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md).
 
-To improve the efficiency of the later diagnosis, you are recommended to collect full diagnostic data including monitoring data and configuration information. For details, see [Collect data from TiDB clusters](#collect-data-from-tidb-clusters).
+To improve the efficiency of the later diagnosis, you are recommended to collect full diagnostic data including monitoring data and configuration information. For details, see [Collect data from clusters](#step-2-collect-data).
 
 ### Step 2. Collect data
 
 With Diag, you can collect data from the TiDB clusters and the DM clusters deployed using TiUP.
 
-#### Collect data from TiDB clusters
-
 1. Run the data collection command of Diag.
 
     For example, to collect the diagnostic data from 4 hours ago to 2 hours ago based on the current time, run the following command:
 
+    <SimpleTab>
+    <div label="TiDB Cluster">
+
     ```bash
     tiup diag collect ${cluster-name} -f="-4h" -t="-2h"
     ```
 
+    </div>
+    <div label="DM Cluster">
+
+    ```bash
+    tiup diag collectdm ${dm-cluster-name} -f="-4h" -t="-2h"
+    ```
+
+    </div>
+    </SimpleTab>
+
     Descriptions of the parameters for data collection:
 
     - `-f/--from`: specifies the start time of the data collection. If you do not specify this parameter, the default start time is 2 hours before the current time. To modify the time zone, use the `-f="12:30 +0800"` syntax. If you do not specify the time zone information in this parameter, such as `+0800`, the time zone is UTC by default.
     - `-t/--to`: specifies the end time of the data collection. If you do not specify this parameter, the default end time is the current moment. To modify the time zone, use the `-f="12:30 +0800"` syntax. If you do not specify the time zone information in this parameter, such as `+0800`, the time zone is UTC by default.
 
     Parameter usage tips:
 
-    In addition to specifying the data collection time, you can use Diag to specify more parameters. To get all parameters, run the `tiup diag collect -h` command.
+    In addition to specifying the data collection time, you can use Diag to specify more parameters. To get all parameters, run the `tiup diag collect -h` or `tiup diag collectdm -h` command.
 
     > **Note:**
     >
@@ -175,7 +186,7 @@ With Diag, you can collect data from the TiDB clusters and the DM clusters deplo
     ... ...
     172.16.7.179       325 B      /tidb-deploy/tikv-20160/conf/tikv.toml
     Total              2.01 GB    (inaccurate)
-    These data will be stored in /home/qiaodan/diag-fNTnz5MGhr6
+    These data will be stored in /home/user/diag-fNTnz5MGhr6
     Do you want to continue? [y/N]: (default=N)
     ```
 
@@ -186,31 +197,7 @@ With Diag, you can collect data from the TiDB clusters and the DM clusters deplo
     After the collection is complete, Diag provides the folder path where the collected data is located. For example:
 
     ```bash
-    Collected data are stored in /home/qiaodan/diag-fNTnz5MGhr6
-    ```
-
-#### Collect data from DM clusters
-
-1. Run the data collection command of Diag.
-
-    For example, to collect the diagnostic data from 4 hours ago to 2 hours ago based on the current time, run the following command:
-
-    ```bash
-    tiup diag collectdm ${cluster-name} -f="-4h" -t="-2h"
-    ```
-
-    For descriptions of the parameters used in the above commands or other parameters that you might use with Diag, refer to [Collect data from TiDB clusters](#collect-data-from-tidb-clusters).
-
-    After you run the command, Diag does not start collecting data immediately. Instead, Diag provides the estimated data size and the target data storage path in the output for you to confirm whether to continue.
-
-2. Enter `Y` to confirm that you want to start collecting data.
-
-    Collecting data takes a certain amount of time. The time varies according to the volume of data to be collected. For example, in a test environment, collecting 1 GB of data takes about 10 minutes.
-
-    After the collection is complete, Diag provides the folder path where the collected data is located. For example:
-
-    ```bash
-    Collected data are stored in /home/qiaodan/diag-fNTnz5MGhr6
+    Collected data are stored in /home/user/diag-fNTnz5MGhr6
     ```
 
 ### Step 3. View data locally (optional)
@@ -265,7 +252,7 @@ If the network where your cluster is located cannot access the internet, you nee
 
     ```bash
     Starting component `diag`: /root/.tiup/components/diag/v0.7.0/diag package diag-fNTnz5MGhr6
-    packaged data set saved to /home/qiaodan/diag-fNTnz5MGhr6.diag
+    packaged data set saved to /home/user/diag-fNTnz5MGhr6.diag
     ```
 
     After the packaging is complete, the data is packaged to the `.diag` format. The `.diag` file can only be decrypted and viewed after being uploaded to the Clinic Server. If you want to directly forward the collected data instead of uploading it to the Clinic Server, you can compress the data by your own method and forward it.
@@ -279,8 +266,8 @@ If the network where your cluster is located cannot access the internet, you nee
     The following is an example output:
 
     ```bash
-    [root@Copy-of-VM-EE-CentOS76-v1 qiaodan]# tiup diag upload /home/qiaodan/diag-fNTnz5MGhr6
-    Starting component `diag`: /root/.tiup/components/diag/v0.7.0/diag upload /home/qiaodan/diag-fNTnz5MGhr6
+    [root@Copy-of-VM-EE-CentOS76-v1 user]# tiup diag upload /home/user/diag-fNTnz5MGhr6
+    Starting component `diag`: /root/.tiup/components/diag/v0.7.0/diag upload /home/user/diag-fNTnz5MGhr6
     >>>>>>>>>>>>>>>>>>>>>>>>>>>>>><>>>>>>>>>
     Completed!
     Download URL: "https://clinic.pingcap.com.cn/portal/#/orgs/4/clusters/XXXX"

diff --git a/clinic/quick-start-with-clinic.md b/clinic/quick-start-with-clinic.md
@@ -154,5 +154,5 @@ Before using PingCAP Clinic, you need to install Diag and prepare an environment
 ## What's next
 
 - [PingCAP Clinic Overview](/clinic/clinic-introduction.md)
-- [Troubleshoot TiDB Cluster Using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
+- [Troubleshoot Clusters Using PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md)
 - [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md)