Skip to content

docs: document Region and maintenance events - #2734

Merged
WenyXu merged 9 commits into
GreptimeTeam:mainfrom
WenyXu:docs/metasrv-operational-events-2723
Aug 13, 2026
Merged

docs: document Region and maintenance events#2734
WenyXu merged 9 commits into
GreptimeTeam:mainfrom
WenyXu:docs/metasrv-operational-events-2723

Conversation

@WenyXu

@WenyXu WenyXu commented Aug 10, 2026

Copy link
Copy Markdown
Member

What changed

  • add Region events and Maintenance events guides for Metasrv event records in distributed deployments
  • document repartition, repartition_group, Region migration, GC, and Remote WAL pruning with read-only SQL queries and sample results
  • explain Region ID components, source-to-target Region mappings, GC report file lists, and Remote WAL pruning boundaries
  • add English and Chinese navigation links for the new guides
  • keep unrelated existing Events pages unchanged; also align the Chinese recent-events wording in Nightly and 1.2

Part of #2723

Scope

  • Documentation versions: Nightly and 1.2
  • Languages: English and Chinese

Verification

  • git diff --check
  • Read-only MySQL queries against local GreptimeDB on port 4002 for the documented repartition, Region migration, GC, and Remote WAL queries
  • Manual review against the event recorder source and Grafana Events dashboard

Checklist

  • I verified the content against the applicable GreptimeDB version.
  • I updated the relevant documentation versions and languages, or explained why not.
  • I checked changed links and anchors.
  • I updated navigation when the document structure changed.

@WenyXu
WenyXu force-pushed the docs/metasrv-operational-events-2723 branch from d7c5fed to bb786d8 Compare August 12, 2026 09:51
@WenyXu
WenyXu changed the base branch from docs/events-query-ddl-2723 to main August 12, 2026 11:47
WenyXu added 2 commits August 12, 2026 12:12
Signed-off-by: WenyXu <wenymedia@gmail.com>
Signed-off-by: WenyXu <wenymedia@gmail.com>
@WenyXu
WenyXu marked this pull request as ready for review August 12, 2026 13:00
Copilot AI lite review requested due to automatic review settings August 12, 2026 13:00

Copilot AI left a comment

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.

Pull request overview

Adds Nightly English and Chinese documentation for Metasrv-emitted operational event families (repartitioning, region migration, batch GC, and WAL pruning) so operators can query greptime_private.events for distributed-cluster maintenance and region-level activity.

Changes:

  • Add new “Region events” and “Maintenance events” pages with SQL query examples and field interpretation notes.
  • Extend Events overview pages to link to the new focused guides.
  • Update sidebar navigation to include the new pages under Monitoring → Events.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
sidebars.ts Adds the new Events subpages to the Monitoring navigation.
docs/user-guide/deployments-administration/monitoring/events/overview.md Links to the new Region/Maintenance events guides from the English Events overview.
docs/user-guide/deployments-administration/monitoring/events/region-events.md New English guide for repartition and region migration events, with SQL cookbook examples.
docs/user-guide/deployments-administration/monitoring/events/maintenance-events.md New English guide for batch GC and WAL prune events, including behavior notes and example outputs.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/overview.md Links to the new Region/Maintenance events guides from the Chinese Events overview.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/region-events.md New Chinese guide for repartition and region migration events, with SQL cookbook examples.
i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/maintenance-events.md New Chinese guide for batch GC and WAL prune events, including behavior notes and example outputs.
Suppressed comments (2)

docs/user-guide/deployments-administration/monitoring/events/region-events.md:91

  • The sample output includes concrete peer addresses (e.g., 172.16.x.x:4001). If the query is adjusted to omit peer addresses, the example output should also remove the *_datanode_addr columns to avoid publishing internal IPs/ports.
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+
| timestamp                     | procedure_id                         | procedure_state | region_id     | table_id | region_number | region_migration_trigger_reason | source_datanode_id | source_datanode_addr | target_datanode_id | target_datanode_addr |
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+
| 2026-08-10 02:52:50.078350103 | 63167e21-0165-4964-afef-02271baa126b | Done            | 5162550689808 |     1202 |            16 | AutoRebalance                   |                  1 | 172.16.62.49:4001    |                  2 | 172.16.232.158:4001  |
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+

i18n/zh/docusaurus-plugin-content-docs/current/user-guide/deployments-administration/monitoring/events/region-events.md:91

  • 示例输出包含具体的 peer 地址(如 172.16.x.x:4001)。如果查询改为不返回 peer 地址,示例输出也应移除 *_datanode_addr 列,避免在文档中发布内部 IP/端口。
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+
| timestamp                     | procedure_id                         | procedure_state | region_id     | table_id | region_number | region_migration_trigger_reason | source_datanode_id | source_datanode_addr | target_datanode_id | target_datanode_addr |
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+
| 2026-08-10 02:52:50.078350103 | 63167e21-0165-4964-afef-02271baa126b | Done            | 5162550689808 |     1202 |            16 | AutoRebalance                   |                  1 | 172.16.62.49:4001    |                  2 | 172.16.232.158:4001  |
+-------------------------------+--------------------------------------+-----------------+---------------+----------+---------------+---------------------------------+--------------------+----------------------+--------------------+----------------------+

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread docs/user-guide/deployments-administration/monitoring/events/region-events.md Outdated
@WenyXu

WenyXu commented Aug 12, 2026

Copy link
Copy Markdown
Member Author

@codex review

Signed-off-by: WenyXu <wenymedia@gmail.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Delightful!

Reviewed commit: 6d535fab2c

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@WenyXu WenyXu changed the title docs: document Metasrv operational events docs: document Region and maintenance events Aug 12, 2026
Comment thread docs/user-guide/deployments-administration/monitoring/events/region-events.md Outdated
Signed-off-by: WenyXu <wenymedia@gmail.com>

@fengjiachun fengjiachun left a comment

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.

LGTM

Signed-off-by: WenyXu <wenymedia@gmail.com>
@WenyXu
WenyXu merged commit 38c4da4 into GreptimeTeam:main Aug 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants