Skip to content

Commit fa2df53

Browse files
stephanosstephanos
committed
Task Queue Stats API
1 parent d7bb01b commit fa2df53

File tree

5 files changed

+556
-1
lines changed

5 files changed

+556
-1
lines changed

‎openapi/openapiv2.json

+272
Original file line numberDiff line numberDiff line change
@@ -1457,6 +1457,77 @@
14571457
]
14581458
}
14591459
},
1460+
"/api/v1/namespaces/{namespace}/task-queues/get-stats": {
1461+
"post": {
1462+
"summary": "GetTaskQueueStats returns stats for one or multiple task queues.",
1463+
"operationId": "GetTaskQueueStats2",
1464+
"responses": {
1465+
"200": {
1466+
"description": "A successful response.",
1467+
"schema": {
1468+
"$ref": "#/definitions/v1GetTaskQueueStatsResponse"
1469+
}
1470+
},
1471+
"default": {
1472+
"description": "An unexpected error response.",
1473+
"schema": {
1474+
"$ref": "#/definitions/rpcStatus"
1475+
}
1476+
}
1477+
},
1478+
"parameters": [
1479+
{
1480+
"name": "namespace",
1481+
"in": "path",
1482+
"required": true,
1483+
"type": "string"
1484+
},
1485+
{
1486+
"name": "taskQueue.name",
1487+
"in": "query",
1488+
"required": false,
1489+
"type": "string"
1490+
},
1491+
{
1492+
"name": "taskQueue.kind",
1493+
"description": "Default: TASK_QUEUE_KIND_NORMAL.\n\n - TASK_QUEUE_KIND_NORMAL: Tasks from a normal workflow task queue always include complete workflow history\n\nThe task queue specified by the user is always a normal task queue. There can be as many\nworkers as desired for a single normal task queue. All those workers may pick up tasks from\nthat queue.\n - TASK_QUEUE_KIND_STICKY: A sticky queue only includes new history since the last workflow task, and they are\nper-worker.\n\nSticky queues are created dynamically by each worker during their start up. They only exist\nfor the lifetime of the worker process. Tasks in a sticky task queue are only available to\nthe worker that created the sticky queue.\n\nSticky queues are only for workflow tasks. There are no sticky task queues for activities.",
1494+
"in": "query",
1495+
"required": false,
1496+
"type": "string",
1497+
"enum": [
1498+
"TASK_QUEUE_KIND_UNSPECIFIED",
1499+
"TASK_QUEUE_KIND_NORMAL",
1500+
"TASK_QUEUE_KIND_STICKY"
1501+
],
1502+
"default": "TASK_QUEUE_KIND_UNSPECIFIED"
1503+
},
1504+
{
1505+
"name": "taskQueue.normalName",
1506+
"description": "Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of\nthe normal task queue that the sticky worker is running on.",
1507+
"in": "query",
1508+
"required": false,
1509+
"type": "string"
1510+
},
1511+
{
1512+
"name": "taskQueueType",
1513+
"description": " - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
1514+
"in": "query",
1515+
"required": false,
1516+
"type": "string",
1517+
"enum": [
1518+
"TASK_QUEUE_TYPE_UNSPECIFIED",
1519+
"TASK_QUEUE_TYPE_WORKFLOW",
1520+
"TASK_QUEUE_TYPE_ACTIVITY",
1521+
"TASK_QUEUE_TYPE_NEXUS"
1522+
],
1523+
"default": "TASK_QUEUE_TYPE_UNSPECIFIED"
1524+
}
1525+
],
1526+
"tags": [
1527+
"WorkflowService"
1528+
]
1529+
}
1530+
},
14601531
"/api/v1/namespaces/{namespace}/task-queues/{taskQueue.name}": {
14611532
"get": {
14621533
"summary": "DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:\n - List of pollers\n - Workflow Reachability status\n - Backlog info for Workflow and/or Activity tasks",
@@ -2080,6 +2151,51 @@
20802151
]
20812152
}
20822153
},
2154+
"/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/{deploymentVersion}/stats": {
2155+
"get": {
2156+
"summary": "GetWorkerDeploymentStats returns the stats for all task queues in a deployment version.",
2157+
"operationId": "GetWorkerDeploymentStats2",
2158+
"responses": {
2159+
"200": {
2160+
"description": "A successful response.",
2161+
"schema": {
2162+
"$ref": "#/definitions/v1GetWorkerDeploymentStatsResponse"
2163+
}
2164+
},
2165+
"default": {
2166+
"description": "An unexpected error response.",
2167+
"schema": {
2168+
"$ref": "#/definitions/rpcStatus"
2169+
}
2170+
}
2171+
},
2172+
"parameters": [
2173+
{
2174+
"name": "namespace",
2175+
"in": "path",
2176+
"required": true,
2177+
"type": "string"
2178+
},
2179+
{
2180+
"name": "deploymentName",
2181+
"description": "Name of the deployment to return stats for.\n",
2182+
"in": "path",
2183+
"required": true,
2184+
"type": "string"
2185+
},
2186+
{
2187+
"name": "deploymentVersion",
2188+
"description": "Optional. Deployment version to return stats for.\nIf left empty, the current version will be queried.",
2189+
"in": "path",
2190+
"required": true,
2191+
"type": "string"
2192+
}
2193+
],
2194+
"tags": [
2195+
"WorkflowService"
2196+
]
2197+
}
2198+
},
20832199
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
20842200
"get": {
20852201
"summary": "Deprecated. Use `DescribeTaskQueue`.",
@@ -4970,6 +5086,77 @@
49705086
]
49715087
}
49725088
},
5089+
"/namespaces/{namespace}/task-queues/get-stats": {
5090+
"post": {
5091+
"summary": "GetTaskQueueStats returns stats for one or multiple task queues.",
5092+
"operationId": "GetTaskQueueStats",
5093+
"responses": {
5094+
"200": {
5095+
"description": "A successful response.",
5096+
"schema": {
5097+
"$ref": "#/definitions/v1GetTaskQueueStatsResponse"
5098+
}
5099+
},
5100+
"default": {
5101+
"description": "An unexpected error response.",
5102+
"schema": {
5103+
"$ref": "#/definitions/rpcStatus"
5104+
}
5105+
}
5106+
},
5107+
"parameters": [
5108+
{
5109+
"name": "namespace",
5110+
"in": "path",
5111+
"required": true,
5112+
"type": "string"
5113+
},
5114+
{
5115+
"name": "taskQueue.name",
5116+
"in": "query",
5117+
"required": false,
5118+
"type": "string"
5119+
},
5120+
{
5121+
"name": "taskQueue.kind",
5122+
"description": "Default: TASK_QUEUE_KIND_NORMAL.\n\n - TASK_QUEUE_KIND_NORMAL: Tasks from a normal workflow task queue always include complete workflow history\n\nThe task queue specified by the user is always a normal task queue. There can be as many\nworkers as desired for a single normal task queue. All those workers may pick up tasks from\nthat queue.\n - TASK_QUEUE_KIND_STICKY: A sticky queue only includes new history since the last workflow task, and they are\nper-worker.\n\nSticky queues are created dynamically by each worker during their start up. They only exist\nfor the lifetime of the worker process. Tasks in a sticky task queue are only available to\nthe worker that created the sticky queue.\n\nSticky queues are only for workflow tasks. There are no sticky task queues for activities.",
5123+
"in": "query",
5124+
"required": false,
5125+
"type": "string",
5126+
"enum": [
5127+
"TASK_QUEUE_KIND_UNSPECIFIED",
5128+
"TASK_QUEUE_KIND_NORMAL",
5129+
"TASK_QUEUE_KIND_STICKY"
5130+
],
5131+
"default": "TASK_QUEUE_KIND_UNSPECIFIED"
5132+
},
5133+
{
5134+
"name": "taskQueue.normalName",
5135+
"description": "Iff kind == TASK_QUEUE_KIND_STICKY, then this field contains the name of\nthe normal task queue that the sticky worker is running on.",
5136+
"in": "query",
5137+
"required": false,
5138+
"type": "string"
5139+
},
5140+
{
5141+
"name": "taskQueueType",
5142+
"description": " - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
5143+
"in": "query",
5144+
"required": false,
5145+
"type": "string",
5146+
"enum": [
5147+
"TASK_QUEUE_TYPE_UNSPECIFIED",
5148+
"TASK_QUEUE_TYPE_WORKFLOW",
5149+
"TASK_QUEUE_TYPE_ACTIVITY",
5150+
"TASK_QUEUE_TYPE_NEXUS"
5151+
],
5152+
"default": "TASK_QUEUE_TYPE_UNSPECIFIED"
5153+
}
5154+
],
5155+
"tags": [
5156+
"WorkflowService"
5157+
]
5158+
}
5159+
},
49735160
"/namespaces/{namespace}/task-queues/{taskQueue.name}": {
49745161
"get": {
49755162
"summary": "DescribeTaskQueue returns the following information about the target task queue, broken down by Build ID:\n - List of pollers\n - Workflow Reachability status\n - Backlog info for Workflow and/or Activity tasks",
@@ -5554,6 +5741,51 @@
55545741
]
55555742
}
55565743
},
5744+
"/namespaces/{namespace}/worker-deployments/{deploymentName}/{deploymentVersion}/stats": {
5745+
"get": {
5746+
"summary": "GetWorkerDeploymentStats returns the stats for all task queues in a deployment version.",
5747+
"operationId": "GetWorkerDeploymentStats",
5748+
"responses": {
5749+
"200": {
5750+
"description": "A successful response.",
5751+
"schema": {
5752+
"$ref": "#/definitions/v1GetWorkerDeploymentStatsResponse"
5753+
}
5754+
},
5755+
"default": {
5756+
"description": "An unexpected error response.",
5757+
"schema": {
5758+
"$ref": "#/definitions/rpcStatus"
5759+
}
5760+
}
5761+
},
5762+
"parameters": [
5763+
{
5764+
"name": "namespace",
5765+
"in": "path",
5766+
"required": true,
5767+
"type": "string"
5768+
},
5769+
{
5770+
"name": "deploymentName",
5771+
"description": "Name of the deployment to return stats for.\n",
5772+
"in": "path",
5773+
"required": true,
5774+
"type": "string"
5775+
},
5776+
{
5777+
"name": "deploymentVersion",
5778+
"description": "Optional. Deployment version to return stats for.\nIf left empty, the current version will be queried.",
5779+
"in": "path",
5780+
"required": true,
5781+
"type": "string"
5782+
}
5783+
],
5784+
"tags": [
5785+
"WorkflowService"
5786+
]
5787+
}
5788+
},
55575789
"/namespaces/{namespace}/worker-task-reachability": {
55585790
"get": {
55595791
"summary": "Deprecated. Use `DescribeTaskQueue`.",
@@ -10265,6 +10497,14 @@
1026510497
},
1026610498
"description": "System capability details."
1026710499
},
10500+
"v1GetTaskQueueStatsResponse": {
10501+
"type": "object",
10502+
"properties": {
10503+
"taskQueueStats": {
10504+
"$ref": "#/definitions/v1TaskQueueStats"
10505+
}
10506+
}
10507+
},
1026810508
"v1GetWorkerBuildIdCompatibilityResponse": {
1026910509
"type": "object",
1027010510
"properties": {
@@ -10279,6 +10519,24 @@
1027910519
},
1028010520
"title": "[cleanup-wv-pre-release]"
1028110521
},
10522+
"v1GetWorkerDeploymentStatsResponse": {
10523+
"type": "object",
10524+
"properties": {
10525+
"perQueueMetrics": {
10526+
"type": "array",
10527+
"items": {
10528+
"type": "object",
10529+
"$ref": "#/definitions/v1TaskQueueStatsInfo"
10530+
},
10531+
"description": "Collection of stats for all task queues in the requested deployment."
10532+
},
10533+
"approximateTotalBacklogCount": {
10534+
"type": "string",
10535+
"format": "int64",
10536+
"description": "The sum of backlog counts across all task queues in this deployment version."
10537+
}
10538+
}
10539+
},
1028210540
"v1GetWorkerTaskReachabilityResponse": {
1028310541
"type": "object",
1028410542
"properties": {
@@ -13920,6 +14178,20 @@
1392014178
},
1392114179
"description": "TaskQueueStats contains statistics about task queue backlog and activity.\n\nFor workflow task queue type, this result is partial because tasks sent to sticky queues are not included. Read\ncomments above each metric to understand the impact of sticky queue exclusion on that metric accuracy."
1392214180
},
14181+
"v1TaskQueueStatsInfo": {
14182+
"type": "object",
14183+
"properties": {
14184+
"taskQueue": {
14185+
"$ref": "#/definitions/v1TaskQueue"
14186+
},
14187+
"taskQueueType": {
14188+
"$ref": "#/definitions/v1TaskQueueType"
14189+
},
14190+
"taskQueueStats": {
14191+
"$ref": "#/definitions/v1TaskQueueStats"
14192+
}
14193+
}
14194+
},
1392314195
"v1TaskQueueStatus": {
1392414196
"type": "object",
1392514197
"properties": {

0 commit comments

Comments
 (0)