Diagnostics Bundle Runbook

Operator runbook for quickly collecting triage artifacts. Canonical source: this runbook in angarabook/src/operations/.

Goal

diagnostics bundle should produce a predictable package:

• version and runtime environment;
• basic on-disk snapshot;
• config in redacted form;
• metrics and final artifact index.

Pinned commands

CLI (operator-facing, preferred for packaged distribution):

angara-cli diagnostics bundle \
  --root artifacts/diagnostics/incident-1 \
  --config /etc/angarabase/angarabase.conf \
  --data-dir /var/lib/angarabase/data \
  --txlog-dir /var/lib/angarabase/transaction_log \
  --json

Legacy tools entrypoint (workspace/dev path):

tools/diagnostics_bundle/run.sh --root artifacts/diagnostics/dev

With config and directories:

tools/diagnostics_bundle/run.sh \
 --root artifacts/diagnostics/incident-1 \
 --config /etc/angarabase/angarabase.conf \
 --data-dir /var/lib/angarabase/data \
 --txlog-dir /var/lib/angarabase/transaction_log

Structure validation:

tools/diagnostics_bundle/validate.sh <bundle_root>

Artifact layout (minimum)

• system.txt, versions.txt, env_angarabase.txt
• on_disk_inspect.json
• config.redacted.conf, config_redaction.txt
• metrics.prom (or metrics.prom.error.txt)
• summary.json
• ok.txt

Security policy

Secrets in config are redacted: values of keys matching password, secret, token, api_key are replaced with "<REDACTED>".

Evidence routing

• Heavy bundle is stored in artifacts/diagnostics/<stamp>/...
• Documentation records only compact pinned summaries/evidence pointers.

Next

• Troubleshooting guide — where to attach the collected bundle.
• Disaster recovery playbook — separate artifact set for DR escalations.
• Observability metrics checklist — which metrics to duplicate in the bundle.