feat: add `region_statistics` table #4771

WenyXu · 2024-09-26T06:56:37Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Add region_statistics table

mysql> select * from information_schema.region_statistics;
+---------------+----------+---------------+---------------+---------------+-----------+--------+-------------+
| region_id     | table_id | region_number | memtable_size | manifest_size | sst_size  | engine | region_role |
+---------------+----------+---------------+---------------+---------------+-----------+--------+-------------+
| 4440996184064 |     1034 |             0 |       3586817 |         11704 | 301876450 | mito   | Leader      |
| 4432406249472 |     1032 |             0 |     269686817 |         12508 | 279053485 | mito   | Leader      |
| 4445291151360 |     1035 |             0 |      56686817 |          9232 | 297195520 | mito   | Leader      |
| 4436701216768 |     1033 |             0 |     239386817 |          9139 | 281388451 | mito   | Leader      |
+---------------+----------+---------------+---------------+---------------+-----------+--------+-------------+
4 rows in set (0.01 sec)

Checklist

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.

Summary by CodeRabbit

New Features
- Introduced a new error variant for handling region statistics.
- Added functionality to retrieve region statistics from the cluster.
- Expanded the information schema to include region statistics.
- Implemented a comprehensive mechanism for managing and retrieving region statistics.
Bug Fixes
- Enhanced error handling for JSON serialization and deserialization.
Documentation
- Updated documentation to reflect the new region statistics features and error handling improvements.

coderabbitai · 2024-09-26T06:56:43Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces several enhancements across multiple files, primarily focusing on error handling and the management of region statistics in a catalog system. Key changes include the addition of new error variants to handle JSON serialization issues, updates to the KvBackendCatalogManager struct for improved metadata management, and the introduction of a new module for region statistics within the information schema. These modifications collectively enhance the functionality and robustness of the system.

Changes

Files	Change Summary
`src/catalog/src/error.rs`	Added new error variant `ListRegionStats` to handle listing region statistics. Updated `ErrorExt` implementation to accommodate the new variant.
`src/catalog/src/kvbackend/manager.rs`	Enhanced `KvBackendCatalogManager` struct by adding fields for managing metadata, partition rules, caching, and procedures.
`src/catalog/src/system_schema/information_schema.rs`	Introduced a new module `region_statistics` and updated `SystemSchemaProviderInner` to handle `REGION_STATISTICS`, integrating it into the information schema.
`src/catalog/src/system_schema/information_schema/region_statistics.rs`	Implemented `InformationSchemaRegionStatistics` struct for region statistics, including methods for schema retrieval and data streaming. Added a builder for constructing region statistics.
`src/catalog/src/system_schema/information_schema/table_names.rs`	Added constant `REGION_STATISTICS` for referencing the new region statistics table within the information schema.
`src/common/catalog/src/consts.rs`	Introduced constant `INFORMATION_SCHEMA_REGION_STATISTICS_TABLE_ID` with value `35` for the new region statistics table.
`src/common/meta/src/cluster.rs`	Added asynchronous method `list_region_stats` to `ClusterInfo` trait for retrieving region statistics.
`src/common/meta/src/datanode.rs`	Created structures for managing datanode statistics, including `Stat`, `RegionStat`, and methods for handling datanode state and statistics.
`src/common/meta/src/error.rs`	Added new error variants `SerializeToJson`, `DeserializeFromJson`, and `InvalidStatKey` to enhance error handling related to JSON operations and invalid keys. Updated `ErrorExt` for new error variants.

Possibly related PRs

feat: add json data type #4619: The main PR introduces a new variant in the Error enum to handle errors related to listing region statistics, while the retrieved PR adds a JSON data type and related functionality, which may involve error handling for JSON operations.

Suggested reviewers

v0y4g3r
evenyag
waynexia
discord9

🐇 In the meadow where data flows,
New stats for regions now brightly glows.
Errors handled with care and grace,
In our catalog, they find their place.
With every change, our system grows,
Hopping forward, as progress shows! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

WenyXu · 2024-09-26T08:15:30Z

@coderabbitai summary

coderabbitai · 2024-09-26T08:15:35Z

✅ Actions performed

Summary regeneration triggered.

codecov · 2024-09-26T08:20:34Z

Codecov Report

Attention: Patch coverage is 65.58704% with 170 lines in your changes missing coverage. Please review.

Project coverage is 84.21%. Comparing base (cd4bf23) to head (fc4b0d7).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4771      +/-   ##
==========================================
- Coverage   84.55%   84.21%   -0.34%     
==========================================
  Files        1117     1118       +1     
  Lines      202684   203013     +329     
==========================================
- Hits       171370   170969     -401     
- Misses      31314    32044     +730

src/common/meta/src/datanode.rs

src/meta-client/src/client.rs

fengjiachun

Rest LGTM

src/common/meta/src/datanode.rs

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

killme2008 · 2024-10-02T02:35:39Z

src/catalog/src/system_schema/information_schema/region_statistics.rs

+
+        match mode {
+            Mode::Standalone => {
+                // TODO(weny): implement it


Why not implement it? It's very useful for both standalone and distributed clusters to get the statistics info of regions.

I have implemented it in #4811

WenyXu added 4 commits September 25, 2024 12:53

refactor: introduce region_statistic

4e624df

refactor: move DatanodeStat related structs to common_meta

c09a97f

chore: add comments

e0d89b2

feat: implement list_region_stats for ClusterInfo trait

832c25c

github-actions bot added the docs-not-required This change does not impact docs. label Sep 26, 2024

WenyXu force-pushed the feat/region-stats branch 2 times, most recently from d7db827 to 85cb8df Compare September 26, 2024 07:13

feat: add region_statistics table

2f5d561

WenyXu force-pushed the feat/region-stats branch from 85cb8df to 2f5d561 Compare September 26, 2024 07:19

feat: add table_id and region_number fields

f7f377b

WenyXu force-pushed the feat/region-stats branch from c7994f7 to f7f377b Compare September 26, 2024 07:51

WenyXu added 2 commits September 26, 2024 08:00

chore: rename unused snafu

f555bce

chore: udpate sqlness results

f7284aa

WenyXu requested a review from fengjiachun September 26, 2024 08:01

WenyXu marked this pull request as ready for review September 26, 2024 08:01

WenyXu requested review from waynexia, v0y4g3r, MichaelScofield, evenyag and a team as code owners September 26, 2024 08:01

WenyXu requested a review from discord9 September 26, 2024 08:05

WenyXu added 2 commits September 26, 2024 08:32

chore: avoid to print source in error msg

e0f76f2

chore: move procedure_info under greptime catalog

f725d79

MichaelScofield approved these changes Sep 27, 2024

View reviewed changes

zhongzc reviewed Sep 27, 2024

View reviewed changes

src/common/meta/src/datanode.rs Show resolved Hide resolved

zhongzc reviewed Sep 27, 2024

View reviewed changes

src/common/meta/src/datanode.rs Outdated Show resolved Hide resolved

chore: apply suggestions from CR

bffc2ed

zhongzc reviewed Sep 27, 2024

View reviewed changes

src/meta-client/src/client.rs Show resolved Hide resolved

zhongzc approved these changes Sep 27, 2024

View reviewed changes

fengjiachun approved these changes Sep 27, 2024

View reviewed changes

src/common/meta/src/datanode.rs Outdated Show resolved Hide resolved

Update src/common/meta/src/datanode.rs

fc4b0d7

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

WenyXu enabled auto-merge September 27, 2024 09:39

WenyXu added this pull request to the merge queue Sep 27, 2024

Merged via the queue into GreptimeTeam:main with commit 4045298 Sep 27, 2024
31 of 32 checks passed

WenyXu deleted the feat/region-stats branch September 27, 2024 10:13

killme2008 reviewed Oct 2, 2024

View reviewed changes

killme2008 mentioned this pull request Oct 29, 2024

Adds index data size to region_statistics table #4896

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `region_statistics` table #4771

feat: add `region_statistics` table #4771

WenyXu commented Sep 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 26, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

WenyXu commented Sep 26, 2024

coderabbitai bot commented Sep 26, 2024

codecov bot commented Sep 26, 2024 •

edited

Loading

fengjiachun left a comment

killme2008 Oct 2, 2024

fengjiachun Oct 11, 2024

feat: add region_statistics table #4771

feat: add region_statistics table #4771

Conversation

WenyXu commented Sep 26, 2024 • edited by coderabbitai bot Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

Summary by CodeRabbit

coderabbitai bot commented Sep 26, 2024 • edited Loading

Review skipped

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

WenyXu commented Sep 26, 2024

coderabbitai bot commented Sep 26, 2024

codecov bot commented Sep 26, 2024 • edited Loading

Codecov Report

fengjiachun left a comment

Choose a reason for hiding this comment

killme2008 Oct 2, 2024

Choose a reason for hiding this comment

fengjiachun Oct 11, 2024

Choose a reason for hiding this comment

feat: add `region_statistics` table #4771

feat: add `region_statistics` table #4771

WenyXu commented Sep 26, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 26, 2024 •

edited

Loading

codecov bot commented Sep 26, 2024 •

edited

Loading