Skip to main content

Temporal Web UI

The Temporal Web UI provides users with Workflow Execution state and metadata for debugging purposes. 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:

The Web UI is packed with several features.

Namespace selection​

You can search for or select a Namespace by using the Namespace Switcher, located in the left navigational menu. After you select a Namespace, the Web UI shows the Recent Workflows page for that Namespace. In Temporal Cloud, users can access only the Namespaces that they have been granted access to.

Recent Workflows​

Recent Workflows lists all Workflow Executions run in the past 24 hours. The default number shown is 1,000 Workflow Executions.

Users can list Workflow Executions by any of the following:

For start time and end time, users can set their preferred date and time format as one of the following:

  • UTC
  • Local
  • Relative

Select a Workflow Execution to view the Workflow Execution's History, Workers, and pending Activities.

History​

This is a view of the EventsLink preview iconWhat 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 within 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:

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 section.

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​

ArchivalLink preview iconWhat 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.

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 the tctl plugin port.