Skip to content

Commit 50957d1

Browse files
authored
Add external payload stats to WorkflowExecutionInfo (#689)
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> Added external payload size and count to WorkflowExecutionInfo <!-- Tell your future self why have you made these changes --> We would like to show external payload stats for workflow execution. That's why we are adding it to WorkflowExecutionInfo, so that Temporal UI can call DescribeWorkflowExecution and use the result to show the total external payload size and count for the workflow execution. <!-- Are there any breaking changes on binary or code level? --> No <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> N/A
1 parent 04edb92 commit 50957d1

File tree

3 files changed

+22
-0
lines changed

3 files changed

+22
-0
lines changed

openapi/openapiv2.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17001,6 +17001,16 @@
1700117001
"priority": {
1700217002
"$ref": "#/definitions/v1Priority",
1700317003
"title": "Priority metadata"
17004+
},
17005+
"externalPayloadSizeBytes": {
17006+
"type": "string",
17007+
"format": "int64",
17008+
"description": "Total size in bytes of all external payloads referenced in workflow history."
17009+
},
17010+
"externalPayloadCount": {
17011+
"type": "string",
17012+
"format": "int64",
17013+
"description": "Count of external payloads referenced in workflow history."
1700417014
}
1700517015
},
1700617016
"description": "Hold basic information about a workflow execution.\nThis structure is a part of visibility, and thus contain a limited subset of information."

openapi/openapiv3.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14474,6 +14474,12 @@ components:
1447414474
allOf:
1447514475
- $ref: '#/components/schemas/Priority'
1447614476
description: Priority metadata
14477+
externalPayloadSizeBytes:
14478+
type: string
14479+
description: Total size in bytes of all external payloads referenced in workflow history.
14480+
externalPayloadCount:
14481+
type: string
14482+
description: Count of external payloads referenced in workflow history.
1447714483
description: |-
1447814484
Hold basic information about a workflow execution.
1447914485
This structure is a part of visibility, and thus contain a limited subset of information.

temporal/api/workflow/v1/message.proto

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,12 @@ message WorkflowExecutionInfo {
9898

9999
// Priority metadata
100100
temporal.api.common.v1.Priority priority = 24;
101+
102+
// Total size in bytes of all external payloads referenced in workflow history.
103+
int64 external_payload_size_bytes = 25;
104+
105+
// Count of external payloads referenced in workflow history.
106+
int64 external_payload_count = 26;
101107
}
102108

103109
// Holds all the extra information about workflow execution that is not part of Visibility.

0 commit comments

Comments
 (0)