Diagnostics Bundle Runbook

Операторский runbook для быстрого сбора triage-артефактов. Каноничный источник: этот runbook в angarabook/src/operations/.

Goal

diagnostics bundle должен давать предсказуемый пакет:

версия и среда запуска;
базовый on-disk снимок;
конфиг в redacted-виде;
метрики и итоговый индекс артефактов.

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

С конфигом и директориями:

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

Валидация структуры:

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 (или metrics.prom.error.txt)
summary.json
ok.txt

Security policy

Секреты в конфиге редактируются: значения ключей по шаблонам password, secret, token, api_key заменяются на "<REDACTED>".

Evidence routing

Heavy bundle хранится в artifacts/diagnostics/<stamp>/...
В документации фиксируются только компактные pinned summaries/evidence pointers.

Дальше

Troubleshooting guide — куда подкладывать собранный bundle.
Disaster recovery playbook — отдельный набор артефактов для DR-эскалаций.
Observability metrics checklist — какие метрики дублировать в bundle.

Keyboard shortcuts