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

Update two TiDB Clinic docs #7754

Merged
merged 2 commits into from
Mar 4, 2022
Merged

Update two TiDB Clinic docs #7754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bd5599
Update TiDB Clinic docs
en-jin19 Mar 3, 2022
2a78257
Update TOC.md
en-jin19 Mar 3, 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
8 changes: 4 additions & 4 deletions TOC.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 4 additions & 4 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 @@ -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 |
| :------ | :------ |:-------- |
Expand Down Expand Up @@ -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 |
| :------ | :------ |:-------- |
Expand All @@ -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 |
| :------ | :------ |:-------- |
Expand Down Expand Up @@ -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 |
| :------ | :------ |:-------- |
Expand Down
4 changes: 2 additions & 2 deletions clinic/clinic-introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down