Skip to content

Fix webhooks worker not restarting #8921

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

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Jan 9, 2025

Motivation and context

rq exits with a 0 status if its Redis connection times out, which means that supervisord will not restart it by default. Set autorestart=true, like for all other workers.

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

  • Bug Fixes
    • Improved webhook worker reliability by enabling automatic restart when connection issues occur
    • Configured worker to automatically recover from unexpected failures without manual intervention

@SpecLad SpecLad requested a review from azhavoro as a code owner January 9, 2025 17:51
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

A fix has been implemented to improve the reliability of the webhook worker by ensuring it can automatically restart after losing the Redis connection. The change involves modifying the Supervisord configuration for the webhook worker to enable automatic restarts, which prevents potential service disruptions and enhances the worker's resilience.

Changes

File Change Summary
supervisord/worker.webhooks.conf Added autorestart=true to the [program:rqworker-webhooks] section to enable automatic worker restart on failure
changelog.d/20250109_195116_roman_restart_webhooks.md Documented the webhook worker restart fix

Poem

🐰 Webhooks dancing, Redis connection lost,
But fear not, for restart is now the boss!
Supervisord watches with a knowing grin,
Resilience leaps, the worker will spin again
Hop, hop, hooray for auto-restart's might! 🔄

Finishing Touches

  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@SpecLad SpecLad requested a review from nmanovic as a code owner January 9, 2025 17:52
Copy link

sonarqubecloud bot commented Jan 9, 2025

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

🧹 Nitpick comments (1)
changelog.d/20250109_195116_roman_restart_webhooks.md (1)

3-3: Enhance changelog entry with implementation details.

The current entry is good but could be more specific about the solution implemented.

Consider this enhanced description:

-Fixed webhook worker not restarting after losing Redis connection
+Fixed webhook worker not restarting after losing Redis connection by enabling automatic restart in supervisord configuration
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f8f40e2 and f16e893.

📒 Files selected for processing (2)
  • changelog.d/20250109_195116_roman_restart_webhooks.md (1 hunks)
  • supervisord/worker.webhooks.conf (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build
  • GitHub Check: generate_github_pages
  • GitHub Check: testing
  • GitHub Check: Linter
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
supervisord/worker.webhooks.conf (1)

26-26: LGTM! Verify consistency with other workers.

The autorestart=true configuration is correctly placed and will ensure the webhooks worker restarts automatically on exit.

Let's verify if this configuration is consistent with other workers:

Additionally, consider adding monitoring to track restart frequency:

 [program:rqworker-webhooks]
 command=%(ENV_HOME)s/wait_for_deps.sh
     python3 %(ENV_HOME)s/manage.py rqworker -v 3 webhooks
         --worker-class cvat.rqworker.DefaultWorker
 environment=VECTOR_EVENT_HANDLER="SynchronousLogstashHandler",CVAT_POSTGRES_APPLICATION_NAME="cvat:worker:webhooks"
 numprocs=%(ENV_NUMPROCS)s
 process_name=%(program_name)s-%(process_num)d
 autorestart=true
+stdout_logfile=%(ENV_HOME)s/logs/%(program_name)s-%(process_num)d.log
+stdout_logfile_maxbytes=50MB
+stdout_logfile_backups=10
✅ Verification successful

Configuration is consistent with other workers

The autorestart=true setting is already present in other worker configurations, making this change to the webhooks worker consistent with the existing pattern.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check autorestart configuration in other worker configs
rg -A 1 "program:.*worker" supervisord/ | rg -A 1 "autorestart"

Length of output: 63


Script:

#!/bin/bash
# First, find all supervisord config files
echo "=== Supervisord config files ==="
fd -e conf -e ini . supervisord/

echo -e "\n=== Worker configurations ==="
# Search for program sections containing 'worker' and show surrounding context
fd -e conf -e ini . supervisord/ -x cat {} | grep -A 5 -B 1 "\[program:.*worker.*\]"

Length of output: 3183


Script:

#!/bin/bash
# Check complete content of a few worker configs
echo "=== worker.annotation.conf ==="
cat supervisord/worker.annotation.conf

echo -e "\n=== worker.export.conf ==="
cat supervisord/worker.export.conf

echo -e "\n=== worker.import.conf ==="
cat supervisord/worker.import.conf

Length of output: 3642

@SpecLad SpecLad merged commit 43cc1f3 into cvat-ai:develop Jan 10, 2025
35 checks passed
@SpecLad SpecLad deleted the restart-webhooks branch January 10, 2025 10:01
@cvat-bot cvat-bot bot mentioned this pull request Jan 27, 2025
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.

1 participant