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

Reduced JobQueueManager polling logs #22154

Merged
merged 2 commits into from
Feb 10, 2025

Conversation

cmraible
Copy link
Collaborator

@cmraible cmraible commented Feb 10, 2025

ref https://linear.app/ghost/issue/ENG-1989/disable-jobqueuemanager-logging-in-zuul

  • The JobQueueManager creates a lot of logs that were used while validating that it's working as expected.
  • This commit demotes these logs to the debug log level, which should reduce the noise in these logs, while still making them easy to re-enable if needed.

Copy link
Contributor

coderabbitai bot commented Feb 10, 2025

Walkthrough

The changes primarily update the logging functionality in the JobQueueManager class. A new debug method has been introduced to log messages when the logLevel is set to "debug". The conditions for logging within the existing info and error methods have been expanded: info now logs if the logLevel is "info" or "debug", and error logs when the logLevel is "info", "error", or "debug". Additionally, logging calls in the startQueueProcessor and processPendingJobs methods have been switched from info to debug, refining the control over log output visibility based on the configured log level.

Suggested reviewers

  • daniellockyer

Poem

I'm a rabbit with a hop so spry,
Tweaking logs as the code flies by.
Debug messages now take the stage,
Info and error join the page.
With tweaks so clever, watch me leap,
Bugs get chased like carrots in a heap!
🥕🐇 Happy coding in the deep!


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ac5150e and c693545.

📒 Files selected for processing (1)
  • ghost/job-manager/test/job-queue-manager.test.js (2 hunks)
🔇 Additional comments (3)
ghost/job-manager/test/job-queue-manager.test.js (3)

20-24: LGTM! Comprehensive logger mock setup.

The mockLogger setup correctly includes all required logging methods (debug, info, error) using sinon stubs, which aligns with the PR's objective of switching to debug level logging.


149-157: LGTM! Well-structured test for debug level logging.

The test thoroughly verifies that when debug level is set:

  • debug messages are logged
  • info messages are logged
  • error messages are logged

This aligns with the expected behavior where debug is the most verbose level.


159-167: LGTM! Comprehensive verification of info level logging.

The test correctly verifies that with info level:

  • debug messages are not logged
  • info messages are logged
  • error messages are logged

This ensures proper log level filtering.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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.

@cmraible cmraible marked this pull request as ready for review February 10, 2025 21:58
@cmraible cmraible changed the title Switched JobQueueManager polling logs to debug log level Reduced JobQueueManager polling logs Feb 10, 2025
@cmraible cmraible enabled auto-merge (squash) February 10, 2025 22:08
@cmraible cmraible merged commit 9e0523f into TryGhost:main Feb 10, 2025
25 checks passed
@cmraible cmraible deleted the email-analytics-logging branch February 10, 2025 22:12
cmraible added a commit that referenced this pull request Feb 11, 2025
ref
https://linear.app/ghost/issue/ENG-1989/disable-jobqueuemanager-logging-in-zuul

- The `JobQueueManager` generates a lot of logs that are useful for debugging, but they were all at log level `info`.
- This commit demotes these logs to the `debug` log level, which should
reduce the noise while making them easy to
re-enable if needed.
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