Check the Visibility status of a Workflow

To check how many Workflows are currently running, you must set up the Advanced Visibility feature, which depends on an integration with Elasticsearch.

After you integrated Elasticsearch with your Temporal Cluster, you can get information into the visibility of your running Workflows.

Choose from any of the following methods to get visibility on your running Workflows.

Using tctl commands

You can get information about running Workflows by running one of the following tctl commands.

tctl workflow list --query "ExecutionStatus='Running'"
tctl workflow count --query "ExecutionStatus='Running'"

note

If you receive the following error message, you need to configure the Advanced Visibility feature.

Error: unable to count workflows: Operation not supported. Please use on Elasticsearch
('export TEMPORAL_CLI_SHOW_STACKS=1' to see stack traces)

For more examples, see List Filter examples.

Using APIs

Alternatively, you can use the following APIs with your Visibility Query.

• ListWorkflowExecutions
• CountWorkflowExecutions

We don’t recommend using the APIs with high-rate calls.

For more information, see Search Attributes.

note

All lists from APIs are paginated.

Using SDKs

For information on checking the visibility of a Workflow programmatically, see the Search Attributes section on the Observability page.