Edit

Debug and manage orchestrations using the Durable Task Scheduler dashboard

The Durable Task Scheduler dashboard lets you observe running orchestrations, inspect execution history and activity inputs/outputs, and manage orchestration lifecycle (pause, resume, terminate), all from a browser.

The dashboard is available in two environments:

Environment URL Authentication
Local emulator http://localhost:8082 None required
Azure https://dashboard.durabletask.io/?endpoint=<SCHEDULER_ENDPOINT>&taskhub=<TASK_HUB_NAME> Requires Durable Task Data Contributor role

For more about the emulator, see Emulator for local development.

In this article, you learn how to:

  • Access the dashboard locally or on Azure.
  • Assign the Durable Task Data Contributor role to your developer identity.
  • Monitor orchestration status, filter instances, and inspect execution history.
  • Manage orchestrations (pause, resume, terminate, raise events).

Prerequisites

Before you begin:

Access the dashboard locally

If you're using the Durable Task Scheduler emulator, the dashboard is available at:

http://localhost:8082

No authentication or role assignment is needed for local development.

Assign dashboard access roles (Azure)

To access the dashboard for an Azure-hosted scheduler, assign the Durable Task Data Contributor role to your developer identity (email).

  1. Set the assignee to your developer identity.

    assignee=$(az ad user show --id "someone@microsoft.com" --query "id" --output tsv)

  2. Set the scope. Granting access on the scheduler scope gives access to all task hubs in that scheduler.

    Task Hub

    scope="/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/SCHEDULER_NAME/taskHubs/TASK_HUB_NAME"

    Scheduler

    scope="/subscriptions/SUBSCRIPTION_ID/resourceGroups/RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/SCHEDULER_NAME"

  3. Grant access. Run the following command to create the role assignment and grant access.

    az role assignment create \
  --assignee "$assignee" \
  --role "Durable Task Data Contributor" \
  --scope "$scope"

    Expected output

    The following output example shows a developer identity assigned with the Durable Task Data Contributor role on the scheduler level:

    {
  "condition": null,
  "conditionVersion": null,
  "createdBy": "YOUR_DEVELOPER_CREDENTIAL_ID",
  "createdOn": "2024-12-20T01:36:45.022356+00:00",
  "delegatedManagedIdentityResourceId": null,
  "description": null,
  "id": "/subscriptions/YOUR_SUBSCRIPTION_ID/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_DTS_NAME/providers/Microsoft.Authorization/roleAssignments/ROLE_ASSIGNMENT_ID",
  "name": "ROLE_ASSIGNMENT_ID",
  "principalId": "YOUR_DEVELOPER_CREDENTIAL_ID",
  "principalName": "YOUR_EMAIL",
  "principalType": "User",
  "resourceGroup": "YOUR_RESOURCE_GROUP",
  "roleDefinitionId": "/subscriptions/YOUR_SUBSCRIPTION/providers/Microsoft.Authorization/roleDefinitions/ROLE_DEFINITION_ID",
  "roleDefinitionName": "Durable Task Data Contributor",
  "scope": "/subscriptions/YOUR_SUBSCRIPTION/resourceGroups/YOUR_RESOURCE_GROUP/providers/Microsoft.DurableTask/schedulers/YOUR_DTS_NAME",
  "type": "Microsoft.Authorization/roleAssignments",
  "updatedBy": "YOUR_DEVELOPER_CREDENTIAL_ID",
  "updatedOn": "2024-12-20T01:36:45.022356+00:00"
}

  4. After granting access, open the dashboard at:

    https://dashboard.durabletask.io/?endpoint=<SCHEDULER_ENDPOINT>&taskhub=<TASK_HUB_NAME>

    Replace <SCHEDULER_ENDPOINT> with your scheduler's endpoint (for example, https://myscheduler.westus2.durabletask.io) and <TASK_HUB_NAME> with the name of your task hub.

    Alternatively, navigate to https://dashboard.durabletask.io/ and enter your scheduler endpoint and task hub name in the connection form.

Note

The following instruction shows a role assignment scoped to a specific task hub. If you need access to all task hubs in a scheduler, perform the assignment on the scheduler level.

  1. Navigate to the Durable Task Scheduler resource on the portal.

  2. Click on a task hub name.

  3. In the left menu, select Access control (IAM).

  4. Click Add to add a role assignment.

    Screenshot of the adding the role assignment on the Access Control pane in the portal.

  5. Search for and select Durable Task Data Contributor. Click Next.

    Screenshot of selecting the Durable Task Data Contributor role assignment in the portal.

  6. On the Members tab, for Assign access to, select User, group, or service principal.

  7. For Members, click + Select members.

  8. In the Select members pane, search for your name or email:

    Screenshot of selecting the user-assigned managed identity type in the portal.

  9. Pick your email and click the Select button.

  10. Click Review + assign to finish assigning the role.

  11. Once the role is assigned, click Overview on the left menu of the task hub resource and navigate to the dashboard URL located at the top Essentials section.

Monitor your task hub via the dashboard

The dashboard allows you to monitor orchestration progress and review execution history. From the dashboard home page, you can find your task hub's orchestrations, entities, schedules, workers and metrics, and AI agents (currently in preview).

Orchestrations overview pane

View orchestrations by clicking either on the task hub name or Orchestrations from the side menu.

Screenshot of the dashboard home page with links to task hubs, orchestration history, entities, schedules, workers, metrics, and AI agents.

From the Orchestrations overview pane, you can:

  • Review a list of orchestration instances.
  • Narrow down the orchestrations via search bar or filters.
  • Create a new orchestration.
  • Copy a shareable link to the dashboard.
  • Set autorefresh intervals of the orchestration list.

Screenshot of the dashboard listing orchestrations.

Orchestration information is presented with the following default columns.

Category Description
Instance ID Search for a specific orchestration instance by its unique ID.
Name Filter by the orchestration type name.
Status Filter by runtime status (Running, Completed, Failed, Terminated, Pending, Suspended).
Tags Filter by the tags applied to the orchestration instance.
Created Date and time that the orchestration was created.

You can filter the orchestration list using the following criteria.

Screenshot of the dashboard listing orchestration history and status with filter options.

Category Description
Orchestration name Filter by the orchestration type name.
Runtime status Filter by runtime status (Running, Completed, Failed, Terminated, Pending, Suspended).
Tag filter Search for orchestrations by tag key or value.
Created from/Created to Narrow results to a time window.

Trigger a refresh of the orchestration list by:

  • Clicking the refresh icon for a manual refresh.

  • Toggle Auto and select interval to automatically refresh the list.

    Screenshot of the autorefresh toggle and manual refresh icon.

Create a new orchestration

You can create a new orchestration from the Durable Task Scheduler dashboard.

  1. From the Orchestrations overview pane, click + New Orchestration.

  2. Fill out the information in the New Orchestration form.

    Screenshot of the Create new orchestration form.

    Field Description
    Orchestration Name Select an orchestration from the drop-down, or type a custom orchestration name.
    Instance ID Optional. Instance IDs are autogenerated. Whether you create one yourself or let it autogenerate, instance IDs are in ASCII format.
    Version Optional. Enter applicable version number.
    Input Optional. Enter input in JSON format.
    Scheduled start Optional. Select the start date and time for the orchestration.
    Tags Optional. Enter key and/or value tags associated with the orchestration.

  3. Click Create.

    You can see your new orchestration in the list.

Orchestration details

Click an orchestration instance to diagnose problems or gain visibility into the status of an orchestration.

Use the Timeline, History, and Flow tabs to view its execution details and activity progress. The Timeline tab is open by default.

  • The Timeline tab shows the intervals of a running orchestration.

    Screenshot of the orchestration execution timeline.

    Select an activity to view its input and output.

    Screenshot of the pane where you can view an activity's input, output, and status.

  • The History tab provides a feed of all events in an orchestration, complete with timestamps.

    Screenshot of the dashboard showing an individual orchestration's event history.

  • The Flow tab visually plots out the orchestration's execution flow.

    Screenshot of an individual orchestration's event flow.

    You can also view an activity's input and output by clicking View.

    Screenshot of the pane where you can view an activity's input, output, and status via the flow view.

Manage orchestrations

You can manage your orchestration lifecycle via the dashboard. In the Orchestrations pane, select an instance ID to access the following actions:

Screenshot of the dashboard showing the Purge, Restart, Terminate, Suspend, and Resume buttons for managing orchestrations.

  • Resume: Continue a previously suspended orchestration.
  • Suspend: Pause a running orchestration. It remains in memory, but stops processing events until resumed.
  • Restart: Restart a previously running orchestration.
  • Terminate: Immediately stop an orchestration with an optional reason string.
  • Purge: Purge the orchestration instance.

Drill into an individual orchestration to access the Raise event action. This action sends a named external event (with optional JSON payload) to a running or suspended orchestration.

Screenshot of the dashboard showing the Purge, Restart, Terminate, and Raise Event buttons for managing orchestrations.

Entities

Select Entities from the left side menu to view entities you created.

Screenshot of the entities you created and some management tools for them.

Click an individual entity from the list to view its details. From here, you can review:

  • When it was last modified
  • When the last operation ran
  • Whether it's locked, and who locked it
  • Its backlog size
  • The entity state in either JSON or raw code

Screenshot of an individual entity being tracked in the Durable Task Scheduler dashboard.

You can also send a signal to the entity. Click Signal in the top right corner and create the signal message.

Screenshot of the window for sending a signal to your individual entity.

Agents (preview)

Note

Reviewing agent sessions via the Durable Task Scheduler dashboard is currently in preview.

Select Agents from the left side menu to monitor agent sessions triggered by your application in the scheduler. Click into an agent session to view your token usage data, such as:

  • The number of prompt tokens you've used.
  • The number of completion tokens you've used.
  • The total number of tokens used during the agent session.

You can also view the agent chat history and timeline.

Screenshot of the agent sessions triggered by your application.

Schedules

Select Schedules from the left side menu to view schedules you created. From the schedules pane, you can pause, resume, or delete a schedule. You can also click + Create Schedule to create a schedule via the dashboard UI.

Screenshot of the schedules you created and some management tools for them.

Workers & metrics

Select Workers & Metrics from the left side menu to view:

  • All of your pending, active, or stored activities, orchestrators, and entities.
  • Connected workers.

Screenshot of an overview of the work item queues and connected workers.

Next steps

For Durable Task Scheduler for Durable Functions:

For Durable Task Scheduler for the Durable Task SDKs:

  • Last updated on