BMAD-METHOD/src/bmm-skills/4-implementation/bmad-story-automator-go/data/monitoring-pattern.md

5.9 KiB

Session Monitoring Pattern

Quick Reference

All monitoring is handled by the story-automator binary. DO NOT manually construct tmux commands.

Binary Location

bin/
└── story-automator  # single Go binary (use subcommands below)

🚨 FORBIDDEN PATTERNS (NO EXCEPTIONS)

Pattern Why Forbidden
tmux capture-pane directly Context bloat, use status script
while true loops in LLM context Session crash, use story-automator monitor-session
Manual session name construction Error-prone, use story-automator tmux-wrapper
Parsing raw output yourself Use story-automator orchestrator-helper parse-output

Standard Workflow: Spawn + Monitor + Parse

# STEP 1: Spawn session (use story-automator tmux-wrapper)
session_name=$("$scripts" tmux-wrapper spawn create 5 5.3 \
  --command "$("$scripts" tmux-wrapper build-cmd create 5.3)")

# STEP 2: Monitor until completion (SINGLE API CALL)
result=$("$scripts" monitor-session "$session_name" --verbose --json)

# STEP 3: Parse output with sub-agent
output_file=$(echo "$result" | jq -r '.output_file')
parsed=$("$scripts" orchestrator-helper parse-output "$output_file" create)

# STEP 4: Act on parsed result
next_action=$(echo "$parsed" | jq -r '.next_action')

# STEP 5: ALWAYS cleanup session (v1.2.0)
"$scripts" tmux-wrapper kill "$session_name"

Context savings: This entire cycle is 5 bash calls instead of 15+ API roundtrips.

Session Cleanup (v1.2.0): ALWAYS kill the session after processing, regardless of success or failure. Orphaned sessions consume resources and cause confusion.


Script Quick Reference

story-automator tmux-wrapper

# Spawn session
story-automator tmux-wrapper spawn <step> <epic> <story_id> [--command "..."] [--cycle N]

# Generate session name only
story-automator tmux-wrapper name <step> <epic> <story_id> [--cycle N]

# Build workflow command
story-automator tmux-wrapper build-cmd <step> <story_id> [extra_instruction]

# List/kill sessions
story-automator tmux-wrapper list [--project-only]
story-automator tmux-wrapper kill <session_name>
story-automator tmux-wrapper kill-all [--project-only]

story-automator monitor-session

# Monitor until completion (returns when session ends)
story-automator monitor-session <session_name> [options]

# Options:
#   --max-polls N     Maximum iterations (default: 30)
#   --timeout MIN     Overall timeout in minutes (default: 60)
#   --verbose         Print progress to stderr
#   --json            Output as JSON instead of CSV

# Output (JSON):
# {"final_state":"completed|crashed|stuck|timeout|incomplete|not_found","output_file":"/tmp/...","exit_reason":"..."}

story-automator orchestrator-helper

# Check sprint status
story-automator orchestrator-helper sprint-status get <story_key>

# Parse session output with sub-agent (haiku)
story-automator orchestrator-helper parse-output <file> <step_type>

# Marker file operations
story-automator orchestrator-helper marker create --epic E --story S --remaining N
story-automator orchestrator-helper marker remove
story-automator orchestrator-helper marker check

# Escalation checks
story-automator orchestrator-helper escalate <trigger> <context>

story-automator validate-story-creation

# Count before session
before=$(story-automator validate-story-creation count 5.3)

# ... run create-story session ...

# Count after and validate
after=$(story-automator validate-story-creation count 5.3)
story-automator validate-story-creation check 5.3 --before $before --after $after

Decision Flow

After story-automator monitor-session returns:

final_state Action
completed Parse output → act on next_action
incomplete (v2.2) Session idle but workflow NOT verified → Escalate immediately
crashed Check retry count → retry or escalate
stuck Get output → investigate → may need restart
timeout Get output → escalate to user
not_found Session gone → check for partial work

Monitoring Failure Fallback (v1.9.0)

See monitoring-fallback.md for complete fallback patterns when monitoring fails.

Key points:

  • If monitoring crashes, tmux session may have completed successfully
  • Fall back to direct session checks + source of truth verification
  • Do NOT treat monitoring failure as step failure

Statusline Time Gate (v2.6.0)

Purpose: Prevent ALL false "stuck" escalations by using the Claude Code statusline as definitive proof-of-life.

How It Works

Claude Code displays a statusline at the bottom of the terminal:

folder | ctx(N%) | HH:MM:SS
                   ^^^^^^^^ <- This time updates continuously while Claude runs

The story-automator tmux-status-check script:

  1. Parses the statusline time from the tmux pane
  2. Stores it in the session state file
  3. Compares with previous poll's time
  4. If time has advanced → session is ALIVE → DO NOT escalate

Decision Matrix

Previous Time Current Time Other Checks Say Result
10:00:00 10:01:00 stuck just_started (time advanced = alive)
10:00:00 10:00:00 stuck stuck (time unchanged)
(none) 10:00:00 stuck just_started (first observation = alive)
(none) (none) stuck stuck (no statusline data)

Key Principle

The statusline time gate is the FINAL AUTHORITY. Even if all other detection methods (process checks, activity indicators, heartbeat) suggest the session is stuck, if the statusline time has advanced, the session is definitively alive and MUST NOT be escalated.

This prevents false escalations for:

  • Complex sessions in long thinking phases
  • Sessions with unusual output patterns
  • Edge cases where other detection fails

References

  • Codex monitoring details: monitoring-codex.md
  • Output parsing + review handling: monitoring-pattern-parsing.md