temporalio / temporalio/features

High-level task queue describe call with default-build-ID stats

Open
#525 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
32
Forks
28
Avg merge
1d 9h
Merged PRs (30d)
7

Description

Describe the solution you'd like

Need to be able to describe task queue from the high-level client and access stats information. This information is only available in server 1.25.

While the API result has build-ID-specific stats, at this time we want the describe result to only have the stats. Here is the specific implementation expectations modeled off of what is already done in Go:

  • "describe task queue" should accept options including whether to report stats and report poller info, both of which should default to false
  • This describe call should return a "task queue description" that right now only contains a map of "types" with the key as an "task queue type" enumerate and value of "task queue type info". This will contain information for the unversioned task queue only (later we will add build-ID-specific forms).
  • "task queue type" should be an enumerate with worker, activity, and nexus values
  • "task queue type info" should contain a collection of "pollers" (of type "task queue poller info") and "stats" (of type "task queue stats"). See Go SDK and API for the values of each of those types
Per-SDK Tickets

⚠️ Waiting on per-SDK issues until the solution as described is confirmed acceptable

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Go SDK implementation linked in PR #1553 and the server 1.25 API definitions for task-queue descriptions, stats, and poller information. Done means the high-level client supports the requested options and unversioned task-queue types, with the per-SDK approach confirmed before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, java, php, python, typescript
Domain
api, backend-api-design, distributed-systems
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.