Skip to content

tiflash: add the alert-rules.md#2191

Merged
yikeke merged 7 commits into
pingcap:masterfrom
toutdesuite:alert-rules
Apr 10, 2020
Merged

tiflash: add the alert-rules.md#2191
yikeke merged 7 commits into
pingcap:masterfrom
toutdesuite:alert-rules

Conversation

@toutdesuite
Copy link
Copy Markdown
Contributor

@toutdesuite toutdesuite commented Apr 8, 2020

What is changed, added or deleted? (Required)

add the alert-rules.md

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

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)?

@toutdesuite toutdesuite requested review from ilovesoup and yikeke April 8, 2020 01:52
@toutdesuite toutdesuite added needs-cherry-pick-3.1 priority/P2 The issue has P2 priority. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v4.0 This PR/issue applies to TiDB v4.0. labels Apr 8, 2020
Copy link
Copy Markdown
Contributor

@ilovesoup ilovesoup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Apr 9, 2020

Please resolve conflict. @toutdesuite

Comment thread reference/tiflash/alert-rules.md Outdated

# TiFlash Alert Rules

This documents introduces the alert rules of the TiFlash cluster.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread reference/tiflash/alert-rules.md Outdated

`increase(tiflash_schema_apply_count{type="failed"}[15m]) > 0`

- Rule description:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread reference/tiflash/alert-rules.md Outdated

- Rule description:

You can get an alert when the schema apply error occurs.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Comment thread reference/tiflash/alert-rules.md Outdated

- How to handle:

The error might be caused by the logical problem. Get in touch with the TiFlash R&D.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Comment thread reference/tiflash/alert-rules.md Outdated

> **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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> `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`.

Comment thread reference/tiflash/alert-rules.md Outdated

- 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment thread reference/tiflash/alert-rules.md Outdated

- How to handle:

It might be caused by communications problems between TiKV and Proxy. Get in touch with the TiFlash R&D.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@toutdesuite
Copy link
Copy Markdown
Contributor Author

@yikeke PTAL again. Thanks!

Comment thread reference/tiflash/alert-rules.md Outdated
Comment thread reference/tiflash/alert-rules.md Outdated
Copy link
Copy Markdown
Contributor

@yikeke yikeke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yikeke
Copy link
Copy Markdown
Contributor

yikeke commented Apr 10, 2020

/merge

@sre-bot sre-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 10, 2020
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 10, 2020

/run-all-tests

@yikeke yikeke merged commit ffcf83e into pingcap:master Apr 10, 2020
sre-bot added a commit to sre-bot/docs that referenced this pull request Apr 10, 2020
* 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>
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 10, 2020

cherry pick to release-3.1 in PR #2243

sre-bot added a commit to sre-bot/docs that referenced this pull request Apr 10, 2020
* 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>
@sre-bot
Copy link
Copy Markdown
Contributor

sre-bot commented Apr 10, 2020

cherry pick to release-4.0 in PR #2244

yikeke added a commit that referenced this pull request Apr 10, 2020
* 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>
sre-bot added a commit that referenced this pull request Apr 10, 2020
@toutdesuite toutdesuite deleted the alert-rules branch April 10, 2020 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority/P2 The issue has P2 priority. status/can-merge Indicates a PR has been approved by a committer. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. v4.0 This PR/issue applies to TiDB v4.0.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants