Skip to content

Commit 03b8d0a

Browse files
breezewishTomShawn
andauthored
Remove the experimental flag for TiDB Dashboard (pingcap#4108)
* Remove the experimental flag for TiDB Dashboard Signed-off-by: Breezewish <[email protected]> * Apply suggestions from code review Co-authored-by: TomShawn <[email protected]> * Apply suggestions from code review Co-authored-by: TomShawn <[email protected]>
1 parent a7686b8 commit 03b8d0a

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

dashboard/dashboard-diagnostics-access.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ aliases: ['/docs/dev/dashboard/dashboard-diagnostics-access/']
66

77
# TiDB Dashboard Cluster Diagnostics Page
88

9+
> **Note:**
10+
>
11+
> Diagnostics in TiDB Dashboard is still an experimental feature. It is **NOT** recommended that you use it in the production environment.
12+
913
The cluster diagnostics feature in TiDB Dashboard diagnoses the problems that might exist in a cluster within a specified time range, and summarizes the diagnostic results and the cluster-related load monitoring information into a diagnostic report. This diagnostic report is in the form of a web page. You can browse the page offline and circulate this page link after saving the page from a browser.
1014

1115
> **Note:**
@@ -16,11 +20,11 @@ The cluster diagnostics feature in TiDB Dashboard diagnoses the problems that mi
1620

1721
You can use one of the following methods to access the cluster diagnostics page:
1822

19-
* After logging into TiDB Dashboard, click **Cluster Diagnostics** on the left navigation menu:
23+
- After logging into TiDB Dashboard, click **Cluster Diagnostics** on the left navigation menu:
2024

21-
![Access Cluster Diagnostics page](/media/dashboard/dashboard-diagnostics-access.png)
25+
![Access Cluster Diagnostics page](/media/dashboard/dashboard-diagnostics-access.png)
2226

23-
* Visit `http://127.0.0.1:2379/dashboard/#/diagnose` in your browser. Replace `127.0.0.1:2379` with the actual PD address and port number.
27+
- Visit `http://127.0.0.1:2379/dashboard/#/diagnose` in your browser. Replace `127.0.0.1:2379` with the actual PD address and port number.
2428

2529
## Generate diagnostic report
2630

@@ -44,8 +48,8 @@ The steps above generate a diagnostic report for the time range from `2020-05-21
4448

4549
If a system exception occurs at a certain point, for example, QPS jitter or higher latency, a diagnostic report can be generated. Particularly, this report compares the system in the abnormal time range with the system in the normal time range. For example:
4650

47-
* Abnormal time range: `2020-05-21 14:40:00`-`2020-05-21 14:45:00`. Within this time range, the system is abnormal.
48-
* Normal time range: `2020-05-21 14:30:00` - `2020-05-21 14:35:00`. Within this time range, the system is normal.
51+
- Abnormal time range: `2020-05-21 14:40:00`-`2020-05-21 14:45:00`. Within this time range, the system is abnormal.
52+
- Normal time range: `2020-05-21 14:30:00` - `2020-05-21 14:35:00`. Within this time range, the system is normal.
4953

5054
You can take the following steps to generate a comparison report for the two time ranges above:
5155

dashboard/dashboard-intro.md

-4
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ aliases: ['/docs/dev/dashboard/dashboard-intro/']
66

77
# TiDB Dashboard Introduction
88

9-
> **Note:**
10-
>
11-
> TiDB Dashboard is still an experimental feature. It is **NOT** recommended that you use it in the production environment.
12-
139
TiDB Dashboard is a Web UI for monitoring, diagnosing, and managing the TiDB cluster, which is available since v4.0. It is built into the PD component and does not require an independent deployment.
1410

1511
![TiDB Dashboard interface](/media/dashboard/dashboard-intro.gif)

0 commit comments

Comments
 (0)