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

Merge the notifications and cleaning workers #8672

Merged
merged 1 commit into from
Nov 11, 2024

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Nov 8, 2024

Motivation and context

The notifications queue is used very rarely (and not at all in the OSS version), so it doesn't make sense to keep a dedicated worker just for it. Combining the two workers in the utils container saves memory and startup time.

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • [ ] I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • New Features

    • Consolidated notification and cleaning functionalities into a single worker program for improved efficiency.
    • Updated command for the worker to include cleaning functionality.
    • Adjusted environment variable to reflect the new worker configuration.
  • Bug Fixes

    • Removed redundant worker program to streamline operations.

Copy link
Contributor

coderabbitai bot commented Nov 8, 2024

Important

Review skipped

Auto incremental 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.

Walkthrough

The pull request modifies the supervisord/utils.conf configuration file by consolidating the rqworker functionalities. The program [program:rqworker-notifications] has been renamed to [program:rqworker], and its command has been updated to include a new argument, cleaning. Additionally, the environment variable CVAT_POSTGRES_APPLICATION_NAME has been changed to reflect this consolidation, and the previous [program:rqworker-cleaning] definition has been removed.

Changes

File Change Summary
supervisord/utils.conf - Renamed [program:rqworker-notifications] to [program:rqworker]
- Updated command from python3 %(ENV_HOME)s/manage.py rqworker -v 3 notifications to python3 %(ENV_HOME)s/manage.py rqworker -v 3 notifications cleaning
- Changed environment variable CVAT_POSTGRES_APPLICATION_NAME from "cvat:worker:notifications" to "cvat:worker:notifications+cleaning"
- Removed [program:rqworker-cleaning] section

Poem

In the burrow, changes sprout,
Workers merge, there's no doubt.
Notifications and cleaning unite,
A single program, shining bright.
With a hop and a skip, we cheer,
For streamlined tasks, we hold dear! 🐇✨


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.

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

🧹 Outside diff range and nitpick comments (1)
supervisord/utils.conf (1)

29-33: LGTM! Worker consolidation looks correct.

The merger of notification and cleaning workers is implemented correctly. The configuration maintains proper process management settings while combining the queues.

However, consider adding appropriate logging prefixes or tags to distinguish between notification and cleaning tasks in the logs for easier debugging.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a6fd1e5 and 6bbdab6.

📒 Files selected for processing (1)
  • supervisord/utils.conf (1 hunks)
🔇 Additional comments (1)
supervisord/utils.conf (1)

29-33: Verify resource requirements for the combined worker.

While consolidating workers is efficient for low-traffic queues, please verify:

  1. The combined worker can handle peak loads when both queues are active
  2. The ENV_NUMPROCS setting is sufficient for the combined workload
✅ Verification successful

Based on the gathered information, I can now provide a final response:

The combined worker configuration appears safe to implement

The codebase analysis reveals that:

  1. Both notifications and cleaning queues are lightweight, primarily handling background cache cleanup tasks and notifications
  2. The cleaning tasks are scheduled with large timeouts (4h default) and run periodically
  3. There's no evidence of high-concurrency requirements or performance bottlenecks in either queue

The default ENV_NUMPROCS setting will be sufficient as:

  • Cleaning tasks are mostly I/O bound (file operations)
  • Notifications are typically low-latency events
  • Both queues don't show patterns of sustained high load
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check historical queue metrics to verify workload assumptions

# Look for any existing monitoring or metrics related to these queues
rg -A 5 "notifications.*queue|cleaning.*queue" --type py

# Check for any performance-related comments or issues
rg -A 5 "performance.*worker|worker.*performance" --type py

Length of output: 3697


Script:

#!/bin/bash
# Let's check for the actual worker implementations and queue configurations

# Check worker implementations and configurations
ast-grep --pattern 'class DefaultWorker'

# Look for queue configurations and settings
rg -l "rqworker|RQ_QUEUES|QUEUES" --type py

# Check for any existing worker process configurations
rg "numprocs|NUM_WORKERS|WORKERS" supervisord/

# Look for actual queue definitions and their usage
rg "notifications.*queue|cleaning.*queue" -B 5 -A 5

Length of output: 7279


Script:

#!/bin/bash
# Let's check the settings and queue configurations

# Look for queue settings in base configuration
rg -A 10 "QUEUES.*=|RQ_QUEUES.*=" cvat/settings/

# Check for any rate limiting or concurrency settings
rg -A 5 "CONCURRENT|RATE_LIMIT" cvat/settings/

# Look for the actual implementation of notification and cleaning tasks
ast-grep --pattern 'def $_(notifications|cleaning)'

Length of output: 1075

@codecov-commenter
Copy link

codecov-commenter commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.25%. Comparing base (a6fd1e5) to head (6ff4b70).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #8672   +/-   ##
========================================
  Coverage    74.25%   74.25%           
========================================
  Files          401      401           
  Lines        43465    43465           
  Branches      3950     3950           
========================================
  Hits         32273    32273           
  Misses       11192    11192           
Components Coverage Δ
cvat-ui 78.53% <ø> (ø)
cvat-server 70.58% <ø> (ø)

The notifications queue is used very rarely (and not at all in the OSS
version), so it doesn't make sense to keep a dedicated worker just for it.
Combining the two workers in the utils container saves memory and startup
time.
Copy link

sonarcloud bot commented Nov 8, 2024

@azhavoro azhavoro merged commit ed33852 into cvat-ai:develop Nov 11, 2024
34 checks passed
@cvat-bot cvat-bot bot mentioned this pull request Nov 11, 2024
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.

3 participants