chore: update master to refactor-migration-docs (#6595)

* Dumping default consistency description (#5985)

* update max-replicas description (#5984)

* Remove the swappiness parameter (#5987)

* system-variables: update for consistency (#5826)

* Change tidb_memory_usage_alarm_ratio scope to instance (#5988)

* Punctuation fix: Replace 。with . (#6002)

* index page: updated the phase of TiDB Cloud from Beta to Public Preview (#6014)

* Migration FAQs: added the FAQ links of the migration related tools (#6010)

* TiUP cluster: update data_dir (#6009)

* Add kafka downstream example (#6005)

* TiKV configuration: Update description for pin-l0-filter-and-index-blocks (#6008)

* Update the default value of tidb_stmt_summary_max_stmt_count (#6021) (#6023)

* update docs related to partition table dynamic mode (#5997)

* partitioning: Corrected partition management (#5498)

* TiDB binlog: update descriptions about commit ts and passoword (#5986)

* releases: add tidb 4.0.14 release notes (#5996)

* fix a typo for sync_diff_inspector (#6041)

* Update dashboard FAQ (#5895)

* update stale read doc for ga (#6047)

* configure-time-zone: mention `system_time_zone` (#6032)

* Update Security Compatibility with MySQL (#5921)

* correct document of using br backup and restore system tables (#6057)

* Add description about telemetry of builtin functions usage (#6028)

* Add TiDB Dashboard session docs (#6058)

* update br faq (#6060)

* releases: add TiDB 5.1.1 release notes (#6030)

* grafana-overview-dashboard: update the monitoring item for CPS (#6066)

* deploy-tidb-binlog: make the expression on deployment clearer (#6073)

* Add documentation on how to modify gcttl by tiup (#6071)

* remove useless variable (#6076)

* ticdc: add mysql sink user privilege (#6072)

* deleted roadmap.md (#6079)

* TiDB Monitoring Metrics: remove a line (#6081)

* TiDB configuration: add a security option `require-secure-transport` (#6080)

* chore: lock plugin versions (#6089)

* cdc: add compatibility notes for sort-dir (#6086)

* Add gc ttl (#6102) (#6103)

* 5.1.0 release notes: Fix link to telemetry docs (#6106)

* sql-statement-select: Add '...FOR UPDATE NOWAIT' (#6085)

* TiCDC: update a golang demo link (#6055)

* br/use-br-command-line-tool: supplement br note (#6000)

* pr_template: Provides tips for cherry-pick (#6042)

* pr_template: Provides tips for cherry-pick

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* TiDB monitoring: add table storage info status api (#6110)

* update doc for Oracle translate function (#6053)

* ticdc: add explicit_defaults_for_timestamp compatibility troubleshoot (#6115)

* Add print the bad sst files and related information for tikv-ctl (#6109)

* add a missing note (#6129)

* Add docs for auto-tls setting (#6125)

* TiFlash: remove outdated tune advise (#6133)

* TiDB lightning: remove default backend setting (#6132)

* tidb-scheduling: fix typo (#6140)

* Suggest Log Redaction when using TDE (#6147)

* Add infoschema.referential_constraints (#6139)

* Add steps to get lightning goroutine (#6001)

* tiup: fix dead links (#6153)

* Deleted description about not supporting some features. (#6157)

* high-concurrency-best-practices: fix the support info of follower read (#6161)

* Update function list pushed down to tiflash (#6165)

* The `log_dir` should be the log directory (#6168)

* Make IP address of Monitoring & Grafana for Minimal Topology consistent (#6178)

* tikv: add storage flow control doc (#6173)

* TiDB configuration: update the default value of `stmt_max_count` (#6172)

* ticdc-open-api: add ticdc open api doc (#6186)

* System variables: update `broadcast_join_threshold_count` and `broadc… (#6181)

* Update tikv-configuration-file.md (#6180)

* TiFlash configuration: update `io_rate_limit` (#6176)

* Add information of hashAgg for memory control (#6171)

* Update description on rule based index selection (#6160)

* add dr auto sync (#6182)

* update doc for SPM (#6146)

* docs: update rereject leader docs (#6183)

* SQL statement, system variables: update expression indexes (#6185)

* Updated sql-plan-management.md (#6184)

* Introduced 2 new variables (#6159)

* Fix broken link in error codes doc and support doc (#6196)

* docs: fix format for TiKV and PD configuration file template invalid. (#6197)

* docs: separate query statement and result in two text boxes. (#6204) (#6205)

* adopters: add zhihu case study (#6207)

* Added descriptions about slow node detection (#6174)

* pd-control: add new config of balance-hot-region-scheduler (#6148)

* add notice about scaling in pd node (#6099)

* add example for expression index (#6215)

* adopters: remove 404 links (#6214)

* ticdc: fix wording (#6231)

* Revert "System variables: update `broadcast_join_threshold_count` and `broadc…" (#6232)

* Update documents of lock view for sprint 4 (#6179)

* ticdc-open-api: correct some error (#6239)

* best practices: add timeout options for Java best practices (#6136)

* update PR template for v5.2 (#6166)

* chore: stop building temporary (#6252)

* fix typo for sql-plan-management.md (#6248)

* alert rules: update some descriptions (#6250)

* Quick start: update version and TiUP playground supports M1 silicon (#6149)

* fix typo: relaod -> reload (#6235)

* tiny fix on index selection (#6265)

* add commands to check tikv user (#5999)

* br: add restore to systables (#6004)

* br: add restore to systables

* Apply suggestions from code review

Co-authored-by: TomShawn <[email protected]>

Co-authored-by: TomShawn <[email protected]>

* statement summary: update statement summary doc (#6084)

* Require process privilege for dumpling (#6187)

* tiflash: Remove the description about expr_blacklist in use_tiflash.md (#6188)

* Add description about table name/alias specifying for read_from_storage hint (#6164)

* complex tidb binlog.yaml: add checkpoint info (#6216)

* TiKV configuration: remove redundant instructions (#6218)

* alert rules: remove some descriptions (#6223)

* Revert "add dr auto sync" (#6294)

* TiFlash Config: Add annotation (v5.2.0) (#6296)

* sql: improve kill's description (#6233)

* Add v5.2 TPCH report (#6170)

* docs: fix expression index's document again (#6295)

* system variables.md: add a warning message (#6298)

* sql-statement: Add ADMIN SHOW TELEMETRY (#6138)

* tiup: add notice about importing cluster (#6108)

* Bump version for v5.2.0 (#6191)

* add TiDB 5.2.0 release note (#6237)

* add two HTAP documents (#6206)

* benchmark: add v5.2 benchmark results (#6319)

* Fix title typo (#6324)

* release note: update feature description (#6325)

* adopters: add xiaomi (#6303)

* chore: migrate scripts to docs (#6338)

* credits: update links to the full list of code and docs contributors (#6111)

* TiUP: add instructions for offline mirror (#6137)

* tune tikv memory performance: remove description for sync-log (#6234)

* dashboard statement list: add a note to explain the blue bar and yellow line (#6189)

* release 5.1.0: add compatibility change for `tidb_enable_noop_functions` (#6222)

* modify configuration online: remove unsupported parameters (#6300)

* modify configuration online: change a name for consistency (#6301)

* Migrate from Aurora: update Aurora MySQL dumpling command (#6335)

* PD configuration file: add log level (#6302)

* TiDB Binlog config: update "syncer.to.checkpoint" info (#6340)

* update doc on wal-recovery-mode and use-direct-io-for-flush-and-compaction (#6163)

* Fix TOC display error (#6369)

* sql: fix the correctness problem about kill (#6377)

* change expressions related to statement summary tables (#6299)

* Update grafana-pd-dashboard.md (#6388)

* system variables: update description about `tidb_opt_prefer_range_scan` (#6389)

* Update alert rule for low space (#6376)

* chore: add dispatch back (#6404)

* Add description for TiKV Ready handled panel (#6375)

* TiKV config: fix wrong description about `compaction-readahead-size` (#6371)

* update transaction doc (#6158)

* BR FAQ: add a warning about multi br importing (#6263)

* Configuration Options: remove two TiDB's command options (#6370)

* system-variables: improve noop functions warning (#6374)

* add doc links to overview.md (#6422)

* chore: fix byte encode (#6428)

* performance_schema -> information_schema (#6418)

* chore: update ci scripts (#6429)

* Enhance TiDB login descriptions - EN (#6427)

* release-notes: add 5.2.1 release notes (#6438)

* basic features: add feature matrix (#6130)

* release note: add a check item for feedback-probability (#6405)

* Update system variables for correctness (#6224)

* encryption-at-rest: Update (#6152)

* basic-features: collapse charset and collations (#6452)

* system-variables: update from generated source (#6451)

* fix-enable-compaction-filter-in-tikv-configuration-file (#6403)

* Update the related variable description for CREATE INDEX (#6434)

* TiKV config: add 7 log-related congifurations (#6372)

* Configure placement rules: fix placement doc (#6450)

* adopters: add Pinterest (#6443)

* release-5.2.0: Add info about caching_sha2 (#6344)

* faq: add info for schema is changed error (#6453)

* Update enable-tls-between-clients-and-servers.md (#6493)

* adopters: remove Pinterest (#6501)

* Fix wrong wording in mysql-compatibility.md (#6511)

* adopters: add Huya Live (#6516)

* tidb-configuration-file: correct the default value of committer-concurrency (#6526)

* Tune TiKV: change the default value of `grpc-concurrency` (#6531)

* releases: add tidb 4.0.15 release notes (#6475)

* releases: add tidb 5.0.4 release notes (#6449)

* releases: add tidb 5.1.2 release notes (#6500)

* releases: add TiDB 5.1.2-10-06-33 release notes

* releases: add TiDB 5.1.2-10-06-33 release notes
* Update releases/release-5.1.2-10-06-33.md

* toc

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* add notes from comments

* add more tidb notes

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <[email protected]>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Enwei <[email protected]>
Co-authored-by: xixirangrang <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: Yuanjia Zhang <[email protected]>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>

* replace pr numbers with issue numbers

* Update releases/release-5.1.2.md

Co-authored-by: Liuxiaozhen12 <[email protected]>

* Apply suggestions from code review

Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Enwei <[email protected]>

* fix

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: Grace Cai <[email protected]>

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* Apply suggestions from code review

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

Co-authored-by: Enwei <[email protected]>

* Update releases/release-5.1.2.md

Co-authored-by: shichun-0415 <[email protected]>

* Update releases/release-5.1.2.md

* Update releases/release-5.1.2.md

* Apply suggestions from code review

* move notes

Co-authored-by: TomShawn <[email protected]>
Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Yuanjia Zhang <[email protected]>
Co-authored-by: Enwei <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>

* remove a note about `raftstore.sync-log` (#6563)

* Add desc of "Storage Write Stall" row in the TiFlash grafana (#6524)

* system variables: update tidb_enable_noop_functions behavior (#6525)

* system variables: document last_insert_id (#6502)

* docs: update pd-configuration about upgrade (#6510)

* fix example for expression index (#6499)

* tidb: fix default value of performance.committer-concurrency (#6498)

* chore: remove circleci config (#6577)

* Document missing sysvars (#6485)

* system-variables: add skip-name-resolve (#6491)

* Document a few more system variables (#6492)

* add dr auto sync (#6592)

* tiflash, metric: add alert for TiFlash down (#6590)

Co-authored-by: Enwei <[email protected]>
Co-authored-by: disksing <[email protected]>
Co-authored-by: Liuxiaozhen12 <[email protected]>
Co-authored-by: Morgan Tocker <[email protected]>
Co-authored-by: Daniël van Eeden <[email protected]>
Co-authored-by: Grace Cai <[email protected]>
Co-authored-by: Ti Chi Robot <[email protected]>
Co-authored-by: Mattias Jonsson <[email protected]>
Co-authored-by: ti-srebot <[email protected]>
Co-authored-by: glorv <[email protected]>
Co-authored-by: Suhaha <[email protected]>
Co-authored-by: Ian <[email protected]>
Co-authored-by: Yu Lei <[email protected]>
Co-authored-by: Wenxuan <[email protected]>
Co-authored-by: zhouqiang <[email protected]>
Co-authored-by: xixirangrang <[email protected]>
Co-authored-by: Yini Xu <[email protected]>
Co-authored-by: WangZhengru <[email protected]>
Co-authored-by: Xintao <[email protected]>
Co-authored-by: Daniël van Eeden <[email protected]>
Co-authored-by: Allen Zhong <[email protected]>
Co-authored-by: ruoxi <[email protected]>
Co-authored-by: Yasuo Honda <[email protected]>
Co-authored-by: Yasuo Honda <[email protected]>
Co-authored-by: Defined2014 <[email protected]>
Co-authored-by: Ran <[email protected]>
Co-authored-by: Chengpeng Yan <[email protected]>
Co-authored-by: Yifan Xu <[email protected]>
Co-authored-by: Weizhen Wang <[email protected]>
Co-authored-by: Ziqian Qin <[email protected]>
Co-authored-by: shichun-0415 <[email protected]>
Co-authored-by: you06 <[email protected]>
Co-authored-by: Fendy <[email protected]>
Co-authored-by: Kolbe Kegel <[email protected]>
Co-authored-by: jirongq <[email protected]>
Co-authored-by: Caitin <[email protected]>
Co-authored-by: Yuanjia Zhang <[email protected]>
Co-authored-by: JaySon <[email protected]>
Co-authored-by: unconsolable <[email protected]>

alert-rules.md

@@ -8,7 +8,7 @@ aliases: ['/docs/dev/alert-rules/','/docs/dev/reference/alert-rules/']
 
 # TiDB Cluster Alert Rules
 
-This document describes the alert rules for different components in a TiDB cluster, including the rule descriptions and solutions of the alert items in TiDB, TiKV, PD, TiDB Binlog, Node_exporter and Blackbox_exporter.
+This document describes the alert rules for different components in a TiDB cluster, including the rule descriptions and solutions of the alert items in TiDB, TiKV, PD, TiFlash, TiDB Binlog, Node_exporter and Blackbox_exporter.
 
 According to the severity level, alert rules are divided into three categories (from high to low): emergency-level, critical-level, and warning-level. This division of severity levels applies to all alert items of each component below.
 
@@ -781,6 +781,10 @@ This section gives the alert rules for the TiKV component.
 
     The speed of splitting Regions is slower than the write speed. To alleviate this issue, you’d better update TiDB to a version that supports batch-split (>= 2.1.0-rc1). If it is not possible to update temporarily, you can use `pd-ctl operator add split-region <region_id> --policy=approximate` to manually split Regions.
 
+## TiFlash alert rules
+
+For the detailed descriptions of TiFlash alert rules, see [TiFlash Alert Rules](/tiflash/tiflash-alert-rules.md).
+
 ## TiDB Binlog alert rules
 
 For the detailed descriptions of TiDB Binlog alert rules, see [TiDB Binlog monitoring document](/tidb-binlog/monitor-tidb-binlog-cluster.md#alert-rules).
@@ -954,6 +958,22 @@ This section gives the alert rules for the Blackbox_exporter TCP, ICMP, and HTTP
     * Check whether the TiDB process exists.
     * Check whether the network between the monitoring machine and the TiDB machine is normal.
 
+#### `TiFlash_server_is_down`
+
+* Alert rule:
+
+    `probe_success{group="tiflash"} == 0`
+
+* Description:
+
+    Failure to probe the TiFlash service port.
+
+* Solution:
+
+    * Check whether the machine that provides the TiFlash service is down.
+    * Check whether the TiFlash process exists.
+    * Check whether the network between the monitoring machine and the TiFlash machine is normal.
+
 #### `Pump_server_is_down`
 
 * Alert rule:

tiflash/tiflash-alert-rules.md

@@ -34,7 +34,7 @@ This document introduces the alert rules of the TiFlash cluster.
 
 - Solution:
 
-    It might be caused by the internal problems of the TiFlash TMT engine. Contact [TiFlash R&D](mailto:[email protected]) for support.
+    It might be caused by the internal problems of the TiFlash storage engine. Contact [TiFlash R&D](mailto:[email protected]) for support.
 
 ## `TiFlash_raft_read_index_duration`