Skip to content

Commit 21376f0

Browse files
02strich02strich
committed
Merge remote-tracking branch 'origin/master' into serverless
* origin/master: Add poller autoscaling namespace capability (#723) Add request header annotation and resource-id fields (#728) Trampolining: addition of fields to remove the infinite loops for pinned wfs (#721) Add WorkerListInfo proto for efficient worker listing (#724) Add storage driver info to worker heartbeats (#722)
2 parents cb91e15 + db5f593 commit 21376f0

8 files changed

Lines changed: 678 additions & 18 deletions

File tree

‎openapi/openapiv2.json‎

Lines changed: 156 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2780,7 +2780,7 @@
27802780
},
27812781
{
27822782
"name": "query",
2783-
"description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
2783+
"description": "`query` in ListWorkers is used to filter workers based on worker attributes.\nSupported attributes:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* Status",
27842784
"in": "query",
27852785
"required": false,
27862786
"type": "string"
@@ -7325,7 +7325,7 @@
73257325
},
73267326
{
73277327
"name": "query",
7328-
"description": "`query` in ListWorkers is used to filter workers based on worker status info.\nThe following worker status attributes are expected are supported as part of the query:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
7328+
"description": "`query` in ListWorkers is used to filter workers based on worker attributes.\nSupported attributes:\n* WorkerInstanceKey\n* WorkerIdentity\n* HostName\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* StartTime\n* Status",
73297329
"in": "query",
73307330
"required": false,
73317331
"type": "string"
@@ -9291,6 +9291,10 @@
92919291
"selector": {
92929292
"$ref": "#/definitions/v1WorkerSelector",
92939293
"description": "Defines which workers should receive this command.\nonly single worker is supported at this time."
9294+
},
9295+
"resourceId": {
9296+
"type": "string",
9297+
"description": "Resource ID for routing. Contains the worker grouping key."
92949298
}
92959299
}
92969300
},
@@ -9404,6 +9408,10 @@
94049408
"identity": {
94059409
"type": "string",
94069410
"title": "The identity of the worker/client"
9411+
},
9412+
"resourceId": {
9413+
"type": "string",
9414+
"description": "Resource ID for routing. Contains the workflow ID or activity ID for standalone activities."
94079415
}
94089416
}
94099417
},
@@ -9421,6 +9429,10 @@
94219429
"identity": {
94229430
"type": "string",
94239431
"title": "The identity of the worker/client"
9432+
},
9433+
"resourceId": {
9434+
"type": "string",
9435+
"description": "Resource ID for routing. Contains \"workflow:workflow_id\" or \"activity:activity_id\" for standalone activities."
94249436
}
94259437
}
94269438
},
@@ -9437,6 +9449,10 @@
94379449
"type": "object",
94389450
"$ref": "#/definitions/v1WorkerHeartbeat"
94399451
}
9452+
},
9453+
"resourceId": {
9454+
"type": "string",
9455+
"description": "Resource ID for routing. Contains the worker grouping key."
94409456
}
94419457
}
94429458
},
@@ -9606,6 +9622,10 @@
96069622
"type": "string",
96079623
"title": "The identity of the worker/client"
96089624
},
9625+
"resourceId": {
9626+
"type": "string",
9627+
"description": "Resource ID for routing. Contains the workflow ID or activity ID for standalone activities."
9628+
},
96099629
"workerVersion": {
96109630
"$ref": "#/definitions/v1WorkerVersionStamp",
96119631
"description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment_options` instead."
@@ -9638,6 +9658,10 @@
96389658
"deploymentOptions": {
96399659
"$ref": "#/definitions/v1WorkerDeploymentOptions",
96409660
"description": "Worker deployment options that user has set in the worker."
9661+
},
9662+
"resourceId": {
9663+
"type": "string",
9664+
"description": "Resource ID for routing. Contains \"workflow:workflow_id\" or \"activity:activity_id\" for standalone activities."
96419665
}
96429666
}
96439667
},
@@ -9657,6 +9681,10 @@
96579681
"type": "string",
96589682
"title": "The identity of the worker/client"
96599683
},
9684+
"resourceId": {
9685+
"type": "string",
9686+
"description": "Resource ID for routing. Contains the workflow ID or activity ID for standalone activities."
9687+
},
96609688
"workerVersion": {
96619689
"$ref": "#/definitions/v1WorkerVersionStamp",
96629690
"description": "Version info of the worker who processed this task. This message's `build_id` field should\nalways be set by SDKs. Workers opting into versioning will also set the `use_versioning`\nfield to true. See message docstrings for more.\nDeprecated. Use `deployment_options` instead."
@@ -9685,6 +9713,10 @@
96859713
"identity": {
96869714
"type": "string",
96879715
"title": "The identity of the worker/client"
9716+
},
9717+
"resourceId": {
9718+
"type": "string",
9719+
"description": "Resource ID for routing. Contains \"workflow:workflow_id\" or \"activity:activity_id\" for standalone activities."
96889720
}
96899721
}
96909722
},
@@ -9704,6 +9736,10 @@
97049736
"type": "string",
97059737
"title": "The identity of the worker/client"
97069738
},
9739+
"resourceId": {
9740+
"type": "string",
9741+
"description": "Resource ID for routing. Contains the workflow ID or activity ID for standalone activities."
9742+
},
97079743
"lastHeartbeatDetails": {
97089744
"$ref": "#/definitions/v1Payloads",
97099745
"title": "Additional details to be stored as last activity heartbeat"
@@ -9740,6 +9776,10 @@
97409776
"lastHeartbeatDetails": {
97419777
"$ref": "#/definitions/v1Payloads",
97429778
"title": "Additional details to be stored as last activity heartbeat"
9779+
},
9780+
"resourceId": {
9781+
"type": "string",
9782+
"description": "Resource ID for routing. Contains \"workflow:workflow_id\" or \"activity:activity_id\" for standalone activities."
97439783
}
97449784
}
97459785
},
@@ -10524,6 +10564,10 @@
1052410564
"selector": {
1052510565
"$ref": "#/definitions/v1WorkerSelector",
1052610566
"description": "Defines which workers should receive this command."
10567+
},
10568+
"resourceId": {
10569+
"type": "string",
10570+
"description": "Resource ID for routing. Contains the worker grouping key."
1052710571
}
1052810572
}
1052910573
},
@@ -12210,6 +12254,15 @@
1221012254
}
1221112255
}
1221212256
},
12257+
"v1DeclinedTargetVersionUpgrade": {
12258+
"type": "object",
12259+
"properties": {
12260+
"deploymentVersion": {
12261+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
12262+
}
12263+
},
12264+
"description": "Wrapper for a target deployment version that the SDK declined to upgrade to.\nSee declined_target_version_upgrade on WorkflowExecutionStartedEventAttributes."
12265+
},
1221312266
"v1DeleteNexusEndpointResponse": {
1221412267
"type": "object"
1221512268
},
@@ -13599,7 +13652,16 @@
1359913652
"items": {
1360013653
"type": "object",
1360113654
"$ref": "#/definitions/v1WorkerInfo"
13602-
}
13655+
},
13656+
"description": "Deprecated: Use workers instead. This field returns full WorkerInfo which\nincludes expensive runtime metrics. We will stop populating this field in the future."
13657+
},
13658+
"workers": {
13659+
"type": "array",
13660+
"items": {
13661+
"type": "object",
13662+
"$ref": "#/definitions/v1WorkerListInfo"
13663+
},
13664+
"description": "Limited worker information."
1360313665
},
1360413666
"nextPageToken": {
1360513667
"type": "string",
@@ -13844,6 +13906,10 @@
1384413906
"workerPollCompleteOnShutdown": {
1384513907
"type": "boolean",
1384613908
"description": "True if the namespace supports server-side completion of outstanding worker polls on shutdown.\nWhen enabled, the server will complete polls for workers that send WorkerInstanceKey in their\npoll requests and call ShutdownWorker with the same WorkerInstanceKey. The poll will return\nan empty response. When this flag is true, workers should allow polls to return gracefully\nrather than terminating any open polls on shutdown."
13909+
},
13910+
"pollerAutoscaling": {
13911+
"type": "boolean",
13912+
"title": "True if the namespace supports poller autoscaling"
1384713913
}
1384813914
},
1384913915
"description": "Namespace capability details. Should contain what features are enabled in a namespace."
@@ -16034,6 +16100,15 @@
1603416100
"v1StopBatchOperationResponse": {
1603516101
"type": "object"
1603616102
},
16103+
"v1StorageDriverInfo": {
16104+
"type": "object",
16105+
"properties": {
16106+
"type": {
16107+
"type": "string",
16108+
"description": "The type of the driver, required."
16109+
}
16110+
}
16111+
},
1603716112
"v1StructuredCalendarSpec": {
1603816113
"type": "object",
1603916114
"properties": {
@@ -17063,6 +17138,14 @@
1706317138
"$ref": "#/definitions/v1PluginInfo"
1706417139
},
1706517140
"description": "Plugins currently in use by this SDK."
17141+
},
17142+
"drivers": {
17143+
"type": "array",
17144+
"items": {
17145+
"type": "object",
17146+
"$ref": "#/definitions/v1StorageDriverInfo"
17147+
},
17148+
"description": "Storage drivers in use by this SDK."
1706617149
}
1706717150
},
1706817151
"description": "Worker info message, contains information about the worker and its current state.\nAll information is provided by the worker itself."
@@ -17101,7 +17184,72 @@
1710117184
"workerHeartbeat": {
1710217185
"$ref": "#/definitions/v1WorkerHeartbeat"
1710317186
}
17104-
}
17187+
},
17188+
"description": "Detailed worker information."
17189+
},
17190+
"v1WorkerListInfo": {
17191+
"type": "object",
17192+
"properties": {
17193+
"workerInstanceKey": {
17194+
"type": "string",
17195+
"description": "Worker identifier, should be unique for the namespace.\nIt is distinct from worker identity, which is not necessarily namespace-unique."
17196+
},
17197+
"workerIdentity": {
17198+
"type": "string",
17199+
"description": "Worker identity, set by the client, may not be unique.\nUsually host_name+(user group name)+process_id, but can be overwritten by the user."
17200+
},
17201+
"taskQueue": {
17202+
"type": "string",
17203+
"description": "Task queue this worker is polling for tasks."
17204+
},
17205+
"deploymentVersion": {
17206+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
17207+
},
17208+
"sdkName": {
17209+
"type": "string"
17210+
},
17211+
"sdkVersion": {
17212+
"type": "string"
17213+
},
17214+
"status": {
17215+
"$ref": "#/definitions/v1WorkerStatus",
17216+
"description": "Worker status. Defined by SDK."
17217+
},
17218+
"startTime": {
17219+
"type": "string",
17220+
"format": "date-time",
17221+
"title": "Worker start time.\nIt can be used to determine worker uptime. (current time - start time)"
17222+
},
17223+
"hostName": {
17224+
"type": "string",
17225+
"description": "Worker host identifier."
17226+
},
17227+
"workerGroupingKey": {
17228+
"type": "string",
17229+
"title": "Worker grouping identifier. A key to group workers that share the same client+namespace+process.\nThis will be used to build the worker command nexus task queue name:\n\"temporal-sys/worker-commands/{worker_grouping_key}\""
17230+
},
17231+
"processId": {
17232+
"type": "string",
17233+
"description": "Worker process identifier. This id only needs to be unique\nwithin one host (so using e.g. a unix pid would be appropriate)."
17234+
},
17235+
"plugins": {
17236+
"type": "array",
17237+
"items": {
17238+
"type": "object",
17239+
"$ref": "#/definitions/v1PluginInfo"
17240+
},
17241+
"description": "Plugins currently in use by this SDK."
17242+
},
17243+
"drivers": {
17244+
"type": "array",
17245+
"items": {
17246+
"type": "object",
17247+
"$ref": "#/definitions/v1StorageDriverInfo"
17248+
},
17249+
"description": "Storage drivers in use by this SDK."
17250+
}
17251+
},
17252+
"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)."
1710517253
},
1710617254
"v1WorkerPollerInfo": {
1710717255
"type": "object",
@@ -17802,6 +17950,10 @@
1780217950
"eagerExecutionAccepted": {
1780317951
"type": "boolean",
1780417952
"description": "A boolean indicating whether the SDK has asked to eagerly execute the first workflow task for this workflow and\neager execution was accepted by the server.\nOnly populated by server with version >= 1.29.0."
17953+
},
17954+
"declinedTargetVersionUpgrade": {
17955+
"$ref": "#/definitions/v1DeclinedTargetVersionUpgrade",
17956+
"description": "During a previous run of this workflow, the server may have notified the SDK\nthat the Target Worker Deployment Version changed, but the SDK declined to\nupgrade (e.g., by continuing-as-new with PINNED behavior). This field records\nthe target version that was declined.\n\nThis is a wrapper message to distinguish \"never declined\" (nil wrapper) from\n\"declined an unversioned target\" (non-nil wrapper with nil deployment_version).\n\nUsed internally by the server during continue-as-new and retry.\nShould not be read or interpreted by SDKs."
1780517957
}
1780617958
},
1780717959
"title": "Always the first event in workflow history"

0 commit comments

Comments
 (0)