[WiP] Deployment and TaskQueue Stats API #571
Draft
+570
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephanos
commented
Apr 16, 2025
| repeated temporal.api.taskqueue.v1.TaskQueueStatDetails per_queue_stats = 1; | ||
|
|
||
| // Aggregated backlog count across all task queues in this deployment version. | ||
| int64 approximate_total_backlog_count = 2; |
There was a problem hiding this comment.
Name is derived from TaskQueueStatDetails's approximate_backlog_count field.
stephanos
force-pushed
the
task-stats
branch
8 times, most recently
from
6b25fed to
fa2df53
Compare
stephanos
force-pushed
the
task-stats
branch
4 times, most recently
from
f46f542 to
9778bd9
Compare
stephanos
commented
Apr 28, 2025
| @@ -1085,6 +1085,16 @@ message DescribeTaskQueueResponse { | |||
| temporal.api.taskqueue.v1.TaskQueueVersioningInfo versioning_info = 4; | |||
| } | |||
|
|
|||
| message GetTaskQueueStatsRequest { | |||
| string namespace = 1; | |||
| temporal.api.taskqueue.v1.TaskQueue task_queue = 2; | |||
There was a problem hiding this comment.
Should this just be string instead?
stephanos
changed the title
stephanos
commented
Apr 28, 2025
|
|
||
| // Optional. Deployment version to return stats for. | ||
| // If left empty, the current version will be queried. | ||
| string deployment_version = 3; |
There was a problem hiding this comment.
Need to double-check that build_id isn't a better field name here.
stephanos
commented
Apr 28, 2025
Comment on lines
+340
to
+344
| message TaskQueueStatsInfo { | ||
| temporal.api.taskqueue.v1.TaskQueue task_queue = 1; | ||
| temporal.api.enums.v1.TaskQueueType task_queue_type = 2; | ||
| temporal.api.taskqueue.v1.TaskQueueStats task_queue_stats = 3; | ||
| } |
There was a problem hiding this comment.
This message only exists because TaskQueueStats doesn't contain the task queue name and task_queue_type.
I considered adding them to the existing TaskQueueStats, but was discouraged to do so.
stephanos
force-pushed
the
task-stats
branch
2 times, most recently
from
ba4700d to
2c3d3cf
Compare
stephanos
commented
Apr 28, 2025
| // GetWorkerDeploymentStats returns the stats for all task queues in a deployment version. | ||
| rpc GetWorkerDeploymentStats (GetWorkerDeploymentStatsRequest) returns (GetWorkerDeploymentStatsResponse) { | ||
| option (google.api.http) = { | ||
| get: "/namespaces/{namespace}/worker-deployments/{deployment_name}/{deployment_version}/stats" |
There was a problem hiding this comment.
Since deployment_version can be empty, I'm not sure this is right yet.
stephanos
commented
Apr 28, 2025
| // GetTaskQueueStats returns stats for a single task queue. | ||
| rpc GetTaskQueueStats (GetTaskQueueStatsRequest) returns (GetTaskQueueStatsResponse) { | ||
| option (google.api.http) = { | ||
| post: "/namespaces/{namespace}/task-queues/{task_queue.name}/type/{task_queue_type}/get-stats" |
There was a problem hiding this comment.
Does this work with the task_queue_type enum in there?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
READ BEFORE MERGING: All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted.
What changed?
Added two new APIs:
GetWorkerDeploymentStatsGetTaskQueueStatsWhy?
To return task queue stats to users for making scaling decisions.
Breaking changes
No.
Server PR
temporalio/temporal#7581