work on comments

Author: ychebotarev

temporal/api/worker/v1/message.proto

@@ -12,6 +12,7 @@ option csharp_namespace = "Temporalio.Api.Worker.V1";
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "temporal/api/deployment/v1/message.proto";
 
 
 message WorkerTaskStatus {
@@ -29,31 +30,47 @@ message WorkerTaskStatus {
   float failure_rate_min = 8;
 }
 
+// Holds everything needed to identify the host/process context
+message WorkerHostInfo {
+  // worker host identifier, should be unique for the namespace.
+  string host_id = 1;
+
+  // worker process identifier, should be unique for the host.
+  string process_id = 2;
+
+  // freeform (e.g. "k8s container abc123", etc.)
+  string host_context = 3;
+
+  // Worker identity, set by the worker, may not be unique.
+  string worker_identity = 7;
+}
+
 message WorkerStatus {
-  string namespace_id = 1;
-  // Unique identifier for the namespace.
-  string worker_id = 2;
+  // Worker identifier, should be unique for the namespace. Required.
+  string worker_id = 1;
+
+  // Worker host information. Required.
+  WorkerHostInfo host_info = 2;
 
-  string host_id = 3;
-  string task_queue = 4;
-  string deployment_name = 5;
-  string build_id = 6;
-  string sdk_name = 7;
-  string sdk_version = 8;
+  // Task queue this worker is polling for tasks. Required.
+  string task_queue = 3;
 
-  string worker_identity = 9;
+  // Required.
+  temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 4;
 
-  int32 worker_status = 10;
-  google.protobuf.Duration uptime = 11;
+  string sdk_name = 6;
+  string sdk_version = 7;
 
-  google.protobuf.Timestamp last_heartbeat_time = 12;
+  google.protobuf.Duration uptime = 9;
+  google.protobuf.Timestamp last_heartbeat_time = 10;
 
-  WorkerTaskStatus workflow_task_status = 13;
-  WorkerTaskStatus activity_task_status = 14;
-  WorkerTaskStatus nexus_task_status = 15;
+  WorkerTaskStatus workflow_task_status = 11;
+  WorkerTaskStatus activity_task_status = 12;
+  WorkerTaskStatus nexus_task_status = 13;
 
-  float cpu_usage_percent = 16;
-  int64 memory_usage_bytes = 17;
-  float cache_hit_ratio = 18;
-  float cache_size = 19;
+  float cpu_usage_percent = 14;
+  int64 memory_usage_bytes = 15;
+  float cache_hit_ratio = 16;
+  float max_cache_size = 17;
+  float available_cache_size = 18;
 }

temporal/api/workflowservice/v1/request_response.proto

@@ -2328,7 +2328,7 @@ message TriggerWorkflowRuleResponse {
     // True is the rule was applied, based on the rule conditions (predicate/visibility_query).
     bool applied = 1;
 }
-message WorkerHeartbeatRequest {
+message RecordWorkerHeartbeatRequest {
     // Namespace of the workflow which scheduled this activity.
     string namespace = 1;
 
@@ -2338,18 +2338,31 @@ message WorkerHeartbeatRequest {
     temporal.api.worker.v1.WorkerStatus worker_status = 3;
 }
 
-message WorkerHeartbeatResponse {
+message RecordWorkerHeartbeatResponse {
 
 }
 
-message ListWorkerStatusRequest {
+// `query` in ListWorkers is used to filter workers based on worker status info.
+// The following worker status attributes are expected are supported as part of the query:
+//* WorkerId
+//* HostId
+//* TaskQueue
+//* DeploymentName
+//* BuildId
+//* SdkName
+//* SdkVersion
+//* Uptime
+//* LastHeartbeatTime
+//* Status
+// Currently metrics are not supported as a part of ListWorkers query.
+message ListWorkersRequest {
     string namespace = 1;
     int32 page_size = 2;
     bytes next_page_token = 3;
     string query = 4;
 }
 
-message ListWorkerStatusResponse {
+message ListWorkersResponse {
     repeated temporal.api.worker.v1.WorkerStatus worker_status = 1;
 
     // Next page token

temporal/api/workflowservice/v1/service.proto

@@ -1174,19 +1174,19 @@ service WorkflowService {
     }
 
     // WorkerHeartbeat receive heartbeat request from the worker.
-    rpc WorkerHeartbeat(WorkerHeartbeatRequest) returns (WorkerHeartbeatResponse) {
+    rpc RecordWorkerHeartbeat(RecordWorkerHeartbeatRequest) returns (RecordWorkerHeartbeatResponse) {
         option (google.api.http) = {
             post: "/namespaces/{namespace}/worker-heartbeat"
             body: "*"
             additional_bindings {
-                post: "/api/v1/namespaces/{namespace}/worker-heartbeat"
+                post: "/api/v1/namespaces/{namespace}/workers/heartbeat"
                 body: "*"
             }
         };
     };
 
-    // ListWorkerStatus is a visibility API to list worker status information in a specific namespace.
-    rpc ListWorkerStatus (ListWorkerStatusRequest) returns (ListWorkerStatusResponse) {
+    // ListWorkers is a visibility API to list worker status information in a specific namespace.
+    rpc ListWorkers (ListWorkersRequest) returns (ListWorkersResponse) {
         option (google.api.http) = {
             get: "/namespaces/{namespace}/workers"
             additional_bindings {