Skip to content

Conversation

@yuandrew
Copy link
Contributor

@yuandrew yuandrew commented Oct 24, 2025

What was changed

Implemented the ListWorkers and DescribeWorker gRPC requests

note: list workers doesn't display all heartbeat information. Open to feedback on if we should display more/all/less fields. See screenshots in testing section for an example.

PageSize is also not supported in server for the ListWorkers call, so that was left out. Added a limit field to allow users to limit how many results are displayed, similar to other CLI commands.

Sample output of the two new commands
image

Why?

New feature.

Checklist

  1. Closes [Feature Request] Support ListWorkers and DescribeWorker #868

  2. How was this tested:

Added tests, because Go SDK doesn't support worker heartbeating yet, we manually send a RecordWorkerHeartbeatRequest gRPC request to mimic the behavior of a worker.

  1. Any docs updates needed?

@yuandrew yuandrew requested review from a team as code owners October 24, 2025 23:44
@yuandrew yuandrew marked this pull request as draft October 24, 2025 23:51
@yuandrew yuandrew marked this pull request as ready for review October 27, 2025 18:07
Elapsed string
}

type workerDeploymentVersionRef struct {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the JSON tags were removed for the above struct but remain for all of these others. Are they still needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops! Didn't realize we were no longer json printing any of these structs. Removed

Copy link
Member

@cretz cretz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, but wanting to let the CLI team review

short: q
type: string
description: Content for an SQL-like `QUERY` List Filter.
- name: limit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a skip parameter for this endpoint? Wondering how/if we support pagination

Copy link
Contributor Author

@yuandrew yuandrew Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

limit and query are both optional parameters, so I don't think we need a skip param. Users can just omit if they just want the default return value

Pagination is built into the API def, but not currently supported in server (@rkannan82 correct me if I'm wrong). But we do intend to support pagination down the line

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@yuandrew yuandrew merged commit 2445cda into temporalio:main Nov 3, 2025
8 checks passed
@yuandrew yuandrew deleted the worker-heartbeat branch November 3, 2025 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Support ListWorkers and DescribeWorker

5 participants