-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add doc for cluster diagnose in dashboard #3273
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
crazycs520
merged 24 commits into
pingcap:docs-special-week
from
crazycs520:diagnose-report1
May 27, 2020
Merged
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
a9d16f7
init
crazycs520 7cd05af
remove redundant file
crazycs520 2001a79
update toc
crazycs520 3d7a0c3
add usage and compare report
crazycs520 36779b6
Update access.md
breezewish f92cfa6
Update access.md
breezewish 10a4a83
Update usage.md
breezewish 426a93b
Update report.md
breezewish 1f68f60
Merge branch 'docs-special-week' into diagnose-report1
crazycs520 dcc77c2
Merge branch 'docs-special-week' into diagnose-report1
crazycs520 c0eb8b5
address comment
crazycs520 61d91d5
Merge branch 'diagnose-report1' of https://github.com/crazycs520/docs…
crazycs520 0e47db4
Merge branch 'docs-special-week' into diagnose-report1
crazycs520 17ebf95
fix dead link
crazycs520 4bab76d
Merge branch 'docs-special-week' into diagnose-report1
breezewish 503b097
Merge branch 'docs-special-week' into diagnose-report1
breezewish f01a9c9
rename file
crazycs520 4ee1993
Merge branch 'diagnose-report1' of https://github.com/crazycs520/docs…
crazycs520 d7882db
update file name and link
crazycs520 342eded
update file name and link
crazycs520 2aa9957
Merge branch 'docs-special-week' into diagnose-report1
TomShawn e561e67
Update dashboard-diagnostics-report.md
breezewish 7bb1dc4
Merge branch 'docs-special-week' into diagnose-report1
breezewish 16d11a1
Merge branch 'docs-special-week' into diagnose-report1
crazycs520 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
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,61 @@ | ||
| --- | ||
| title: 集群诊断页面 | ||
| category: how-to | ||
| --- | ||
|
|
||
| # 集群诊断页面 | ||
|
|
||
| 集群诊断是在指定的时间范围内,对集群可能存在的问题进行诊断,并将诊断结果和一些集群相关的负载监控信息汇总成一个诊断报告。诊断报告是网页形式,通过浏览器保存后可离线浏览和传阅。 | ||
|
|
||
| > **注意:** | ||
| > | ||
| > 集群诊断功能依赖于集群中部署有 Prometheus 监控组件,参见 [TiUP](/tiup/tiup-overview.md) 或 [TiDB Ansible](/online-deployment-using-ansible.md) 部署文档了解如何部署监控组件。若集群中没有部署监控组件,生成的诊断报告中将提示生成失败。 | ||
|
|
||
| ## 访问 | ||
|
|
||
| 可以通过以下两种方法访问集群诊断页面: | ||
|
|
||
| * 登录后,左侧导航条点击**集群诊断**(Cluster Diagnose): | ||
|
|
||
|  | ||
|
|
||
| * 在浏览器中访问 [http://127.0.0.1:2379/dashboard/#/diagnose](http://127.0.0.1:2379/dashboard/#/diagnose)(将 127.0.0.1:2379 替换为任意实际 PD 地址和端口)。 | ||
|
|
||
| ## 生成诊断报告 | ||
|
|
||
| 如果想对一个时间范围内的集群进行诊断,查看集群的负载等情况,可以使用以下步骤来生成一段时间范围的诊断报告: | ||
|
|
||
| 1. 设置区间的开始时间,例如 2020-05-21 14:40:00。 | ||
| 2. 设置区间长度。例如 10 min 。 | ||
| 3. 点击开始。 | ||
|
|
||
|  | ||
|
|
||
| > **建议:** | ||
| > | ||
| > 建议生成报告的时间范围在 1 min ~ 60 min 内,目前不建议生成超过 1 小时范围的报告。 | ||
|
|
||
| 以上操作会生成 2020-05-21 14:40:00 至 2020-05-21 14:50:00 时间范围的诊断报告。点击**开始**后,会看到以下界面,**生成进度**是生成报告的进度条,生成报告完成后,点击**查看报告**即可。 | ||
|
|
||
|  | ||
|
|
||
| ## 生成对比诊断报告 | ||
|
|
||
| 如果系统在某个时间点发生异常,如 QPS 抖动或者延迟变高,可以生成一份异常时间范围和正常时间范围的对比报告,例如: | ||
|
|
||
| * 系统异常时间段:2020-05-21 14:40:00 ~ 2020-05-21 14:45:00,系统异常时间 | ||
| * 系统正常时间段:2020-05-21 14:30:00 ~ 2020-05-21 14:35:00,系统正常时间 | ||
|
|
||
| 生成以上两个时间范围的对比报告的步骤如下: | ||
|
|
||
| 1. 设置区间的开始时间,即异常时间段的开始时间,如 2020-05-21 14:40:00 | ||
| 2. 设置区间长度。一般只系统异常的持续时间,例如 5 min | ||
|
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. 指 |
||
| 3. 开启与基线区间对比开关 | ||
| 4. 设置基线开始时间,即想要对比的系统正常时段的开始时间,如 2020-05-21 14:30:00 | ||
| 5. 点击开始 | ||
|
|
||
|  | ||
|
|
||
| 然后同样等报告生成完成后点击**查看报告**即可。 | ||
|
|
||
| 另外,已生成的诊断报告会显式在诊断报告主页的列表里面,可以点击查看之前生成的报告,不用重复生成。 | ||
|
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. 显示 |
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
英文 UI 改为 Cluster Diagnostics