temporalio / temporalio/ui

Make data exposed in Temporal UI easily targetable via JavaScript

Open
#2,879 0 comments 3 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

Hello, I've been using Temporal in production for 3 year now.

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

Right now, debugging Temporal workflows is a lot of copy/pasting RunIDs, Trace IDs or other internal IDs into a bunch of different UIs to find information.

Describe the solution you'd like

Instead of copy/pasting IDs everywhere, I would love to just be able to click on buttons that open the desired UI.

But since, every company has its own set of tools, it's not something that can be hard-coded in the Temporal UI. However, on the workflow detail page (/namespaces/default/workflows/xxx/yyy/history), surfacing important IDs in the HTML via a explicit id or class would make it very easy for folks to create userscripts (or Browser extensions even) to code this behavior themselves.

Data I think should be easy target-able via JavaScript DOM queries:

  • Workflow ID
  • Run ID
  • Task Queue
  • Workflow Type
  • Workflow Input
  • Workflow Result
  • Memo and custom search attributes would be great, but they're hidden on the Metadata tab

Describe alternatives you've considered

Customization options on the Temporal UI directly but this seems out of scope for the UI.

Additional context

I also would love to have the Open Telemetry Trace ID also available on the UI. I'm not sure how many folks would be interested, but it has become my entrypoint to debug stuff.

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 at the workflow detail page route /namespaces/default/workflows/xxx/yyy/history and inspect how the Workflow ID, Run ID, Task Queue, Workflow Type, Input, and Result are rendered. Check the Metadata tab for Memo and custom search attributes, then verify in the browser that the requested data can be reliably selected through explicit IDs or classes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.