Uh oh!
There was an error while loading. Please reload this page.
feat(backend): add Bull Board metrics history - #1604
Merged
Conversation
This comment has been minimized.
This comment has been minimized.
Contributor
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
WalkthroughThe backend upgrades Bull Board, adds Redis-backed metrics history, configures BullMQ worker metric retention for one week, and updates API startup and shutdown ordering. ChangesMetrics integration
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant Server
participant Api
participant BullBoard
participant RedisMetricsHistory
participant BullMQMetricsRecorder
Server->>Api: initialize API server
Api->>BullBoard: register queue adapters and history provider
Api->>RedisMetricsHistory: configure Redis-backed history
Api->>BullMQMetricsRecorder: start recording
Server->>Api: dispose API
Api->>BullMQMetricsRecorder: stop recording
Api->>RedisMetricsHistory: disconnect history provider
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Caution CodeRabbit couldn't update its existing comment. The review summary may be out of date. Error details |
Contributor
License Audit
Weak Copyleft Packages (informational)
Resolved Packages (8)
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit f28ab2b. Configure here.
| bullBoardAdapter.setBasePath('/admin/queues'); | ||
| const queueAdapters = jobManager | ||
| .getQueues() | ||
| .map(queue => new BullMQAdapter(queue)); |
There was a problem hiding this comment.
Bull Board loses read-only mode
High Severity
BullMQAdapter instances are created without readOnlyMode: true, so /admin/queues becomes a writable Bull Board. The prior board blocked retries, cleans, pauses, and other mutations; this endpoint still has no auth middleware, so anyone who can reach the worker API can alter job queues. That conflicts with the PR’s “read-only Bull Board” intent.
Additional Locations (1)
Reviewed by Cursor Bugbot for commit f28ab2b. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Validation
yarn workspace @sourcebot/backend buildyarn workspace @sourcebot/backend test --runNote
Medium Risk
Major dependency upgrade (Bull Board 6→9, Express 5 for bull-board only) plus new Redis-backed metrics writers; shutdown order changed but scoped to observability and lifecycle.
Overview
Upgrades Bull Board from 6.11.2 to 9.0.0 and adds
@bull-board/metricsso the read-only/admin/queuesUI can show queue history and latency charts backed by Redis.The API wires a
RedisMetricsHistoryProviderandMetricsRecorder(shared Redis connection, latency errors logged per queue), starts recording at boot, and stops the recorder / disconnects the history provider on shutdown. Graceful shutdown now disposes the API before stopping workers and closing Redis.BullMQ workers retain one week of native metrics (
MetricsTime.ONE_WEEK/ 10,080 data points), with a unit test asserting that worker option.Reviewed by Cursor Bugbot for commit 375c1da. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
New Features
Bug Fixes