Add external payload stats to WorkflowTaskStartedEvent and DescribeWorkflowExecution #8800
+242
−47
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
simvlad
changed the base branch from
main
to
simvlad/payload-size-stats-for-workflow-execution
simvlad
commented
Dec 11, 2025
| modernc.org/mathutil v1.7.1 // indirect | ||
| modernc.org/memory v1.11.0 // indirect | ||
| ) | ||
|
|
Contributor
Author
There was a problem hiding this comment.
The API change is not released yet. Will remove this before merging this PR.
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.
What changed?
Added external payload stats (size and count) to WorkflowTaskStartedEvent and DescribeWorkflowExecution. Also change and add functional tests. This PR depends on Server PR #8775 and API PR temporalio/api#689.
Why?
We'd like to surface the external payload stats when DescribeWorkflowExecution is called to see how many and what size of external payloads the workflow is referencing. Numbers are coming from the workflow mutable state. This is similar to how the HistorySize is kept. We also would like to surface the intermediate stats for workflow tasks, so that the users can debug the tasks which contribute most to the total external payload size.
How did you test it?
Potential risks
Any change is risky. Identify all risks you are aware of. If none, remove this section.