mxsm / rocketmq-rust

🚀Apache RocketMQ Rust implementation. Faster, safer, and with lower memory usage.
https://docs.rs/rocketmq-rust
Apache License 2.0
538 stars 66 forks source link

[ISSUES #833] Support AdminBrokerProcessor get_topic_stats_info. #849

Closed 847850277 closed 1 month ago

847850277 commented 1 month ago

Which Issue(s) This PR Fixes(Closes)

Fixes #833

Brief Description

How Did You Test This Change?

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance the functionality of the RocketMQ system by introducing a new method in the AdminBrokerProcessor for retrieving topic statistics. This is complemented by the addition of new data structures and methods in the remoting protocol to manage topic offsets and statistics, improving overall message monitoring and administration capabilities within the messaging system.

Changes

Files Change Summary
rocketmq-broker/src/.../admin_broker_processor.rs Added handling for RequestCode::GetTopicStatsInfo in AdminBrokerProcessor, invoking get_topic_stats_info method to enhance request handling capabilities.
rocketmq-broker/src/.../topic_request_handler.rs Introduced get_topic_stats_info method in TopicRequestHandler for retrieving topic statistics, including offsets and last message timestamps.
rocketmq-remoting/src/protocol.rs Added new public module admin to organize administrative functionalities related to the RocketMQ protocol.
rocketmq-remoting/src/protocol/admin.rs Created admin.rs to establish modules for topic_offset and topic_stats_table for managing topic data.
rocketmq-remoting/src/protocol/admin/.../topic_offset.rs Defined TopicOffset struct to represent offsets with fields for min, max, and last update timestamp.
rocketmq-remoting/src/protocol/admin/.../topic_stats_table.rs Introduced TopicStatsTable struct to hold mappings of message queues to their offsets using a HashMap.
rocketmq-remoting/src/protocol/header.rs Added public module declaration for get_topic_stats_request_header.
rocketmq-remoting/src/protocol/header/.../get_topic_stats_request_header.rs Defined GetTopicStatsRequestHeader struct for encapsulating topic statistics request headers with serialization support.
rocketmq-store/src/log_file.rs Added get_message_store_timestamp method to RocketMQMessageStore trait to retrieve message store timestamps.
rocketmq-store/src/message_store/default_message_store.rs Implemented get_message_store_timestamp in DefaultMessageStore for fetching timestamps based on topic and queue parameters.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AdminBrokerProcessor
    participant TopicRequestHandler
    participant TopicStatsTable

    Client->>AdminBrokerProcessor: Request GetTopicStatsInfo
    AdminBrokerProcessor->>TopicRequestHandler: Call get_topic_stats_info
    TopicRequestHandler->>TopicStatsTable: Fetch topic offsets
    TopicStatsTable-->>TopicRequestHandler: Return offsets
    TopicRequestHandler-->>AdminBrokerProcessor: Return topic statistics
    AdminBrokerProcessor-->>Client: Send topic statistics response

Assessment against linked issues

Objective Addressed Explanation
Support for get_topic_stats_info in AdminBrokerProcessor (#[833])

🐰 In the land where messages flow,
New stats arise, our knowledge will grow!
With offsets tracked, each hop and skip,
Admins rejoice, let their worries skip!
RocketMQ shines, a rabbit's delight,
Hopping through data, from morning to night! 🌟


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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
mxsm commented 1 month ago

🚀Thanks for your contribution🎉. CodeRabbit(AI) will review your code first🔥

codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0% with 113 lines in your changes missing coverage. Please review.

Project coverage is 26.16%. Comparing base (f5f8922) to head (79abed9). Report is 3 commits behind head on main.

Files Patch % Lines
...or/admin_broker_processor/topic_request_handler.rs 0.00% 43 Missing :warning:
...cketmq-remoting/src/protocol/admin/topic_offset.rs 0.00% 28 Missing :warning:
.../protocol/header/get_topic_stats_request_header.rs 0.00% 17 Missing :warning:
...q-remoting/src/protocol/admin/topic_stats_table.rs 0.00% 12 Missing :warning:
...q-store/src/message_store/default_message_store.rs 0.00% 10 Missing :warning:
...tmq-broker/src/processor/admin_broker_processor.rs 0.00% 3 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #849 +/- ## ========================================== - Coverage 26.83% 26.16% -0.68% ========================================== Files 308 322 +14 Lines 25393 26013 +620 ========================================== - Hits 6813 6805 -8 - Misses 18580 19208 +628 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.