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: show flow's mem usage in INFORMATION_SCHEMA.FLOWS #4890

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

discord9
Copy link
Contributor

@discord9 discord9 commented Oct 28, 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?

Add a column to show flow's mem usage in system table, so one can tune flow's ttl option as needed.

Please explain IN DETAIL what the changes are in this PR and why they are needed:

in distributed mode Flownode's heartbeat task will reguarly ask for a StateReport which include all flows' mem usage data, and send them to metasrv, then metasrv can use this info to build system table, however there is a small latency in data update since heartbeat duration is in seconds but this usually is ok since flow's mem usage grow very slowly usually. In standalone mode can just query flow's mem size

Checklist

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

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Oct 28, 2024
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

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.


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.

@discord9 discord9 force-pushed the flow_state_size branch 3 times, most recently from 39fda57 to 1b0b0ef Compare October 31, 2024 07:06
@discord9 discord9 changed the title feat: add a column for flow's mem state size in system table feat: show flow's mem usage in INFORMATION_SCHEMA.FLOWS Oct 31, 2024
@discord9 discord9 marked this pull request as ready for review October 31, 2024 07:16
Copy link

codecov bot commented Oct 31, 2024

Codecov Report

Attention: Patch coverage is 20.93023% with 340 lines in your changes missing coverage. Please review.

Project coverage is 83.63%. Comparing base (3633f25) to head (a7fc29a).
Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4890      +/-   ##
==========================================
- Coverage   84.00%   83.63%   -0.37%     
==========================================
  Files        1149     1154       +5     
  Lines      214820   215540     +720     
==========================================
- Hits       180450   180260     -190     
- Misses      34370    35280     +910     

@discord9 discord9 removed the request for review from MichaelScofield October 31, 2024 08:23
src/meta-client/src/client.rs Show resolved Hide resolved
src/flow/src/utils.rs Outdated Show resolved Hide resolved
@killme2008
Copy link
Contributor

What's the status of this PR?

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 19 out of 34 changed files in this pull request and generated 1 suggestion.

Files not reviewed (15)
  • src/common/meta/src/kv_backend.rs: Evaluated as low risk
  • src/common/meta/src/kv_backend/memory.rs: Evaluated as low risk
  • src/cmd/src/cli/repl.rs: Evaluated as low risk
  • src/flow/src/compute/state.rs: Evaluated as low risk
  • src/cmd/src/error.rs: Evaluated as low risk
  • src/common/meta/src/key/flow.rs: Evaluated as low risk
  • src/catalog/src/error.rs: Evaluated as low risk
  • src/common/meta/src/key.rs: Evaluated as low risk
  • src/flow/src/repr.rs: Evaluated as low risk
  • scripts/check-snafu.py: Evaluated as low risk
  • src/flow/src/error.rs: Evaluated as low risk
  • src/flow/Cargo.toml: Evaluated as low risk
  • src/catalog/src/system_schema/information_schema.rs: Evaluated as low risk
  • src/catalog/src/system_schema/information_schema/flows.rs: Evaluated as low risk
  • src/cmd/src/lib.rs: Evaluated as low risk
Comments skipped due to low confidence (1)

src/flow/src/adapter.rs:183

  • [nitpick] The method name 'with_state_report_handler' is ambiguous. Consider renaming it to 'set_state_report_handler'.
pub async fn with_state_report_handler(self, handler: StateReportHandler) -> Self {

src/flow/src/adapter.rs Show resolved Hide resolved
Copy link
Member

@waynexia waynexia left a comment

Choose a reason for hiding this comment

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

I've skimmed this and it looks good to me in general

@discord9
Copy link
Contributor Author

I need to refactor this pr to make it more similiar to CollectStatHandler to make it more clean, convert it to draft for now

@discord9 discord9 marked this pull request as draft November 26, 2024 08:02
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