Add worker visibility API - heartbeat and list worker satus#599
Closed
ychebotarev wants to merge 10 commits into
Closed
Add worker visibility API - heartbeat and list worker satus#599ychebotarev wants to merge 10 commits into
ychebotarev wants to merge 10 commits into
Conversation
ychebotarev
requested review from
Alex-Tideman,
ShahabT,
Sushisource and
yuandrew
cretz
reviewed
May 28, 2025
yuandrew
reviewed
May 28, 2025
Sushisource
reviewed
May 28, 2025
cretz
reviewed
May 29, 2025
ychebotarev
requested review from
Quinn-With-Two-Ns,
Sushisource,
cretz,
yiminc and
yuandrew
dnr
reviewed
May 29, 2025
| int64 memory_usage_bytes = 19; | ||
|
|
||
| // A Workflow Task found a cached Workflow Execution to run against. | ||
| int32 sticky_cache_hit = 20; |
Contributor
There was a problem hiding this comment.
Are these counters since process start or since the last heartbeat?
Contributor
Author
There was a problem hiding this comment.
Now this is something we already have: https://docs.temporal.io/references/sdk-metrics
So I guess since process start.
Contributor
There was a problem hiding this comment.
We do need clear delineation in docs between values that are reset every heartbeat and ones that are cumulative
Contributor
Author
There was a problem hiding this comment.
ok I will add 'total/last/current' qualifies
Contributor
Author
There was a problem hiding this comment.
keeping this open
cretz
reviewed
May 30, 2025
cretz
reviewed
May 30, 2025
cretz
reviewed
May 30, 2025
cretz
reviewed
May 30, 2025
Sushisource
reviewed
Jun 2, 2025
Member
Sushisource
left a comment
Sushisource
left a comment
There was a problem hiding this comment.
I think we're pretty much there. Only a few non-doc changes here.
IMO, let's add this to the polls too, since I know that's something we're going to want to do in the first SDK implementation anyway.
ychebotarev
added a commit
that referenced
this pull request
Jun 5, 2025
<!-- Describe what has changed in this PR --> **What changed?** What changed? * 2 new APIs added: * WorkerHeartbeat * ListWorkerStatus * WorkerInfo information added to: * ShutDownWorker request * Poll(Activity|Nexus|Workflow)TaskQueue requests This is "for merge". Here is a previous PR, where we discuss this at length: #599 <!-- Tell your future self why have you made these changes --> **Why?** Part of the worker visibility work. Workers should be able to report their status. Users should be able to get information about workers. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** Yes - new API is introduce. <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** [Server PR](temporalio/temporal#7870)
temporal-cicd Bot
pushed a commit
to temporalio/api-go
that referenced
this pull request
Jun 5, 2025
<!-- Describe what has changed in this PR --> **What changed?** What changed? * 2 new APIs added: * WorkerHeartbeat * ListWorkerStatus * WorkerInfo information added to: * ShutDownWorker request * Poll(Activity|Nexus|Workflow)TaskQueue requests This is "for merge". Here is a previous PR, where we discuss this at length: temporalio/api#599 <!-- Tell your future self why have you made these changes --> **Why?** Part of the worker visibility work. Workers should be able to report their status. Users should be able to get information about workers. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** Yes - new API is introduce. <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** [Server PR](temporalio/temporal#7870)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
MAYBE FOR MERGE.
The goal of this PR is to review the proposed APIs.
It will not necessary be merged, treat it as a part of Design review.
What changed?
2 new APIs added:
Why?
Part of the worker visibility work.
Note:
Currently metrics are not supported as a part of List operation query. But it may happen, based on user feedback.