Update job queue documentation #2351
Merged
Conversation
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
| --collector_name "<name>" \ | ||
| --target <target> \ | ||
| --benchmark_set "<benchmark-set>" \ | ||
| --is_active |
Member
There was a problem hiding this comment.
Presumably this needs to be run with credentials - maybe on the instance itself?
Member
Author
There was a problem hiding this comment.
It doesn't need to be on the collector machine, but it needs access to the database where the collector will be stored, yeah.
Contributor
Jamesbarford
left a comment
Jamesbarford
left a comment
There was a problem hiding this comment.
Think the content is great, good work. I just wonder about how we structure the docs
Jamesbarford
approved these changes
Dec 11, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR unifies our documentation a little bit, and rewrites the job queue documentation to reflect the latest state, and remove duplicated things that were already documented in the glossary and the DB schema.
I'd like to request a review also from someone who hasn't interacted with the new system at all (e.g. @marcoieni or @Mark-Simulacrum), to see if it's comprehensible to other people (mainly the
job-queue.mddocument).