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

Adding new configuration for queues #198

Merged
merged 2 commits into from
Nov 17, 2023
Merged

Adding new configuration for queues #198

merged 2 commits into from
Nov 17, 2023

Conversation

srtfisher
Copy link
Member

@srtfisher srtfisher commented Nov 16, 2023

Supports the work in alleyinteractive/mantle-framework#456

Summary by CodeRabbit

  • New Features
    • Introduced new configuration options for queue management, including:
      • Settings for maximum concurrent batch processing.
      • Automatic deletion of queue items after a configurable time.
      • Access to a queue admin interface for better queue oversight.

Copy link

coderabbitai bot commented Nov 16, 2023

Walkthrough

The update to the config/queue.php file introduces additional configuration options for queue management. These options include the ability to set a maximum number of concurrent batch jobs, specify a time after which queue items should be automatically deleted, and toggle the availability of a queue admin interface. These enhancements provide administrators with more control over the queue's behavior and maintenance, as well as tools for monitoring and managing queued jobs.

Changes

File Path Change Summary
config/queue.php Added settings for max_concurrent_batches, delete_after time, and enable_queue_admin interface.

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 4d9858c and b7292f9.
Files selected for processing (1)
  • config/queue.php (1 hunks)
Additional comments: 1
config/queue.php (1)
  • 27-61: The new configuration options introduced here seem to align with the pull request's summary and aim to enhance the queue system's functionality. The use of the environment function suggests that these settings can be easily adjusted via environment variables, which is a common and secure practice for configuration management.
  • The max_concurrent_batches setting on lines 41 allows for controlling the concurrency of batch processing, which can help prevent system overload.
  • The delete_after setting on lines 51 provides a mechanism for automatic cleanup of queue items, which is essential for maintaining a healthy queue size.
  • The enable_admin setting on lines 61 introduces an administrative interface for the queue, which can be very useful for monitoring and managing the queue.

Ensure that the corresponding environment variables (QUEUE_MAX_CONCURRENT_BATCHES, QUEUE_DELETE_AFTER, QUEUE_ENABLE_ADMIN) are documented and that their usage is clear to the system administrators. Also, verify that the default values provided are sensible for a typical use case and that they won't introduce any unexpected behavior for existing deployments upon update.

Copy link

@jacobschweitzer jacobschweitzer left a comment

Choose a reason for hiding this comment

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

🐴

@srtfisher srtfisher enabled auto-merge (squash) November 17, 2023 16:07
@srtfisher srtfisher merged commit db9b6b2 into main Nov 17, 2023
10 checks passed
@srtfisher srtfisher deleted the queue-refactor branch November 17, 2023 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants