Repository navigation
docs: add a dedicated page for the local queue options - #649
Open
Krrishkumar125 wants to merge 1 commit into
Open
Krrishkumar125 wants to merge 1 commit into
Krrishkumar125 wants to merge 1 commit into
Conversation
Documents size, ttl and refetchDelay (durationMs, threshold, maxAbortThreshold) with their defaults, the tradeoffs of enabling the local queue, and the events it emits. Links to it from the config and performance pages. Fixes graphile#585
This branch has not been deployed
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #585.
The local queue options were only described on the performance page and briefly in the config reference, so this adds a
Local queuepage covering:size,ttlandrefetchDelay(durationMs,threshold,maxAbortThreshold), with defaults taken fromsrc/localQueue.ts/src/main.ts(e.g. the 0.5–1.5× jitter ondurationMs, thedurationMs <= pollIntervalcheck, the5 * sizeabort default, and the warning whensize < concurrentJobs)localQueue:*events for monitoringThe config and performance pages now link to it. Docs only;
prettier --checkpasses.One thing I noticed while reading the source: the class comment in
localQueue.tssays WAITING mode lasts at mostgetJobBatchTime(30 minutes), but the code useslocalQueue.ttl(default 5 minutes). I documented the code's behaviour. Happy to update that comment here too if you'd like.