문제: 설계서·계획서·납품 패키지·증거·학습 문서와 ADR이 기록이라는 표시 없이 지금 문서처럼 읽힌다. 상태 칸이 설계서 72개 중 40개, 계획서는 거의 없고, 있어도 Approved·확정·Accepted.처럼 값이 제각각이며 영어다. 고른 방법: docs/design, docs/history, docs/adr, docs/notification/adr의 .md 246개 맨 위에 같은 모양의 머리 블록을 단다. 칸은 상태·작성일· 요약(한국어 한 문장)·현재 정본, 대체됐으면 대체됨이다. 블록은 표시 줄 두 개로 감싸서 빼면 원문 바이트가 그대로 돌아온다(246개 모두 대조함). - 종류는 폴더가 정하고 둘째 줄에 적는다(plans/evidence는 증거). - 상태는 원래 상태 줄을 고정 어휘로 바꾼 값이다. 상태 줄이 없는 설계서와 체크 상자가 다 표시되지 않은 계획서는 「확인 안 함」. capability-status.md 제거 표로 지운 것이 확인된 설계서 다섯은 「폐기」, 2026-07-20 하네스 설계·계획과 production capability platform 설계는 「대체됨」이다. - 현재 정본은 구조 정리로 옮겨질 수 있는 src/messaging·src/grpc 대신 docs/ 쪽 문서나 옮기지 않는 leaf README를 가리킨다. docs/README.md에 「문서 수명과 언어」「기록 문서의 머리 블록」「문서와 코드를 같은 변경에서 고친다」를 더하고, 파생 서비스 안내에 머리 블록 충돌 가능성을 적었다. 버린 대안: H1 제목 아래에 블록을 두는 안은 보기에는 낫지만 빼는 규칙이 파일마다 달라져 원문 복원이 기계적이지 않다. 「종류」 칸을 따로 두는 안은 폴더와 같은 정보를 두 번 쓰게 한다. 위험·한계: 「확인 안 함」 설계서 38개, 계획서 51개는 지금 유효한지 아무도 판정하지 않았다. 요약은 제목·목표 줄을 보고 쓴 것이라 본문을 끝까지 읽지 않았다. 납품 패키지 셋의 MANIFEST.sha256는 이제 맞지 않는다 (납품 당시 바이트의 해시이고, 블록을 빼면 다시 맞는다). 리뷰 폴더에는 아직 머리 블록을 달지 않았다. 검증: 머리 블록을 뺀 내용과 HEAD 원본 246개 일치, check-work-docs.py rc=0, --links docs·README.md·CLAUDE.md·AGENTS.md 깨진 링크 0.
2.3 KiB
기록 · 설계서 본문은 쓴 때의 원문이다. 지금 동작은 「현재 정본」을 읽는다.
- 상태: 확인 안 함
- 작성일: 2026-09-18
- 요약: app-bootstrap 경고 로그를 구조화된 필드로 모으는 작은 설계다.
- 현재 정본:
docs/observability/log-fields.md
Bootstrap Structured Log Fields
Goal
Close BOOT-009 without changing failure classification or log severity.
The composition root already centralizes startup failures in StartupFailures and runtime warning frames in RuntimeWarnings. The remaining scheduler/decorator log sites must use the same principle: human-readable text may vary, but operator-facing dimensions use stable structured field names.
Rules
- startup failures use
startup.phase,error.codeanderror.category; - a root cause may add
error.root_cause.classanderror.root_cause.message; - runtime warnings use
warning.kindplus bounded context such ascapability,operationormeter; - scheduled retry behavior is exposed as
retry.dispositionrather than embedded only in prose; - bounded cleanup counters use
cleanup.*fields; - asynchronous executor rejection uses
error.code/error.categoryplusexecutor_name,policyandqueue_size; - unbounded identifiers must not become structured fields merely for convenience. In particular,
distributed-lock keys remain message text and are not emitted as
lock.key.
No error.code is invented for the outbox scheduler's catch-all failure because that exception may
come from claim, status transition, metrics refresh or another relay-cycle concern. It is not
necessarily an OUTBOX_PUBLISH_FAILED event.
Verification
BootstrapStructuredRuntimeLoggingTest captures real Logback events and checks the structured
argument set for fileserver cleanup success/failure, outbox relay catch-all retry and lock lease
expiry.
Verified result
- BootstrapStructuredRuntimeLoggingTest: PASS;
- app-bootstrap Spotless, full test and architectureTest: PASS;
- production WARN/ERROR scan found zero candidates without structured kv/v arguments;
- docs/observability/log-fields.md is the field-name/cardinality SSOT;
- git diff --check: PASS.