Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: forgot collect flownode clusterinfo handler #4236

Conversation

fengjiachun
Copy link
Collaborator

@fengjiachun fengjiachun commented Jul 1, 2024

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?

  1. Forgot to add CollectFlownodeClusterInfoHandler into the pipeline, which will result in the inability to collect the cluster info of flownodes (this part of information for flownodes has not been enabled yet).
  2. Two handlers had unclear names, causing misunderstandings. They have now been given more appropriate names:
    CollectStatsHandler to ExtractStatHandler
    PersistStatsHandler to CollectStatsHandler

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 statistics extraction handler for improved data processing and role validation.
    • Enhanced cache management and data persistence in the statistics collection handler.
  • Bug Fixes

    • Improved handling of stale heartbeats to ensure accurate data collection.
  • Refactor

    • Replaced and renamed handlers for clarity and better functionality in the codebase.

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

Walkthrough

The meta-handler updates introduced ExtractStatHandler and refined CollectStatsHandler while removing PersistStatsHandler. These changes enhanced data persistence, heartbeat processing, and cache management for statistics, aiming to improve stability and efficiency in the meta-service.

Changes

File(s) Change Summary
src/meta-srv/src/handler.rs Added extract_stat_handler module; removed persist_stats_handler module; swapped handlers in test modules accordingly.
src/meta-srv/src/handler/collect_stats_handler.rs Enhanced CollectStatsHandler with PutRequest, DashMap, and new EpochStats struct; improved heartbeat and cache management.
src/meta-srv/src/handler/extract_stat_handler.rs Implemented ExtractStatHandler with HeartbeatHandler trait for validating roles and accumulating statistics from requests.
src/meta-srv/src/metasrv/builder.rs Updated handler declarations in MetasrvBuilder: renamed and added new handlers such as ExtractStatHandler and CollectFlownodeClusterInfoHandler.

Sequence Diagrams

Below is a sequence diagram demonstrating the updated heartbeat handling flow with the new CollectStatsHandler and ExtractStatHandler.

sequenceDiagram
    participant Client
    participant ExtractStatHandler
    participant CollectStatsHandler
    participant DataStore
    
    Client->>+ExtractStatHandler: Send Heartbeat Request
    ExtractStatHandler->>ExtractStatHandler: Validate Role
    ExtractStatHandler->>+CollectStatsHandler: Forward Heartbeat Request
    CollectStatsHandler->>CollectStatsHandler: Process Statistics
    CollectStatsHandler->>DashMap: Update Cache
    CollectStatsHandler->>DataStore: Persist Stats with PutRequest
    CollectStatsHandler-->>-ExtractStatHandler: Acknowledge Receipt
    ExtractStatHandler-->>-Client: Heartbeat Acknowledged
Loading

Poem

In the server's gentle heartbeat thrum,
We gather stats, our work begun.
Extracts and collects, a cadence bright,
Ensuring data feels just right.
🐰✨ With code refined and caches deep,
Our meta-service scales to keep.


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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>.
    • 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 Configration 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 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 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.

@fengjiachun fengjiachun requested a review from WenyXu July 1, 2024 03:03
@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 1, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ddc7a80 and d38d5cd.

Files selected for processing (4)
  • src/meta-srv/src/handler.rs (3 hunks)
  • src/meta-srv/src/handler/collect_stats_handler.rs (2 hunks)
  • src/meta-srv/src/handler/extract_stat_handler.rs (1 hunks)
  • src/meta-srv/src/metasrv/builder.rs (3 hunks)
Additional comments not posted (7)
src/meta-srv/src/handler/extract_stat_handler.rs (3)

23-23: Struct Definition Approved

The ExtractStatHandler struct is correctly defined as a unit struct, suitable for its purpose.


26-29: Method Implementation Review: is_acceptable

The is_acceptable method correctly checks if the role is Datanode, which aligns with the design intent of handling data node-specific statistics.


31-52: Method Implementation Review: handle

The handle method efficiently checks for mailbox messages and skips processing if present, which is a good optimization given the context. The conversion of the request to a Stat object and the subsequent error handling are well-implemented.

src/meta-srv/src/handler.rs (1)

46-46: Module Addition Approved

The addition of the extract_stat_handler module is consistent with the introduction of ExtractStatHandler in other parts of the codebase.

src/meta-srv/src/metasrv/builder.rs (3)

365-365: Handler Addition Approved

The addition of ExtractStatHandler to the builder is correctly implemented, ensuring the handler is integrated into the system.


368-368: Handler Renaming Approved

The renaming of CollectFrontendClusterInfoHandler to CollectFlownodeClusterInfoHandler is consistently applied and aligns with the PR's objectives to clarify handler names.


378-378: Handler Addition Approved

The addition of CollectStatsHandler to the builder is correctly implemented, ensuring the handler is integrated into the system.

@fengjiachun
Copy link
Collaborator Author

@coderabbitai Your summary is not accurate. For example, ExtractStatHandler was not newly introduced; I just renamed it.

Copy link
Contributor

coderabbitai bot commented Jul 1, 2024

@fengjiachun, thank you for pointing that out. Upon reviewing the git history and diffs, I can confirm that ExtractStatHandler was indeed renamed and not newly introduced. I appreciate your clarification.

Analysis chain
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Check the git history for the file where `ExtractStatHandler` is mentioned to verify if it was newly created or renamed.
git log --follow -- src/meta-srv/src/handler/extract_stat_handler.rs

Length of output: 655



Script:

#!/bin/bash
# Check the git diff for the commit where `src/meta-srv/src/handler/extract_stat_handler.rs` was introduced to see if it was renamed or moved from another file.
git diff ddc7a80f56885f70e935dd9831aabb9c68d17340 d38d5cd60735b95a432722d5e188f3d3fa13949c

Length of output: 22022


Learnings added
Learnt from: fengjiachun
URL: https://github.com/GreptimeTeam/greptimedb/pull/4236

Timestamp: 2024-07-01T03:08:59.224Z
Learning: When summarizing changes, ensure to verify if files or handlers were renamed rather than newly introduced by checking the git history and diffs.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

Actions performed

Summary regeneration triggered.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d38d5cd and 3beff8d.

Files selected for processing (1)
  • src/meta-srv/src/handler.rs (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/meta-srv/src/handler.rs

Copy link

codecov bot commented Jul 1, 2024

Codecov Report

Attention: Patch coverage is 96.39175% with 7 lines in your changes missing coverage. Please review.

Project coverage is 84.59%. Comparing base (ddc7a80) to head (36ac0fe).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4236      +/-   ##
==========================================
- Coverage   84.86%   84.59%   -0.28%     
==========================================
  Files        1045     1046       +1     
  Lines      184365   184620     +255     
==========================================
- Hits       156470   156179     -291     
- Misses      27895    28441     +546     

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3beff8d and 36ac0fe.

Files selected for processing (1)
  • src/meta-srv/src/handler/collect_stats_handler.rs (2 hunks)
Additional comments not posted (6)
src/meta-srv/src/handler/collect_stats_handler.rs (6)

31-66: Consider adding documentation for EpochStats.

Adding documentation comments for the EpochStats struct and its methods will improve code readability and maintainability.

/// Struct to manage statistics and epochs.
struct EpochStats {
    stats: Vec<Stat>,
    epoch: Option<u64>,
}

impl EpochStats {
    /// Drains all statistics.
    #[inline]
    fn drain_all(&mut self) -> Vec<Stat> {
        self.stats.drain(..).collect()
    }

    /// Clears all statistics.
    #[inline]
    fn clear_stats(&mut self) {
        self.stats.clear();
    }

    /// Pushes a new statistic.
    #[inline]
    fn push_stat(&mut self, stat: Stat) {
        self.stats.push(stat);
    }

    /// Returns the number of statistics.
    #[inline]
    fn len(&self) -> usize {
        self.stats.len()
    }

    /// Returns the current epoch.
    #[inline]
    fn epoch(&self) -> Option<u64> {
        self.epoch
    }

    /// Sets a new epoch.
    #[inline]
    fn set_epoch(&mut self, epoch: u64) {
        self.epoch = Some(epoch);
    }
}

69-72: Consider adding documentation for CollectStatsHandler.

Adding documentation comments for the CollectStatsHandler struct will improve code readability and maintainability.

/// Handler to collect and cache statistics.
pub struct CollectStatsHandler {
    stats_cache: DashMap<DatanodeStatKey, EpochStats>,
}

81-88: Consider logging when current_stat is None.

Adding a log statement when current_stat is None can help in debugging and monitoring.

let Some(current_stat) = acc.stat.take() else {
    warn!("No current_stat received in heartbeat");
    return Ok(HandleControl::Continue);
};

96-112: Consider simplifying the epoch comparison logic.

The epoch comparison logic can be simplified for better readability.

let refresh = match epoch_stats.epoch() {
    Some(epoch) if current_stat.node_epoch > epoch => {
        // This node may have been redeployed.
        epoch_stats.clear_stats();
        epoch_stats.set_epoch(current_stat.node_epoch);
        epoch_stats.push_stat(current_stat);
        true
    }
    Some(epoch) if current_stat.node_epoch == epoch => {
        epoch_stats.push_stat(current_stat);
        false
    }
    Some(_) => {
        warn!("Ignore stale heartbeat: {:?}", current_stat);
        false
    }
    None => {
        epoch_stats.set_epoch(current_stat.node_epoch);
        epoch_stats.push_stat(current_stat);
        // If the epoch is empty, it indicates that the current node sending the heartbeat
        // for the first time to the current meta leader, so it is necessary to save
        // the data to the KV store as soon as possible.
        true
    }
};

18-21: Ensure new imports are necessary and used.

Verify that PutRequest and DashMap are necessary and used within the code. Unused imports can be removed to keep the code clean.

Verification successful

Imports are necessary and correctly used.

The imports PutRequest and DashMap are used within the code and are necessary. No changes are needed.

  • PutRequest is instantiated in the code.
  • DashMap is used as a type for stats_cache.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the usage of new imports in the file.

# Test: Search for the usage of `PutRequest` and `DashMap`. Expect: Usage found.
rg --type rust 'PutRequest|DashMap' src/meta-srv/src/handler/collect_stats_handler.rs

Length of output: 236


147-215: Ensure test coverage for edge cases.

The test test_handle_datanode_stats should cover edge cases, such as handling stale heartbeats and large numbers of stats.

@MichaelScofield MichaelScofield added this pull request to the merge queue Jul 1, 2024
Merged via the queue into GreptimeTeam:main with commit 5d396bd Jul 1, 2024
51 of 52 checks passed
@fengjiachun fengjiachun deleted the feat/forgot-collect-flownode-clusterinfo-handler branch July 3, 2024 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-not-required This change does not impact docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants