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: enhanced the retry logic by adding a random noise #4320

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

WenyXu
Copy link
Member

@WenyXu WenyXu commented Jul 9, 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?

Enhanced the retry logic by adding a random noise to the retry delay to avoid retry storms

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 random noise to retry intervals, enhancing the robustness of retry mechanisms and reducing predictable retry patterns.

@WenyXu WenyXu requested review from MichaelScofield and a team as code owners July 9, 2024 02:59
Copy link
Contributor

coderabbitai bot commented Jul 9, 2024

Walkthrough

The recent changes introduce the rand crate to the workspace dependencies to generate random noise for retry intervals in the Runner implementation. Specifically, this change affects the retry behavior by adding variability (noise) to the retry duration, aiming to improve the robustness of the retry mechanism.

Changes

File Path Change Summary
src/common/procedure/Cargo.toml Added rand to the workspace dependencies in the [dependencies] section.
src/common/procedure/src/local/runner.rs Incorporated rand crate. Added use rand::Rng; and modified Runner to include noise in retry intervals.

Poem

In the fields where code does bloom,
A touch of randomness we assume,
With retries now a varied beat,
This change makes failure's sting less fleet,
The rand crate joins our code’s bright loom.
🌿✨


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.

@github-actions github-actions bot added the docs-not-required This change does not impact docs. label Jul 9, 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 d1f1fad and 4071bf9.

Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (2)
  • src/common/procedure/Cargo.toml (1 hunks)
  • src/common/procedure/src/local/runner.rs (2 hunks)
Files skipped from review due to trivial changes (1)
  • src/common/procedure/Cargo.toml
Additional comments not posted (2)
src/common/procedure/src/local/runner.rs (2)

21-21: LGTM! The import is necessary for the new functionality.

The addition of rand::Rng is appropriate for introducing randomness into the retry intervals.


203-206: LGTM! Ensure the noise is appropriately bounded.

The changes correctly introduce randomness into the retry delay. Verify that the noise, which is bounded by a quarter of the retry interval, is appropriate for your use case.

@WenyXu WenyXu force-pushed the feat/random-noise-on-retry branch from 4071bf9 to c7075e3 Compare July 9, 2024 03:24
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 4071bf9 and c7075e3.

Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (2)
  • src/common/procedure/Cargo.toml (1 hunks)
  • src/common/procedure/src/local/runner.rs (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • src/common/procedure/Cargo.toml
Additional comments not posted (2)
src/common/procedure/src/local/runner.rs (2)

21-21: Imported rand::Rng for random noise in retry logic.

The import of rand::Rng is necessary for adding random noise to the retry delay.


203-207: Enhanced retry logic with random noise.

The retry logic now includes random noise to avoid retry storms. This is a good enhancement to prevent simultaneous retries.

Copy link

codecov bot commented Jul 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.89%. Comparing base (d1f1fad) to head (c7075e3).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4320      +/-   ##
==========================================
- Coverage   85.15%   84.89%   -0.27%     
==========================================
  Files        1061     1061              
  Lines      188255   188260       +5     
==========================================
- Hits       160313   159818     -495     
- Misses      27942    28442     +500     

@WenyXu WenyXu requested a review from fengjiachun July 9, 2024 03:50
Copy link
Collaborator

@fengjiachun fengjiachun left a comment

Choose a reason for hiding this comment

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

LGTM

@fengjiachun fengjiachun added this pull request to the merge queue Jul 9, 2024
@@ -198,6 +200,11 @@ impl Runner {
ProcedureState::Retrying { error } => {
retry_times += 1;
if let Some(d) = retry.next() {
let millis = d.as_millis() as u64;
// Add random noise to the retry delay to avoid retry storms.
let noise = rand::thread_rng().gen_range(0..(millis / 4) + 1);
Copy link
Member

Choose a reason for hiding this comment

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

this one is typically called jitter

Merged via the queue into GreptimeTeam:main with commit 1a9314a Jul 9, 2024
55 checks passed
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.

4 participants