superplane-monitor

SuperPlane Monitor

Inspect, debug, and manage workflow executions.

Quick Reference

Task	Command
List runs for app	superplane runs list --app-id <id>
Describe a run (node executions)	superplane runs describe <run-id> --app-id <id>
List node executions	superplane executions list --app-id <id> --node-id <nid>
Cancel execution	superplane executions cancel --app-id <id> --execution-id <eid>
List queued items	superplane queue list --app-id <id> --node-id <nid>
Delete queued item	superplane queue delete --app-id <id> --node-id <nid> --item-id <iid>

Verify CLI Is Installed

Before any debugging, confirm the CLI binary is available without requiring network access:

command -v superplane

If this does not print a path: stop and tell the user to install the CLI from https://docs.superplane.com/installation/cli. Debugging requires the CLI to inspect runs, executions, and queues.

Then verify the current session:

superplane whoami

If whoami fails because of authentication, DNS, timeout, or connection issues, the CLI is installed but the session is not usable yet. Tell the user to connect, fix the context, or allow network access as needed before debugging through the CLI.

If debugging will require canvas edits, stage changes and commit, or apply directly with --message:

superplane apps staging update --file canvas.yaml
superplane apps staging commit --message "Fix canvas"
# or:
superplane apps canvas update -f canvas.yaml --message "Fix canvas"

Debugging Workflow

1. Find the App

superplane apps list

2. List Recent Runs

superplane runs list --app-id <app_id>

Each run is a trigger firing through the full canvas.

3. Inspect the Run

superplane runs describe <run_id> --app-id <app_id>

Look for node executions that are:

• Failed — the node that errored
• Pending/Running — possibly stuck
• Skipped — bypassed by a branch (If/Filter)

4. Inspect a Node's History and Payloads

superplane executions list --app-id <app_id> --node-id <node_id> -o yaml

Check if failures are recurring. For expression errors, inspect the actual payload structure:

• rootEvent.data.data — the trigger's real event payload (the double .data is the event envelope wrapping the webhook payload)
• input — what the node received from its upstream node (also has { data, timestamp, type } envelope)
• resultMessage — the exact error, including which expression field was nil

Use these real payloads to fix expression paths rather than guessing from documentation.

For branching/channel issues, inspect outputs in execution YAML (not just top-level result):

• A node can show result: RESULT_PASSED while routing onto a failure channel — these are independent (runtime health vs. semantic routing). See Execution result vs. output channel before flagging this as a bug.
• Confirm emitted channel names under outputs match edge wiring (success, failed, default, etc.)
• If downstream behavior looks inconsistent with runs describe, trust the node's outputs block for routing truth

5. Fix and Re-run

Update the canvas, then trigger a new run from the UI or via a start (Manual Run) trigger with configured templates.

superplane apps staging update --file canvas.yaml
superplane apps staging commit --message "Fix canvas"
# or:
superplane apps canvas update -f canvas.yaml --message "Fix canvas"

Common Failure Patterns

Auth Failure

Node fails immediately with permission error. Check:

superplane integrations list
superplane secrets list

Verify the integration is connected and the secret is valid.

Expression Error

Node fails referencing a missing field. Check:

• Node name matches exactly (case-sensitive) in $['Node Name']
• Upstream node actually emits the expected field
• Root payload contains the expected data

Stuck Queue

Executions pile up without progressing:

superplane queue list --app-id <id> --node-id <nid>

Causes: node is paused, Approval waiting for human input, Time Gate holding, external service unresponsive.

Clear stuck items:

superplane queue delete --app-id <id> --node-id <nid> --item-id <iid>

Merge Never Fires

Merge waits for ALL incoming edges. If one branch is stuck, filtered out, or failed, Merge blocks. Check every upstream branch.

When to Use Other Skills

Need	Use Skill
Create or modify a canvas	superplane-app-builder
CLI commands and authentication	superplane-cli

Documentation

For agents that can fetch URLs, the full SuperPlane docs are available in LLM-friendly format:

• Compact index: https://docs.superplane.com/llms.txt
• Full content: https://docs.superplane.com/llms-full.txt