Skip to content

Commit 8759fbe

Browse files
feat: add worker runtime info to heartbeat
1 parent 2547d30 commit 8759fbe

3 files changed

Lines changed: 63 additions & 0 deletions

File tree

openapi/openapiv2.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15264,6 +15264,24 @@
1526415264
"default": "ROUTING_CONFIG_UPDATE_STATE_UNSPECIFIED",
1526515265
"description": "Indicates whether a change to the Routing Config has been\npropagated to all relevant Task Queues and their partitions.\n\n - ROUTING_CONFIG_UPDATE_STATE_IN_PROGRESS: Update to the RoutingConfig is currently in progress.\n - ROUTING_CONFIG_UPDATE_STATE_COMPLETED: Update to the RoutingConfig has completed successfully."
1526615266
},
15267+
"v1RuntimeInfo": {
15268+
"type": "object",
15269+
"properties": {
15270+
"name": {
15271+
"type": "string",
15272+
"title": "Runtime name"
15273+
},
15274+
"version": {
15275+
"type": "string",
15276+
"title": "Runtime version"
15277+
},
15278+
"provider": {
15279+
"type": "string",
15280+
"title": "Name of a known provider"
15281+
}
15282+
},
15283+
"description": "Information about the language runtime executing the worker."
15284+
},
1526715285
"v1Schedule": {
1526815286
"type": "object",
1526915287
"properties": {
@@ -16990,6 +17008,10 @@
1699017008
"$ref": "#/definitions/v1StorageDriverInfo"
1699117009
},
1699217010
"description": "Storage drivers in use by this SDK."
17011+
},
17012+
"runtimeInfo": {
17013+
"$ref": "#/definitions/v1RuntimeInfo",
17014+
"description": "Information about the language runtime executing the worker."
1699317015
}
1699417016
},
1699517017
"description": "Worker info message, contains information about the worker and its current state.\nAll information is provided by the worker itself."
@@ -17091,6 +17113,10 @@
1709117113
"$ref": "#/definitions/v1StorageDriverInfo"
1709217114
},
1709317115
"description": "Storage drivers in use by this SDK."
17116+
},
17117+
"runtimeInfo": {
17118+
"$ref": "#/definitions/v1RuntimeInfo",
17119+
"description": "Information about the language runtime executing the worker."
1709417120
}
1709517121
},
1709617122
"description": "Limited worker information returned in the list response.\nWhen adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information)."

openapi/openapiv3.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12792,6 +12792,19 @@ components:
1279212792
revisionNumber:
1279312793
type: string
1279412794
description: "Monotonically increasing value which is incremented on every mutation \n to any field of this message to achieve eventual consistency between task queues and their partitions."
12795+
RuntimeInfo:
12796+
type: object
12797+
properties:
12798+
name:
12799+
type: string
12800+
description: Runtime name
12801+
version:
12802+
type: string
12803+
description: Runtime version
12804+
provider:
12805+
type: string
12806+
description: Name of a known provider
12807+
description: Information about the language runtime executing the worker.
1279512808
Schedule:
1279612809
type: object
1279712810
properties:
@@ -15590,6 +15603,10 @@ components:
1559015603
items:
1559115604
$ref: '#/components/schemas/StorageDriverInfo'
1559215605
description: Storage drivers in use by this SDK.
15606+
runtimeInfo:
15607+
allOf:
15608+
- $ref: '#/components/schemas/RuntimeInfo'
15609+
description: Information about the language runtime executing the worker.
1559315610
description: |-
1559415611
Worker info message, contains information about the worker and its current state.
1559515612
All information is provided by the worker itself.
@@ -15692,6 +15709,10 @@ components:
1569215709
items:
1569315710
$ref: '#/components/schemas/StorageDriverInfo'
1569415711
description: Storage drivers in use by this SDK.
15712+
runtimeInfo:
15713+
allOf:
15714+
- $ref: '#/components/schemas/RuntimeInfo'
15715+
description: Information about the language runtime executing the worker.
1569515716
description: |-
1569615717
Limited worker information returned in the list response.
1569715718
When adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information).

temporal/api/worker/v1/message.proto

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,9 @@ message WorkerHeartbeat {
130130

131131
// Storage drivers in use by this SDK.
132132
repeated StorageDriverInfo drivers = 24;
133+
134+
// Information about the language runtime executing the worker.
135+
RuntimeInfo runtime_info = 25;
133136
}
134137

135138
// Detailed worker information.
@@ -180,6 +183,9 @@ message WorkerListInfo {
180183

181184
// Storage drivers in use by this SDK.
182185
repeated StorageDriverInfo drivers = 13;
186+
187+
// Information about the language runtime executing the worker.
188+
RuntimeInfo runtime_info = 14;
183189
}
184190

185191
message PluginInfo {
@@ -193,3 +199,13 @@ message StorageDriverInfo {
193199
// The type of the driver, required.
194200
string type = 1;
195201
}
202+
203+
// Information about the language runtime executing the worker.
204+
message RuntimeInfo {
205+
// Runtime name
206+
string name = 1;
207+
// Runtime version
208+
string version = 2;
209+
// Name of a known provider
210+
string provider = 3;
211+
}

0 commit comments

Comments
 (0)