temporalio / temporalio/ui

Download workflow diagnostics in UI/CLI

Open
#945 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
431
Forks
179
Avg merge
2d 9h
Merged PRs (30d)
71

Description

Is your feature request related to a problem? Please describe.

There are multiple pieces of information required to troubleshoot a user problem. So to help with troubleshooting, we need to ask users to provide them separately. For example, download a workflow history and then look in the UI for pending activities, then tell the version of the service, UI, and SDK used. Then see if there are pending workers on a task queue for workflow and activity task queues for that workflow.

Also, it is pretty common that users don't want to share histories as they might contain proprietary information in payloads.

Describe the solution you'd like

A "download diagnostic information" button (and corresponding CLI command) that saves to the disk a file with all the relevant information:

  1. Describe Workflow Result
  2. Workflow execution history (optionally with payloads stripped)
  3. Version information about service, SDKs and UI.
  4. List of connected workers for every task queue that workflow uses.
  5. Any other additional info that we might find useful for troubleshooting

Ideally, we would also provide a view in UI that would allow loading this file for browsing in a nice view.

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 mapping the existing UI workflow details and the corresponding CLI entry point mentioned in the request. Define how the diagnostic file should include workflow results, optionally stripped history, version information, and connected workers, then determine how the UI would load it for browsing. Done means a documented design and an agreed scope for both interfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.