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: make log-retention-time dynamically changeable #2963

Conversation

cheniujh
Copy link
Collaborator

@cheniujh cheniujh commented Dec 4, 2024

支持使用config get/set 动态获取、调整log-retention-time参数

Summary by CodeRabbit

  • New Features

    • Introduced a new configuration parameter for log retention time, allowing users to specify how long logs should be retained.
    • Added a setter method for dynamically updating the log retention time while ensuring thread safety.
  • Bug Fixes

    • Enhanced validation for the log retention time to ensure it is a positive integer before updates.

Copy link

coderabbitai bot commented Dec 4, 2024

Walkthrough

The changes introduce a new method SetLogRetentionTime in the PikaConf class, allowing dynamic updates to the log retention time with thread safety. Additionally, the ConfigCmd class in src/pika_admin.cc is updated to handle a new configuration parameter, log-retention-time, in its ConfigGet and ConfigSet methods. This integration ensures that the log retention time can be retrieved and set while maintaining the integrity of existing command structures.

Changes

File Change Summary
include/pika_conf.h Added method void SetLogRetentionTime(const int& value) to PikaConf class for log retention.
src/pika_admin.cc Updated ConfigCmd class to handle log-retention-time in ConfigGet and ConfigSet methods.

Poem

🐇 In the code where changes bloom,
A setter now clears the gloom.
Logs retained with care and grace,
Configs dance in a lively space.
With threads secure, we hop along,
A brighter path where logs belong! 🌟


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.

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 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 ✏️ Feature New feature or request label Dec 4, 2024
Copy link

@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

🧹 Outside diff range and nitpick comments (1)
include/pika_conf.h (1)

Line range hint 1003-1003: Initialize log_retention_time_ member variable.

The log_retention_time_ member variable should be initialized to prevent undefined behavior.

Add initialization in the private section:

-  int log_retention_time_;
+  int log_retention_time_ = 0;
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 937ebde and c129fc2.

📒 Files selected for processing (2)
  • include/pika_conf.h (1 hunks)
  • src/pika_admin.cc (2 hunks)
🔇 Additional comments (3)
include/pika_conf.h (1)

Line range hint 63-63: LGTM! Thread-safe implementation of log retention time getter/setter.

The getter and setter methods properly use shared locks and lock guards respectively to ensure thread safety.

Also applies to: 775-779

src/pika_admin.cc (2)

1593-1598: LGTM! Proper implementation of ConfigGet for log-retention-time.

The implementation correctly:

  • Uses pattern matching for parameter name
  • Encodes the response following Redis protocol

2354-2360: LGTM! Proper implementation of ConfigSet with input validation.

The implementation correctly:

  • Validates that the input is a positive integer
  • Returns appropriate error message for invalid input
  • Updates the configuration using SetLogRetentionTime

@chejinge chejinge merged commit bc46bad into OpenAtomFoundation:unstable Dec 11, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.5.6 4.0.2 ✏️ Feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants