From 57cf2da9841965cc64424cb70de2d587a6abf389 Mon Sep 17 00:00:00 2001 From: Enwei Date: Tue, 29 Mar 2022 20:44:29 +0800 Subject: [PATCH] change "TiDB Clinic" to "PingCAP Clinic" (#7900) --- TOC.md | 6 ++-- clinic/clinic-data-instruction-for-tiup.md | 38 +++++++++++----------- clinic/clinic-introduction.md | 24 +++++++------- clinic/clinic-user-guide-for-tiup.md | 28 ++++++++-------- 4 files changed, 48 insertions(+), 48 deletions(-) diff --git a/TOC.md b/TOC.md index c8b23709cf798..91a406b60ac74 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) + - PingCAP 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) + - [Use 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) - 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 80bb0647e322a..b6936a19ea890 100644 --- a/clinic/clinic-data-instruction-for-tiup.md +++ b/clinic/clinic-data-instruction-for-tiup.md @@ -1,13 +1,13 @@ --- -title: TiDB Clinic Diagnostic Data -summary: Learn what diagnostic data can be collected by TiDB Clinic Diagnostic Service from the TiDB and DM clusters deployed using TiUP. +title: PingCAP Clinic Diagnostic Data +summary: Learn what diagnostic data can be collected by PingCAP Clinic Diagnostic Service from the TiDB and DM clusters deployed using TiUP. --- -# TiDB Clinic Diagnostic Data +# PingCAP Clinic Diagnostic Data -This document provides the types of diagnostic data that can be collected by TiDB Clinic Diagnostic Service (TiDB Clinic) from the TiDB and DM clusters deployed using TiUP. Also, the document lists the parameters for data collection corresponding to each data type. When running a command to [collect data using the Clinic Diag tool (Diag)](/clinic/clinic-user-guide-for-tiup.md), you can add the required parameters to the command according to the types of the data to be collected. +This document provides the types of diagnostic data that can be collected by PingCAP Clinic Diagnostic Service (PingCAP Clinic) from the TiDB and DM clusters deployed using TiUP. Also, the document lists the parameters for data collection corresponding to each data type. When running a command to [collect data using the Clinic Diag tool (Diag)](/clinic/clinic-user-guide-for-tiup.md), you can add the required parameters to the command according to the types of the data to be collected. -The diagnostic data collected by TiDB Clinic is **only** used for troubleshooting cluster problems. +The diagnostic data collected by PingCAP Clinic is **only** used for troubleshooting cluster problems. Set up on the PingCAP intranet (in China), the Clinic Server is a cloud service deployed in the cloud. If you upload the collected diagnostic data to the Clinic Server for PingCAP technical support staff to troubleshoot cluster problems remotely, the uploaded data is stored in the AWS S3 China (Beijing) Region server set up by PingCAP. PingCAP strictly controls permissions for data access and only allows authorized in-house technical support staff to access the uploaded data. @@ -19,14 +19,14 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### TiDB cluster information -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Basic information of the cluster, including the cluster ID | `cluster.json` | The data is collected per run by default. | | Detailed information of the cluster | `meta.yaml` | The data is collected per run by default. | ### TiDB diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `tidb.log` | `--include=log` | | Error log | `tidb_stderr.log` | `--include=log` | @@ -36,7 +36,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### TiKV diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `tikv.log` | `--include=log` | | Error log | `tikv_stderr.log` | `--include=log` | @@ -45,7 +45,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### PD diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `pd.log` | `--include=log` | | Error log | `pd_stderr.log` | `--include=log` | @@ -56,7 +56,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### TiFlash diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `tiflash.log` | `--include=log` | | Error log | `tiflash_stderr.log` | `--include=log` | @@ -65,7 +65,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### TiCDC diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `ticdc.log` | `--include=log`| | Error log | `ticdc_stderr.log` | `--include=log` | @@ -73,21 +73,21 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### Prometheus monitoring data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | All metrics data | `{metric_name}.json` | `--include=monitor` | | All alerts data | `alerts.json` | `--include=monitor` | ### TiDB system variables -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | 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 node -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Kernel log | `dmesg.log` | `--include=system` | | Basic information of the system and hardware | `insight.json` | `--include=system` | @@ -101,14 +101,14 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### DM cluster information -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Basic information of the cluster, including the cluster ID | `cluster.json`| The data is collected per run by default. | | Detailed information of the cluster | `meta.yaml` | The data is collected per run by default. | ### dm-master diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log | `m-master.log` | `--include=log` | | Error log | `dm-master_stderr.log` | `--include=log` | @@ -116,7 +116,7 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### dm-worker diagnostic data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Log| `dm-worker.log` | `--include=log`| | Error log | `dm-worker_stderr.log` | `--include=log` | @@ -124,14 +124,14 @@ This section lists the types of diagnostic data that can be collected by Diag fr ### Prometheus monitoring data -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | All metrics data | `{metric_name}.json` | `--include=monitor` | | All alerts data | `alerts.json` | `--include=monitor` | ### System information of the cluster node -| Data type | Exported file | Parameter for data collection by TiDB Clinic | +| Data type | Exported file | Parameter for data collection by PingCAP Clinic | | :------ | :------ |:-------- | | Kernel log | `dmesg.log` | `--include=system` | | Basic information of the system and hardware | `insight.json` | `--include=system` | diff --git a/clinic/clinic-introduction.md b/clinic/clinic-introduction.md index fac53242dfaec..b0e983ae48cbf 100644 --- a/clinic/clinic-introduction.md +++ b/clinic/clinic-introduction.md @@ -1,26 +1,26 @@ --- -title: TiDB Clinic Overview -summary: Learn about the TiDB Clinic Diagnostic Service (TiDB Clinic), including tool components, user scenarios, and implementation principles. +title: PingCAP Clinic Overview +summary: Learn about the PingCAP Clinic Diagnostic Service (PingCAP Clinic), including tool components, user scenarios, and implementation principles. --- -## TiDB Clinic Overview +# PingCAP 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. +PingCAP Clinic Diagnostic Service (PingCAP 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 PingCAP 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. -TiDB Clinic is currently in the Beta testing stage for invited users only. This service provides the following two components to diagnose cluster problems: +PingCAP Clinic is currently in the Beta testing stage for invited users only. This service provides the following two components to diagnose cluster problems: -- Diag: a diagnostic tool deployed on the cluster side. Diag is used to collect cluster diagnostic data, upload diagnostic data to the Clinic Server, and perform a quick health check locally on your cluster. For a full list of diagnostic data that can be collected by Diag, see [TiDB Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md). +- Diag: a diagnostic tool deployed on the cluster side. Diag is used to collect cluster diagnostic data, upload diagnostic data to the Clinic Server, and perform a quick health check locally on your cluster. For a full list of diagnostic data that can be collected by Diag, see [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md). > **Note:** > > - Diag temporarily **does not support** collecting data from the clusters deployed using TiDB Ansible. - > - For the TiDB Clinic Beta version, if you want to upload data to the Clinic Server for remote troubleshooting using Diag, you need to contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. + > - For the PingCAP Clinic Beta version, if you want to upload data to the Clinic Server for remote troubleshooting using Diag, you need to contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. - Clinic Server: a cloud service deployed in the cloud. By providing diagnostic services in the SaaS model, the Clinic Server can not only receive uploaded diagnostic data but also work as an online diagnostic environment to store data, view data, and provide cluster diagnostic reports. > **Note:** > - > For the TiDB Clinic Beta version, the features of the Clinic Server are **not** open for external users. After you upload collected data to the Clinic Server and get a data link using Diag, only authorized PingCAP technical support staff can access the link and view the data. + > For the PingCAP Clinic Beta version, the features of the Clinic Server are **not** open for external users. After you upload collected data to the Clinic Server and get a data link using Diag, only authorized PingCAP technical support staff can access the link and view the data. ## User scenarios @@ -30,11 +30,11 @@ TiDB Clinic is currently in the Beta testing stage for invited users only. This - Perform a quick check on the cluster status locally - Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. You can check the potential health risks of a cluster using the local quick check feature provided by TiDB Clinic. The TiDB Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. + Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. You can check the potential health risks of a cluster using the local quick check feature provided by PingCAP Clinic. The PingCAP Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. ## Implementation principles -This section introduces the implementation principles about how Diag (a cluster-side tool provided by TiDB Clinic) collects diagnostic data from a cluster. +This section introduces the implementation principles about how Diag (a cluster-side tool provided by PingCAP Clinic) collects diagnostic data from a cluster. First, Diag gets cluster topology information from the deployment tool TiUP (tiup-cluster) or TiDB Operator (tidb-operator). Then, Diag collects different types of diagnostic data through various data collection methods as follows: @@ -57,5 +57,5 @@ First, Diag gets cluster topology information from the deployment tool TiUP (tiu ## Next step -- [Use TiDB Clinic](/clinic/clinic-user-guide-for-tiup.md) -- [TiDB Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md) +- [Use PingCAP Clinic](/clinic/clinic-user-guide-for-tiup.md) +- [PingCAP Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md) diff --git a/clinic/clinic-user-guide-for-tiup.md b/clinic/clinic-user-guide-for-tiup.md index 56f5fae60419b..e6b9afc097829 100644 --- a/clinic/clinic-user-guide-for-tiup.md +++ b/clinic/clinic-user-guide-for-tiup.md @@ -1,17 +1,17 @@ --- -title: Use TiDB Clinic -summary: Learn how to use the TiDB Clinic Diagnostic Service to troubleshoot cluster problems remotely and perform a quick check of the cluster status on a cluster deployed using TiUP. +title: Use 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. --- -# Use TiDB Clinic +# Use PingCAP Clinic -For TiDB clusters and DM clusters deployed using TiUP, you can use TiDB Clinic Diagnostic Service (TiDB Clinic) to troubleshoot cluster problems remotely and perform a quick check on a cluster status locally using a Clinic diagnostic tool Diag (Diag) and a Clinic Server cloud service (Clinic Server). +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 a cluster status locally using a Clinic diagnostic tool Diag (Diag) and a Clinic Server cloud service (Clinic Server). -TiDB Clinic is currently in the Beta testing stage. +PingCAP Clinic is currently in the Beta testing stage. > **Note:** > -> TiDB Clinic temporarily **does not support** collecting data from the clusters deployed using TiDB Ansible. +> PingCAP Clinic temporarily **does not support** collecting data from the clusters deployed using TiDB Ansible. ## User scenarios @@ -21,14 +21,14 @@ TiDB Clinic is currently in the Beta testing stage. > **Note:** > - > - TiDB Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. - > - For the TiDB Clinic Beta version, external users **cannot use** the features of the Clinic Server. After you upload collected data to the Clinic Server and get a data link using Diag, only authorized PingCAP technical support staff can access the link and view the data. + > - PingCAP Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. + > - For the PingCAP Clinic Beta version, external users **cannot use** the features of the Clinic Server. After you upload collected data to the Clinic Server and get a data link using Diag, only authorized PingCAP technical support staff can access the link and view the data. - When your cluster has some problems, if you cannot analyze the problems immediately, you can use Diag to collect and save the data for later analysis. - [Perform a quick check on the cluster status locally](#perform-a-quick-check-on-the-cluster-status-locally) - Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. You can check the potential health risks of a cluster using the local quick check feature provided by TiDB Clinic. The TiDB Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. + Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. You can check the potential health risks of a cluster using the local quick check feature provided by PingCAP Clinic. The PingCAP Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. ## Prerequisites @@ -59,7 +59,7 @@ You can use Diag to quickly collect diagnostic data from TiDB clusters and DM cl ### Step 1. Check the data to be collected -For a detailed list of data that can be collected by Diag, see [TiDB Clinic Diagnostic Data](/clinic/clinic-data-instruction-for-tiup.md). +For a detailed 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]. @@ -189,7 +189,7 @@ If the network where the cluster is located can access the internet, you can dir > **Note:** > -> TiDB Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. +> PingCAP Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. The following is an example output: @@ -241,7 +241,7 @@ If the network where your cluster is located cannot access the internet, you nee > **Note:** > - > TiDB Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. + > PingCAP Clinic is currently in the Beta testing stage for invited users only. If you need to upload data to the Clinic Server using Diag, contact [PingCAP technical support](https://en.pingcap.com/contact-us/) to get a trial account first. The following is an example output: @@ -264,7 +264,7 @@ If the network where your cluster is located cannot access the internet, you nee ## Perform a quick check on the cluster status locally -You can have a quick check on the cluster status locally using Diag. Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. The TiDB Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. +You can have a quick check on the cluster status locally using Diag. Even if your cluster runs stably now, it is necessary to periodically check the cluster to avoid potential stability risks. The PingCAP Clinic Beta version provides a rationality check on cluster configuration items to discover unreasonable configurations and provide modification suggestions. 1. Collect configuration data: @@ -341,7 +341,7 @@ You can have a quick check on the cluster status locally using Diag. Even if you 2. After uploading data, I cannot open the returned data access link. What should I do? - TiDB Clinic is currently in the Beta testing stage, and external users **cannot visit** the data access link. Only authorized PingCAP technical support staff can access the link and view the data. + PingCAP Clinic is currently in the Beta testing stage, and external users **cannot visit** the data access link. Only authorized PingCAP technical support staff can access the link and view the data. 3. How long will the uploaded data be kept on the Clinic Server?