Temporal Web UI

Upgrade available

Temporal Web UI v2 is now generally available.

Temporal Web UI v1 is being deprecated on September 30, 2022.

The Temporal Web UI is a GUI that provides users with Workflow Execution state and metadata and is intended to be used to debug execution issues. It ships with every docker-compose update and is available with Temporal Cloud.

You can configure the Temporal Web UI to work in your own environment. See the UI configuration reference.

Web UI open source repos:

• temporalio/ui
• temporalio/ui-server

The Web UI is packed with several features.

Namespace selection

Users can switch between Namespaces by clicking the Namespace Switcher icon in the left navigation. Clicking the Namespace Switcher reveals a side panel where users can search for a Namespace or select a Namespace from the list. After a Namespace is selected, the user is redirected to the Recent Workflows page for that Namespace. In Temporal Cloud, users can access only Namespaces that they have been granted access to.

Recent Workflows

The Recent Workflows page lists the most recent 1,000 Workflow Executions in the past 24 hours, by default. Users can list Workflow Executions by any of the following:

• Workflow ID

  What is a Workflow Id?

  A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.

  Learn more

• Workflow Type

  What is a Workflow Type?

  A Workflow Type is a name that maps to a Workflow Definition.

  Learn more

• Status
• Date and Time—users can set their preferred date and time format as one of the following:
  • UTC
  • Local
  • Relative
• A List Filter

  What is a List Filter?

  A List Filter is the SQL-like string that is provided as the parameter to an Advanced Visibility List API.

  Learn more

Select a Workflow Execution to see a breakdown of the Workflow Execution's History, Workers, and pending Activities.

History

This is a view of the Events

What is an Event?

Events are created by the Temporal Cluster in response to external occurrences and Commands generated by a Workflow Execution.

Learn more

and Event fields that make up the Workflow Execution. Approximately 40 different Events can appear in a Workflow Execution's Event History. The top of the page lists the following execution metadata:

• Workflow Type

  What is a Workflow Type?

  A Workflow Type is a name that maps to a Workflow Definition.

  Learn more

• Run ID

  What is a Run Id?

  A Run Id is a globally unique, platform-level identifier for a Workflow Execution.

  Learn more

• Start Time and Close Time
• Task Queue

  What is a Task Queue?

  A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

  Learn more

• Parent and Parent ID
• State Transitions

The Input and Results section displays the function arguments and return values for debugging purposes. Results are not available until the Workflow finishes.

The Recent Events tab has the following views:

• Timeline: A chronological or reverse-chronological order of events with a summary. Clicking into an Event displays all details for that Event. Clicking “Expand all” displays all Event details. Similarly, clicking “Collapse all” collapses the table and displays only the summary.
• Compact: A logical grouping of Activities, Signals and Timers.
• JSON: The full JSON code for the workflow.

Download Event History

The entire Workflow Execution Event History, in JSON format, can be downloaded from this screen.

Terminate Workflow

Workflow Executions can be Terminated directly from the UI. A custom note can be logged from the UI when that happens.

Workers

Displays the Workers currently polling on the Workflow Task Queue with a count. If no Workers are polling, an error displays.

Pending Activities

Displays a summary of recently active and/or pending Activity Executions. Clicking a pending Activity directs the user to the Pending Activities tab to view details.

Stack Trace

The screen shows the captured result from the __stack_trace Query. The Query is performed when the tab is selected. It works only if a Worker is running and available to return the stack trace.

Queries

Lists all Queries sent to the Workflow Execution.

Settings

Displays the following information:

• Description of the Namespace.
• Owner: Namespace owner.
• Global?: Whether the Namespace is a Global Namespace
• Retention Period: Namespace Retention Period
• History Archival: Whether History Archival is enabled
• Visibility Archival: Whether Visibility Archival is enabled
• Failover Version: Namespace Failover Version
• Clusters: Cluster information

Archival

Archival

What is Archival?

Archival is a feature that automatically backs up Event Histories from Temporal Cluster persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

Learn more

feature information.

Import Event History

Navigate to /import to import an Event History in JSON format and populate a Workflow details page.

Data Encoder

The Web UI can use the same Data Converter that Workers use for inputs and return values. The UI supports both a Remote Codec endpoint and/or the tctl plugin port.