Document known accuracy limitations for ApproximateBacklogCount#4392
Open
dustin-temporal wants to merge 5 commits intomainfrom
Open
Document known accuracy limitations for ApproximateBacklogCount#4392dustin-temporal wants to merge 5 commits intomainfrom
dustin-temporal wants to merge 5 commits intomainfrom
Conversation
Adds a section explaining two known scenarios where the backlog count can be temporarily inaccurate: overcount from cancelled workflows and reset to zero on partition unload after ~5 minutes of inactivity. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📖 Docs PR preview links
|
ShahabT
reviewed
Apr 7, 2026
dnr
reviewed
Apr 8, 2026
carlydf
reviewed
Apr 20, 2026
- Use "invalid or expired Tasks" consistently; expand to cover cancelled, terminated, completed, and timed-out Workflows/Activities (per ShahabT, dnr). - Reverse the blocking explanation: a valid Task at the head can hold up invalid Tasks behind it; an invalid Task at the head is removed quickly (per ShahabT). - Drop "partition" terminology; reframe as Task Queue unload (per ShahabT). - Note that DescribeTaskQueue, UpdateTaskQueueConfig, and other Task Queue calls also keep the Task Queue loaded (per ShahabT, carlydf). - Replace "haven't yet expired" with "until they are processed and discarded" (per dnr). - Soften "may be temporarily inaccurate" and remove "converges to the correct value"; call out persistent sources of discrepancy such as metadata update lag and database row expirations (per dnr). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Contributor
Author
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
4 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.
Summary
ApproximateBacklogCountcan be temporarily inaccurate:temporal_cloud_v1_approximate_backlog_count)Context
These limitations were identified during internal discussion with the matching team (Shahab, Nish). Both behaviors are explainable and expected, but not currently documented - leading to customer confusion.
Test plan
#backlog-accuracy-limitationsworks from the Cloud metrics reference page:::noteadmonition in the metrics reference🤖 Generated with Claude Code
┆Attachments: EDU-6164 Document known accuracy limitations for ApproximateBacklogCount