Download Stats

Author: simvlad

temporal/api/history/v1/message.proto

@@ -22,6 +22,7 @@ import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
 import "temporal/api/update/v1/message.proto";
 import "temporal/api/workflow/v1/message.proto";
+import "temporal/api/sdk/v1/external_payload_download_stats.proto";
 import "temporal/api/sdk/v1/task_complete_metadata.proto";
 import "temporal/api/sdk/v1/user_metadata.proto";
 
@@ -330,6 +331,8 @@ message WorkflowTaskCompletedEventAttributes {
     // is set. This value updates workflow execution's `versioning_info.deployment_version`.
     // Experimental. Worker Deployments are experimental and might significantly change in the future.
     temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 11;
+    // Stats about external payloads downloaded by SDK.
+    temporal.api.sdk.v1.ExternalPayloadDownloadStats external_payload_stats = 12;
 }
 
 message WorkflowTaskTimedOutEventAttributes {
@@ -366,6 +369,8 @@ message WorkflowTaskFailedEventAttributes {
     // populated to preserve compatibility).
     // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     temporal.api.common.v1.WorkerVersionStamp worker_version = 10 [deprecated = true];
+    // Stats about external payloads downloaded by SDK.
+    temporal.api.sdk.v1.ExternalPayloadDownloadStats external_payload_stats = 11;
 }
 
 message ActivityTaskScheduledEventAttributes {

temporal/api/sdk/v1/external_payload_download_stats.proto

@@ -0,0 +1,28 @@
+syntax = "proto3";
+
+package temporal.api.sdk.v1;
+
+option go_package = "go.temporal.io/api/sdk/v1;sdk";
+option java_package = "io.temporal.api.sdk.v1";
+option java_multiple_files = true;
+option java_outer_classname = "ExternalPayloadDownloadStatsProto";
+option ruby_package = "Temporalio::Api::Sdk::V1";
+option csharp_namespace = "Temporalio.Api.Sdk.V1";
+
+import "google/protobuf/timestamp.proto";
+
+// Stats about external payloads downloaded by SDK during workflow task processing.
+message ExternalPayloadDownloadStats {
+  // Number of external payloads downloaded.
+  int64 payload_count = 1;
+
+  // Total size in bytes of downloaded payloads.
+  int64 total_size_bytes = 2;
+
+  // Wall time spent downloading.
+  google.protobuf.Timestamp download_time = 3;
+
+  // True if any portion of this workflow task processed history in replay mode
+  // (i.e., SDK had to rebuild state) and downloaded payloads during that period.
+  bool replay_involved = 4;
+}

temporal/api/workflowservice/v1/request_response.proto

@@ -38,6 +38,7 @@ import "temporal/api/taskqueue/v1/message.proto";
 import "temporal/api/update/v1/message.proto";
 import "temporal/api/version/v1/message.proto";
 import "temporal/api/batch/v1/message.proto";
+import "temporal/api/sdk/v1/external_payload_download_stats.proto";
 import "temporal/api/sdk/v1/task_complete_metadata.proto";
 import "temporal/api/sdk/v1/user_metadata.proto";
 import "temporal/api/nexus/v1/message.proto";
@@ -372,6 +373,8 @@ message RespondWorkflowTaskCompletedRequest {
     temporal.api.enums.v1.VersioningBehavior versioning_behavior = 16;
     // Worker deployment options that user has set in the worker.
     temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 17;
+    // Stats about external payloads downloaded by SDK.
+    temporal.api.sdk.v1.ExternalPayloadDownloadStats external_payload_stats = 18;
 
     // SDK capability details.
     message Capabilities {
@@ -423,6 +426,8 @@ message RespondWorkflowTaskFailedRequest {
     temporal.api.deployment.v1.Deployment deployment = 9 [deprecated = true];
     // Worker deployment options that user has set in the worker.
     temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 10;
+    // Stats about external payloads downloaded by SDK.
+    temporal.api.sdk.v1.ExternalPayloadDownloadStats external_payload_stats = 11;
 }
 
 message RespondWorkflowTaskFailedResponse {