tiflash: add the alert-rules.md#2191
Conversation
|
Please resolve conflict. @toutdesuite |
|
|
||
| # TiFlash Alert Rules | ||
|
|
||
| This documents introduces the alert rules of the TiFlash cluster. |
There was a problem hiding this comment.
| This documents introduces the alert rules of the TiFlash cluster. | |
| This document introduces the alert rules of the TiFlash cluster. |
Please do not make this mistake again.
|
|
||
| `increase(tiflash_schema_apply_count{type="failed"}[15m]) > 0` | ||
|
|
||
| - Rule description: |
There was a problem hiding this comment.
Keep the format consistent with other alert rule docs, e.g. https://pingcap.com/docs/dev/reference/alert-rules/
Please apply the correct format to the whole document! @toutdesuite
|
|
||
| - Rule description: | ||
|
|
||
| You can get an alert when the schema apply error occurs. |
There was a problem hiding this comment.
| You can get an alert when the schema apply error occurs. | |
| When the schema apply error occurs, an alert is triggered. |
Keep the same description format as the other doc: https://pingcap.com/docs/dev/reference/alert-rules/
Please update the other places in this document. @toutdesuite
|
|
||
| - How to handle: | ||
|
|
||
| The error might be caused by the logical problem. Get in touch with the TiFlash R&D. |
There was a problem hiding this comment.
| The error might be caused by the logical problem. Get in touch with the TiFlash R&D. | |
| The error might be caused by some wrong logic. Contact [TiFlash R&D](mailto:support@pingcap.com) for support. |
Please update the other similar places to Contact [TiFlash R&D](mailto:support@pingcap.com) for support.. @toutdesuite
|
|
||
| > **Note:** | ||
| > | ||
| > `read index` is the kvproto request sent to the TiKV leader. TiKV region retries, busy Store, or network problems might lead to long request time of read index. |
There was a problem hiding this comment.
| > `read index` is the kvproto request sent to the TiKV leader. TiKV region retries, busy Store, or network problems might lead to long request time of read index. | |
| > `read index` is the kvproto request sent to the TiKV leader. TiKV region retries, busy store, or network problems might lead to long request time of `read index`. |
|
|
||
| - How to handle: | ||
|
|
||
| The frequent retries might be caused by frequent TiKV cluster split events or frequent TiKV cluster migrations. You can check the TiKV cluster status to identify the retry reason. |
There was a problem hiding this comment.
| The frequent retries might be caused by frequent TiKV cluster split events or frequent TiKV cluster migrations. You can check the TiKV cluster status to identify the retry reason. | |
| The frequent retries might be caused by frequent splitting or migration of the TiKV cluster. You can check the TiKV cluster status to identify the retry reason. |
|
|
||
| - How to handle: | ||
|
|
||
| It might be caused by communications problems between TiKV and Proxy. Get in touch with the TiFlash R&D. |
There was a problem hiding this comment.
| It might be caused by communications problems between TiKV and Proxy. Get in touch with the TiFlash R&D. | |
| It might be caused by a communications error between TiKV and the proxy. Get in touch with the TiFlash R&D. |
|
@yikeke PTAL again. Thanks! |
|
/merge |
|
/run-all-tests |
* add the alert-rules.md * address comments * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
|
cherry pick to release-3.1 in PR #2243 |
* add the alert-rules.md * address comments * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com>
|
cherry pick to release-4.0 in PR #2244 |
* add the alert-rules.md * address comments * Apply suggestions from code review Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com> Co-authored-by: pingcap-github-bot <sre-bot@pingcap.com> Co-authored-by: toutdesuite <guizhiluo2014@163.com> Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
What is changed, added or deleted? (Required)
add the alert-rules.md
Which TiDB version(s) do your changes apply to? (Required)
If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-4.0, needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.
What is the related PR or file link(s)?