Skip to content

Document operator use of vigilante logs for blocked-session recovery and daemon triage #285

@nicobistolfi

Description

@nicobistolfi

Summary

Add operator-facing guidance for using vigilante logs when triaging blocked sessions, deciding whether to resume or redispatch, running cleanup, or diagnosing daemon-level problems.

Problem

  • Vigilante exposes local logs, but the operator workflows around list, resume, redispatch, cleanup, and daemon/service troubleshooting do not yet appear to describe when logs should be consulted.
  • That leaves an observability capability implemented but not well integrated into the control-plane operating model.

Context

  • The repository already describes persistent local state under ~/.vigilante/, including logs/ for daemon and run logs.
  • The feature set also calls out daemon log streams and per-issue session logs as part of observability and audit.
  • Operator-facing recovery commands already exist for blocked and stalled sessions.

Desired Outcome

  • The docs or operator workflow guidance should make it clear when to use vigilante logs with no flags versus vigilante logs --repo <owner/name> --issue <n>.
  • The guidance should connect log inspection to concrete recovery decisions such as whether to resume, cleanup, redispatch, or restart the service.
  • Non-goal: changing the semantics of the recovery commands themselves.

Implementation Notes

  • Update the operator-facing documentation, likely in README.md and any relevant recovery or observability sections, to include a short log-triage flow.
  • Cover both daemon-level investigation and per-issue investigation.
  • Keep the workflow concise and procedural so it is useful during active incident triage.

Acceptance Criteria

  • The documentation explains when to run vigilante logs without flags and when to use --repo plus --issue.
  • The guidance connects log inspection to at least these recovery actions: resume, redispatch, cleanup, and daemon/service troubleshooting.
  • The resulting docs treat logs as a complement to session state and GitHub comments, not a replacement for them.

Testing Expectations

  • Update any CLI or docs tests if the repository checks command usage examples or README snippets.
  • Manually verify that an operator can follow the documented steps to move from a blocked session to the next correct command.

Operational / UX Considerations

  • This should strengthen the observability story already described in the repository without expanding command surface area.
  • Keep examples copyable and aligned with the implemented vigilante logs syntax.

Metadata

Metadata

Assignees

Labels

vigilante:doneVigilante completed its work on the issue and no further automation is expected.

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions