-
Notifications
You must be signed in to change notification settings - Fork 710
Add daily-check.md #2701
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.
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
Merged
Merged
Add daily-check.md #2701
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
b80cf93
add daily-check.md
toutdesuite 9ce7664
update wording
toutdesuite 0dea684
fix dead link
toutdesuite 5419a15
wording
toutdesuite 985f3a9
Update daily-check.md
toutdesuite 637e00b
Update daily-check.md
toutdesuite 3816087
Apply suggestions from code review
ran-huang de1ef03
Merge branch 'master' into daily-inspection
WalterWj ed982b7
Update daily-check.md
toutdesuite c69a213
Merge branch 'master' into daily-inspection
ran-huang File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| --- | ||
| title: Daily Check | ||
| summary: Learn about performance indicators of the TiDB cluster. | ||
| category: reference | ||
| --- | ||
|
|
||
| # Daily Check | ||
|
|
||
| As a distributed database, TiDB is more complicated than the stand-alone database in terms of the mechanism, and monitoring items. To help operate and maintain TiDB in a more convenient way, this document introduces some key performance indicators. | ||
|
|
||
| ## Key indicators of Dashboard | ||
|
|
||
| Starting from v4.0, TiDB provides a new operation and maintenance management tool, TiDB Dashboard. This tool is integrated into the PD component. You can access TiDB Dashboard at the default address `http://${pd-ip}:${pd_port}/dashboard`. | ||
|
|
||
| TiDB Dashboard simplifies the operation and maintenance of the TiDB database. You can view the running status of the entire TiDB cluster through one interface. The following are descriptions of some performance indicators. | ||
|
|
||
| ### Instance panel | ||
|
|
||
|  | ||
|
|
||
| + **Status**: This indicator is used to check whether the status is normal. For an online node, this can be ignored. | ||
| + **Up Time**: The key indicator. If you find that the `Up Time` is changed, you need to locate the reason why the component is restarted. | ||
| + **Version**, **Deployment Directory**, **Git Hash**: These indicators need to be checked to avoid inconsistent or even incorrect version/deployment directory. | ||
|
|
||
| ### Host panel | ||
|
|
||
|  | ||
|
|
||
| You can view the usage of CPU, memory, and disk. When the average usage of any resource exceeds 60%, it is recommended to plan to scale out the capacity. When the average usage reaches 80%, it is recommended to scale out the capacity. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 通过主机面板可以查看 CPU、内存、磁盘使用率。当任何资源的平均使用率超过 60%,推荐安排扩容计划,达到 80%,推荐进行扩容。 这个原文写错了,改成:
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ### SQL analysis panel | ||
|
|
||
|  | ||
|
|
||
| You can locate the slow SQL statement executed in the cluster. Then you can optimize the specific SQL statement. | ||
|
|
||
|
ran-huang marked this conversation as resolved.
|
||
| ### Region panel | ||
|
|
||
|  | ||
|
|
||
| + `miss-peer-region-count`: The number of Regions without enough replicas. This value is not always greater than `0`. | ||
| + `extra-peer-region-count`: The number of Regions with extra replicas. These Regions are generated during the scheduling process. | ||
| + `empty-region-count`: The number of empty Regions, generated by executing the `TRUNCATE TABLE`/`DROP TABLE` statement. If this number is large, you can consider enabling `Region Merge` to merge Regions across tables. | ||
| + `pending-peer-region-count`: The number of Regions with outdated Raft logs. It is normal that a few pending peers are generated in the scheduling process. However, it is not normal if this value is large for a period of time. | ||
| + `down-peer-region-count`: The number of Regions with an unresponsive peer reported by the Raft leader. | ||
| + `offline-peer-region-count`: The number of Regions during the offline process. | ||
|
|
||
| Generally, it is normal that these values are not `0`. However, it is not normal that they are not `0` for quite a long time. | ||
|
|
||
|
ran-huang marked this conversation as resolved.
|
||
| ### KV Request Duration | ||
|
|
||
|  | ||
|
|
||
| The KV request duration 99 in TiKV. If you find nodes with a long duration, check whether there are hot spots, or whether there are nodes with poor performance. | ||
|
|
||
| ### PD TSO Wait Duration | ||
|
|
||
|  | ||
|
|
||
| The time it takes for TiDB to obtain TSO from PD. The following are reasons for the long wait duration: | ||
|
|
||
| + High network latency from TiDB to PD. You can manually execute the ping command to test the network latency. | ||
| + High load for the TiDB server. | ||
| + High load for the PD server. | ||
|
|
||
|
ran-huang marked this conversation as resolved.
|
||
| ### Overview panel | ||
|
|
||
|  | ||
|
|
||
| You can view the load, memory available, network traffic, and I/O utilities. When a bottleneck is found, it is recommended to scale out the capacity, or to optimize the cluster topology, SQL, cluster parameters, etc. | ||
|
|
||
| ### Exceptions | ||
|
ran-huang marked this conversation as resolved.
|
||
|
|
||
|  | ||
|
|
||
| You can view the errors triggered by the execution of SQL statements on each TiDB instance. These include syntax error, primary key conflicts, etc. | ||
|
|
||
| ### GC status | ||
|
ran-huang marked this conversation as resolved.
|
||
|
|
||
|  | ||
|
|
||
| You can check whether the GC (Garbage Collection) status is normal by viewing the time when the last GC happens. If the GC is abnormal, it might lead to excessive historical data, thereby decreasing the access efficiency. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.