List and Inspect Workflows

List and Inspect Workflows

Use DBOS.listWorkflows to query workflow executions by status, name, time range, and other criteria.

Incorrect (no monitoring of workflow state):

// Start workflow with no way to check on it later
await DBOS.startWorkflow(processTask)("data");
// If something goes wrong, no way to find or debug it

Correct (listing and inspecting workflows):

// List workflows by status
const erroredWorkflows = await DBOS.listWorkflows({
  status: "ERROR",
});

for (const wf of erroredWorkflows) {
  console.log(`Workflow ${wf.workflowID}: ${wf.workflowName} - ${wf.error}`);
}

List workflows with multiple filters:

const workflows = await DBOS.listWorkflows({
  workflowName: "processOrder",
  status: "SUCCESS",
  limit: 100,
  sortDesc: true,
  loadOutput: true,
});

List enqueued workflows:

const queued = await DBOS.listQueuedWorkflows({
  queueName: "task_queue",
});

List workflow steps:

const steps = await DBOS.listWorkflowSteps(workflowID);
if (steps) {
  for (const step of steps) {
    console.log(`Step ${step.functionID}: ${step.name}`);
    if (step.error) console.log(`  Error: ${step.error}`);
    if (step.childWorkflowID) console.log(`  Child: ${step.childWorkflowID}`);
  }
}

Workflow status values: ENQUEUED, PENDING, SUCCESS, ERROR, CANCELLED, RETRIES_EXCEEDED

To optimize performance, set loadInput: false and loadOutput: false when you don't need workflow inputs or outputs.

Reference: Workflow Management