Skip to content

Add process key, make heartbeats repeatable field #608

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

Merged
merged 3 commits into from
Jul 7, 2025
Merged

Add process key, make heartbeats repeatable field #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f2dbd7
Add process key, make heartbeats repeatable field
ychebotarev Jul 7, 2025
e5dcf30
add repeated directly to the field, disable buf check
ychebotarev Jul 7, 2025
c4c8850
work on comments
ychebotarev Jul 7, 2025
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
4 changes: 2 additions & 2 deletions buf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ breaking:
- WIRE_JSON
ignore:
- google
# TODO (yuri) remove this
- temporal/api/workflow/v1/message.proto
# TODO (yuri) remove this. Added for "heartbeat" change (add
- temporal/api/workflowservice/v1/request_response.proto
lint:
use:
- DEFAULT
Expand Down
12 changes: 10 additions & 2 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7606,7 +7606,11 @@
"description": "The identity of the client who initiated this request."
},
"workerHeartbeat": {
"$ref": "#/definitions/v1WorkerHeartbeat"
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/v1WorkerHeartbeat"
}
}
}
},
Expand Down Expand Up @@ -15410,9 +15414,13 @@
"type": "string",
"description": "Worker host identifier."
},
"processKey": {
"type": "string",
"title": "Worker process identifier. This id should be unique for all _processes_\nrunning workers in the namespace, and should be shared by all workers\nin the same process.\nThis will be used to build the worker command nexus task queue name:\n\"temporal-sys/worker-commands/{process_key}\""
},
"processId": {
"type": "string",
"description": "Worker process identifier, should be unique for the host."
"description": "Worker process identifier. Unlike process_key, this id only needs to be unique\nwithin one host (so using e.g. a unix pid would be appropriate)."
},
"currentHostCpuUsage": {
"type": "number",
Expand Down
16 changes: 14 additions & 2 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9723,7 +9723,9 @@ components:
type: string
description: The identity of the client who initiated this request.
workerHeartbeat:
$ref: '#/components/schemas/WorkerHeartbeat'
type: array
items:
$ref: '#/components/schemas/WorkerHeartbeat'
RecordWorkerHeartbeatResponse:
type: object
properties: {}
Expand Down Expand Up @@ -12797,9 +12799,19 @@ components:
hostName:
type: string
description: Worker host identifier.
processKey:
type: string
description: |-
Worker process identifier. This id should be unique for all _processes_
running workers in the namespace, and should be shared by all workers
in the same process.
This will be used to build the worker command nexus task queue name:
"temporal-sys/worker-commands/{process_key}"
processId:
type: string
description: Worker process identifier, should be unique for the host.
description: |-
Worker process identifier. Unlike process_key, this id only needs to be unique
within one host (so using e.g. a unix pid would be appropriate).
currentHostCpuUsage:
type: number
description: |-
Expand Down
12 changes: 10 additions & 2 deletions temporal/api/worker/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,16 @@ message WorkerHostInfo {
// Worker host identifier.
string host_name = 1;

// Worker process identifier, should be unique for the host.

// Worker process identifier. This id should be unique for all _processes_
// running workers in the namespace, and should be shared by all workers
// in the same process.
// This will be used to build the worker command nexus task queue name:
// "temporal-sys/worker-commands/{process_key}"
string process_key = 5;

// Worker process identifier. Unlike process_key, this id only needs to be unique
// within one host (so using e.g. a unix pid would be appropriate).
string process_id = 2;

// System used CPU as a float in the range [0.0, 1.0] where 1.0 is defined as all
Expand All @@ -78,7 +87,6 @@ message WorkerHeartbeat {
// Usually host_name+(user group name)+process_id, but can be overwritten by the user.
string worker_identity = 2;


// Worker host information.
WorkerHostInfo host_info = 3;

Expand Down
4 changes: 2 additions & 2 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 @@ -1772,7 +1772,7 @@ message PollNexusTaskQueueRequest {
temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 6;

// Worker info to be sent to the server.
temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 7;
repeated temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 7;
}

message PollNexusTaskQueueResponse {
Expand Down Expand Up @@ -2384,7 +2384,7 @@ message RecordWorkerHeartbeatRequest {
// The identity of the client who initiated this request.
string identity = 2;

temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 3;
repeated temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 3;
}

message RecordWorkerHeartbeatResponse {
Expand Down
Loading