Skip to content

Add external payload transfer stats for workflow tasks #790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
simvlad wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add external payload transfer stats for workflow tasks #790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions temporal/api/common/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,3 +393,24 @@ message OnConflictOptions {
// Attaches the links to the running execution.
bool attach_links = 3;
}

// External payload transfer stats, broken down by storage driver.
message ExternalPayloadTransferStats {
Copy link
Copy Markdown
Contributor

@jmaeagle99 jmaeagle99 May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want latency/duration information for wall-clock upload/download? Might not be for metrics, but maybe for Web UI?

Copy link
Copy Markdown
Contributor Author

@simvlad simvlad Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same ^^

repeated StorageDriverStats drivers = 1;

message StorageDriverStats {
// Storage driver these stats are for. Matches `StorageDriverInfo.type`.
string driver_type = 1;
// Accumulated upload stats.
TransferStats uploaded = 2;
// Accumulated download stats.
TransferStats downloaded = 3;
}

message TransferStats {
Copy link
Copy Markdown
Contributor

@jmaeagle99 jmaeagle99 May 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want a latency/duration field for each driver type upload/download? Might not be for metrics, but maybe for Web UI?

Copy link
Copy Markdown
Contributor Author

@simvlad simvlad Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For others: we discussed, and decided to add later when necessary

// Number of payloads transferred
int64 total_count = 1;
// Total size of payloads transferred in bytes
int64 total_size_bytes = 2;
}
}
3 changes: 3 additions & 0 deletions temporal/api/workflowservice/v1/request_response.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,6 +420,9 @@ message RespondWorkflowTaskCompletedRequest {
// tasks (e.g. activity cancellation) to this specific worker instance.
string worker_control_task_queue = 20;

// External payload transfer stats accumulated for this task.
temporal.api.common.v1.ExternalPayloadTransferStats external_payload_transfer_stats = 21;

// SDK capability details.
message Capabilities {
// True if the SDK can handle speculative workflow task with command events. If true, the
Expand Down
Loading