Skip to content

Commit 39ab960

Browse files
ychebotarevychebotarev
committed
work on comments
1 parent b0b0f37 commit 39ab960

4 files changed

Lines changed: 280 additions & 147 deletions

File tree

‎openapi/openapiv2.json‎

Lines changed: 89 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2225,6 +2225,7 @@
22252225
},
22262226
{
22272227
"name": "query",
2228+
"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* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* Uptime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
22282229
"in": "query",
22292230
"required": false,
22302231
"type": "string"
@@ -5865,6 +5866,7 @@
58655866
},
58665867
{
58675868
"name": "query",
5869+
"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* WorkerId\n* WorkerIdentity\n* HostId\n* TaskQueue\n* DeploymentName\n* BuildId\n* SdkName\n* SdkVersion\n* Uptime\n* LastHeartbeatTime\n* Status\nCurrently metrics are not supported as a part of ListWorkers query.",
58685870
"in": "query",
58695871
"required": false,
58705872
"type": "string"
@@ -7574,8 +7576,8 @@
75747576
"type": "string",
75757577
"description": "The identity of the client who initiated this request."
75767578
},
7577-
"workerStatus": {
7578-
"$ref": "#/definitions/v1WorkerStatus"
7579+
"workerInfo": {
7580+
"$ref": "#/definitions/v1WorkerInfo"
75797581
}
75807582
}
75817583
},
@@ -11364,11 +11366,11 @@
1136411366
"v1ListWorkersResponse": {
1136511367
"type": "object",
1136611368
"properties": {
11367-
"workerStatus": {
11369+
"workerInfo": {
1136811370
"type": "array",
1136911371
"items": {
1137011372
"type": "object",
11371-
"$ref": "#/definitions/v1WorkerStatus"
11373+
"$ref": "#/definitions/v1WorkerInfo"
1137211374
}
1137311375
},
1137411376
"nextPageToken": {
@@ -15263,65 +15265,81 @@
1526315265
"v1WorkerHostInfo": {
1526415266
"type": "object",
1526515267
"properties": {
15266-
"hostId": {
15268+
"hostName": {
1526715269
"type": "string",
15268-
"description": "worker host identifier, should be unique for the namespace."
15270+
"description": "Worker host identifier, should be unique for the namespace."
1526915271
},
1527015272
"processId": {
1527115273
"type": "string",
15272-
"description": "worker process identifier, should be unique for the host."
15273-
},
15274-
"hostContext": {
15275-
"type": "string",
15276-
"title": "freeform (e.g. \"k8s container abc123\", etc.)"
15274+
"description": "Worker process identifier, should be unique for the host."
1527715275
},
1527815276
"workerIdentity": {
1527915277
"type": "string",
15280-
"description": "Worker identity, set by the worker, may not be unique."
15278+
"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."
1528115279
}
1528215280
},
15283-
"title": "Holds everything needed to identify the host/process context"
15281+
"title": "Holds everything needed to identify the worker host/process context"
1528415282
},
15285-
"v1WorkerStatus": {
15283+
"v1WorkerInfo": {
1528615284
"type": "object",
1528715285
"properties": {
1528815286
"workerId": {
1528915287
"type": "string",
15290-
"description": "Worker identifier, should be unique for the namespace. Required."
15288+
"description": "Worker identifier, should be unique for the namespace.\nIt is different from worker identity, which is usually a combination of host_name and process_id."
1529115289
},
1529215290
"hostInfo": {
1529315291
"$ref": "#/definitions/v1WorkerHostInfo",
15294-
"description": "Worker host information. Required."
15292+
"description": "Worker host information."
1529515293
},
1529615294
"taskQueue": {
1529715295
"type": "string",
15298-
"description": "Task queue this worker is polling for tasks. Required."
15296+
"description": "Task queue this worker is polling for tasks."
1529915297
},
1530015298
"deploymentVersion": {
15301-
"$ref": "#/definitions/v1WorkerDeploymentVersion",
15302-
"description": "Required."
15299+
"$ref": "#/definitions/v1WorkerDeploymentVersion"
1530315300
},
1530415301
"sdkName": {
1530515302
"type": "string"
1530615303
},
1530715304
"sdkVersion": {
1530815305
"type": "string"
1530915306
},
15307+
"status": {
15308+
"type": "string",
15309+
"description": "Worker status. Possible values - \"running\", \"shutting_down\", \"shutdown\"."
15310+
},
1531015311
"uptime": {
15311-
"type": "string"
15312+
"type": "string",
15313+
"title": "Uptime of the worker, since it started.\nThis is the time since the worker started, not the time since the last heartbeat.\nIt can be used to determine worker start time. (current time - uptime)"
1531215314
},
1531315315
"lastHeartbeatTime": {
1531415316
"type": "string",
15315-
"format": "date-time"
15317+
"format": "date-time",
15318+
"description": "Last heartbeat time, coming from the worker. Worker should set it to \"now\"."
15319+
},
15320+
"workflowTaskSlotsInfo": {
15321+
"$ref": "#/definitions/v1WorkerSlotsInfo"
15322+
},
15323+
"activityTaskSlotsInfo": {
15324+
"$ref": "#/definitions/v1WorkerSlotsInfo"
15325+
},
15326+
"nexusTaskSlotsInfo": {
15327+
"$ref": "#/definitions/v1WorkerSlotsInfo"
15328+
},
15329+
"localActivitySlotsInfo": {
15330+
"$ref": "#/definitions/v1WorkerSlotsInfo"
1531615331
},
15317-
"workflowTaskStatus": {
15318-
"$ref": "#/definitions/v1WorkerTaskStatus"
15332+
"workflowPollerInfo": {
15333+
"$ref": "#/definitions/v1WorkerPollerInfo"
1531915334
},
15320-
"activityTaskStatus": {
15321-
"$ref": "#/definitions/v1WorkerTaskStatus"
15335+
"workflowStickyPollerInfo": {
15336+
"$ref": "#/definitions/v1WorkerPollerInfo"
1532215337
},
15323-
"nexusTaskStatus": {
15324-
"$ref": "#/definitions/v1WorkerTaskStatus"
15338+
"activityPollerInfo": {
15339+
"$ref": "#/definitions/v1WorkerPollerInfo"
15340+
},
15341+
"nexusPollerInfo": {
15342+
"$ref": "#/definitions/v1WorkerPollerInfo"
1532515343
},
1532615344
"cpuUsagePercent": {
1532715345
"type": "number",
@@ -15331,54 +15349,73 @@
1533115349
"type": "string",
1533215350
"format": "int64"
1533315351
},
15334-
"cacheHitRatio": {
15335-
"type": "number",
15336-
"format": "float"
15352+
"stickyCacheHit": {
15353+
"type": "integer",
15354+
"format": "int32",
15355+
"description": "A Workflow Task found a cached Workflow Execution to run against."
1533715356
},
15338-
"maxCacheSize": {
15339-
"type": "number",
15340-
"format": "float"
15357+
"stickyCacheMiss": {
15358+
"type": "integer",
15359+
"format": "int32",
15360+
"description": "A Workflow Task did not find a cached Workflow execution to run against."
1534115361
},
15342-
"availableCacheSize": {
15343-
"type": "number",
15344-
"format": "float"
15362+
"stickyCacheSize": {
15363+
"type": "integer",
15364+
"format": "int32",
15365+
"description": "Current cache size, expressed in number of Workflow Executions."
1534515366
}
15346-
}
15367+
},
15368+
"description": "Worker info message, contains information about the worker and its current state.\nAll information is provided by the worker itself."
1534715369
},
15348-
"v1WorkerTaskStatus": {
15370+
"v1WorkerPollerInfo": {
1534915371
"type": "object",
1535015372
"properties": {
15351-
"lastSuccessfulTaskPollTime": {
15352-
"type": "string",
15353-
"format": "date-time"
15373+
"activePollers": {
15374+
"type": "integer",
15375+
"format": "int32"
1535415376
},
15355-
"taskPollers": {
15377+
"availablePollers": {
1535615378
"type": "integer",
1535715379
"format": "int32"
1535815380
},
15381+
"lastSuccessfulPollTime": {
15382+
"type": "string",
15383+
"format": "date-time"
15384+
}
15385+
}
15386+
},
15387+
"v1WorkerSlotsInfo": {
15388+
"type": "object",
15389+
"properties": {
1535915390
"slotsAvailable": {
1536015391
"type": "integer",
15361-
"format": "int32"
15392+
"format": "int32",
15393+
"description": "Number of slots available for the worker to specific tasks."
1536215394
},
1536315395
"slotsUsed": {
1536415396
"type": "integer",
15365-
"format": "int32"
15397+
"format": "int32",
15398+
"description": "Number of slots used by the worker for specific tasks."
1536615399
},
1536715400
"processedTasks": {
1536815401
"type": "integer",
15369-
"format": "int32"
15402+
"format": "int32",
15403+
"description": "Total number of tasks processed by the worker so far."
1537015404
},
1537115405
"failedTasks": {
1537215406
"type": "integer",
15373-
"format": "int32"
15407+
"format": "int32",
15408+
"description": "Total number of failed tasks processed by the worker so far."
1537415409
},
15375-
"processRateMin": {
15376-
"type": "number",
15377-
"format": "float"
15410+
"processedTasksLastMinute": {
15411+
"type": "integer",
15412+
"format": "int32",
15413+
"description": "Number of tasks processed in the last minute."
1537815414
},
15379-
"failureRateMin": {
15380-
"type": "number",
15381-
"format": "float"
15415+
"failureTasksLastMinute": {
15416+
"type": "integer",
15417+
"format": "int32",
15418+
"description": "Number of failed tasks processed in the last minute."
1538215419
}
1538315420
}
1538415421
},

0 commit comments

Comments
 (0)