Update monitor-built-in-alerting.md - #23929
huoyao1125 wants to merge 3 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
missing-translation-status
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: pingcap/docs/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review. 📝 WalkthroughWalkthroughThe alerting documentation separates Premium and Essential alert sections. It adds three Premium SQL-duration alerts with troubleshooting and support guidance. ChangesAlerting documentation
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~3 minutes Change: Other Merge Risk: 🔵 Low · up to The page adds performance alerts that are not listed in the monitoring overview, which may make them harder for users to discover and understand. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: fbef8e0e-05f4-4db9-af61-7adb66b43c3b
📒 Files selected for processing (1)
tidb-cloud/monitor-built-in-alerting.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
| | More than 20 SQL statements exceeded 256 ms within 1 minute | This is an early-warning signal based on latency metrics. Because TiDB's slow log only records queries that exceed 300 ms by default, not every counted query is guaranteed to have a matching entry in the slow query list. <ol><li>Check for recent schema or index changes.</li><li>Review the slow query list in the TiDB Cloud console. It might take several minutes for the corresponding slow query records to appear.</li></ol><br/>If you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).| | ||
| | More than 20 SQL statements exceeded 512 ms within 1 minute | <ol><li>Check for recent schema or index changes.</li><li>Review the slow query list in the TiDB Cloud console. It might take several minutes for the corresponding slow query records to appear.</li></ol><br/>If you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).| | ||
| | More than 20 SQL statements exceeded 4096 ms within 1 minute | <ol><li>Check for recent schema or index changes.</li><li>Review the slow query list in the TiDB Cloud console. It might take several minutes for the corresponding slow query records to appear.</li></ol><br/>If you cannot identify the root cause, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md).| |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
sed -n '20,45p' tidb-cloud/monitoring-concepts.md
printf '\n--- detailed alerting page ---\n'
sed -n '110,150p' tidb-cloud/monitor-built-in-alerting.md
printf '\n--- related category references ---\n'
rg -n -i 'performance overview alerts|resource usage|data migration|changefeed alerts|built-in alert' tidb-cloud/monitoring-concepts.md tidb-cloud/monitor-built-in-alerting.mdRepository: pingcap/docs
Length of output: 16101
Keep the built-in alert overview consistent.
monitoring-concepts.md says TiDB Cloud provides only three alert types, but this page documents a separate Performance overview alerts category. Update the overview to include this category, with its plan scope, or reclassify this section if it is not a separate built-in alert type.
🧰 Tools
🪛 GitHub Check: vale
[failure] 138-138:
[vale] reported by reviewdog 🐶
[PingCAP.LyHyphens] ' early-' doesn't need a hyphen.
Raw Output:
{"message":"[PingCAP.LyHyphens] ' early-' doesn't need a hyphen.","location":{"path":"tidb-cloud/monitor-built-in-alerting.md","range":{"start":{"line":138,"column":75},"end":{"line":138,"column":82}}},"severity":"ERROR","code":{"value":"PingCAP.LyHyphens","url":"https://developers.google.com/style/hyphens"}}
ti-chi-bot
Bot
added
size/M
|
@huoyao1125: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
1 participant
What is changed, added, or deleted? (Required)
Adds 3 new rows to the "Performance overview alerts" table (applies to Essential and Premium plans): the new
Query Latency Count Thresholdalert conditions that fire when more than N SQL statements exceed 256 ms / 512 ms / 4096 ms within 1 minute. Also fixes a trailing-whitespace formatting issue on the "Performance overview alerts" heading.Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit