Files
clean-architecture-backend-…/docs/runbooks/internal-error-spike.md
T
DongHyeonka a81e92faca docs(runbooks): runbook을 한국어로 옮기고 상태를 초안·운영으로 바꾼다
문제: `docs/runbooks`의 runbook 38개가 영어였다(`check-docs.py` language
예외). 머리말 `status`는 `stub`·`active`였는데 문서 체계 규칙(design-docs
`conventions/docs-system.md` 1절)은 runbook 상태를 「초안 · 운영」으로 정한다.
번역하며 대조하니 지금 코드와 다른 주장도 있었다.

고친 것:
- 38개를 번역했다. 코드·명령·경로·설정 키·로그 문자열·표 구조는 그대로다.
  lane이 읽는 SQL·Redis 블록과 표지(`<!-- runbook-sql: … -->`)는 바이트 그대로다.
- `status`: stub → 초안 43개, active → 운영 3개, `template.md`는 `<초안|운영>`.
  머리말이 없는 gRPC runbook 둘은 그대로다.
- 코드에 맞춘 주장:
  - adapter-adapter-disabled: 없는 `adapter_name` 로그 칸 → `ServerFailureLog`의
    `failure classified as ADAPTER_DISABLED` 줄과 예외 메시지. 지금 이 코드를 내는
    곳은 `RoutingNotifier`뿐이다.
  - startup-required-adapter-disabled: `startup.phase=adapter-check` →
    `adapter-enablement`(`StartupPhase.ADAPTER_ENABLEMENT`).
  - cache-stampede-lock-timeout·cache-unavailable·file-download-streaming-failure:
    그 코드는 `error-codes.yaml`에 없고 어느 코드도 내지 않는다고 밝혔다.
  - db-idle-in-tx-timeout: 없는 `spring.jpa.properties.hibernate.connection.timeout`
    → `app.persistence-jpa.transaction.*`. db-query-canceled에 남은 시간 전달을 더했다.
  - dependency-timeout: 「기본 전체 10s」 → profile `timeout.total-call`
    (`HttpClientPlatformSettings` 기본 `4s`, 값은 configuration-reference를 가리킨다).
  - management-actuator-forbidden: 없는 break-glass runbook → 노출 제외 목록
    (`config/observability.yml`).
  - runtime-jvm-oom: 아무것도 쓰지 않는 `error.code=JVM_OOM` 로그를 지우고, 힙 덤프
    경로(`src/Dockerfile`)를 적었다.
  - auth-public-path-misconfiguration: 공개 경로는 `config/security.yml` `public-paths`.
  - grpc-advanced-capabilities: 지운 `GrpcAdvancedSupportMatrix` →
    `GrpcAdvancedCapability.defaultGrade()`, envoy 참조 설정의 실제 경로.
  - grpc-platform-operations: 없는 `runtime_memberships` → registry `"build": "optional-grpc"`.
- 다른 문서·코드가 영어 절 제목으로 인용하는 곳("Recover a failed concurrent index
  migration", "Classify the failure")은 한국어 제목 뒤 괄호에 영어를 남겼다. 인용하는
  쪽(테스트 fixture 메시지, `docs/upgrade`, 다른 세션 범위 문서)은 고치지 않아도 맞다.
- `RunbookCoverageContractTest`: `초안`을 초안으로 보고, 머리말 `status`가 `초안`·`운영`
  밖이면 실패하는 테스트를 더했다.
- `scripts/check-docs-exceptions.txt`에서 runbook language 줄 38개를 지웠다.

버린 대안: 옛 `stub`도 초안으로 계속 받기. 그러면 옛 표기로 쓴 초안이 운영
runbook으로 통과한다. 어휘 밖 값을 실패로 둬야 그 길이 막힌다.

위험·한계:
- 이미 한국어였던 runbook 11개는 `status`만 바꿨고 본문 감사는 하지 않았다.
- runtime-jvm-oom의 「종료 코드 137」은 원문대로 두었다. JVM의
  `-XX:+ExitOnOutOfMemoryError` 종료 코드는 3이고 137은 SIGKILL이라 확인이 필요하다.
- `docs/mongodb/runbooks/*.md`의 `status: active`는 이 테스트 밖이고 범위 밖이라 두었다.

검증: 아래 「검증」 줄은 영역 커밋 여섯이 합쳐진 최종 트리에서 돌렸다.

검증(desktop, 최종 트리 8295db89 = 이 묶음 마지막 커밋의 트리. 로그
`~/d2c-ops-docs-1-logs/`):
- `:app-bootstrap:documentContractTest` rc=0, 68개 실패 0(`RunbookCoverageContractTest` 7개).
  `:app-bootstrap:repositoryContractTest` rc=0, 65개 건너뜀 1(원래 그렇다) 실패 0.
- runbook SQL·Redis 블록을 문서에서 읽는 lane: persistence-jpa
  `postgresqlConcurrentIndexMigrationIntegrationTest`·`postgresqlDistributedLockIntegrationTest`·
  `postgresqlOutboxOrderKeyRunbookIntegrationTest`·`postgresqlOutboxDispositionRunbookIntegrationTest`
  rc=0(35개 실패 0), cache-redis `redisContainerContractTest` rc=0(103개 실패 0),
  `:composition:outbox-relay:mainCheck` rc=0. 모두 실행됨(FROM-CACHE는 다른 leaf의 main 컴파일뿐).
- RED: 새 테스트를 기준 커밋의 옛 runbook에 대면 `legacyStubDebtMustMatchEveryAndOnlyCurrentStubRunbook`과
  `everyRunbookFrontmatterDeclaresDraftOrOperatingStatus`가 실패한다("status=stub").
- `:app-bootstrap:spotlessCheck checkstyleTest testQualityCheck` rc=0.
- 커밋마다(노트북): `python3 scripts/check-docs.py` rc=0, `python3 -m unittest discover -s scripts/tests` rc=0.
2026-11-07 17:56:34 +09:00

3.2 KiB

title, category, error_codes, severity, owner, last_updated, status
title category error_codes severity owner last_updated status
Runbook — 5xx Internal error spike INTERNAL
INTERNAL_ERROR
INTERNAL_AUTH_MISCONFIGURATION
JVM_OOM
P1 oncall 2026-05-22 초안

Runbook: 5xx Internal error spike

1. Trigger

이 runbook은 다음 alert에서 발동됩니다.

  • alert name: http_5xx_error_rate_critical
  • alert payload 필수 field: operation, error.code, error.category, request_id, traceId, runbook_link
  • 임계: 5xx error rate > 5% 5분 지속 OR > 10% 1분

2. First Response (5분 이내)

Step 1 — 확인

  1. 가장 최근 deploy 시각 확인 (CI/CD dashboard, artifact registry digest)
  2. JVM metric 확인: heap usage, GC pause, CPU, thread count
  3. log에서 실패 request 1건 추출 → request_id, traceId 확보
  4. error.code 분포 확인: INTERNAL_ERROR vs JVM_OOM vs INTERNAL_AUTH_MISCONFIGURATION

Step 2 — 임시 격리

  • 직전 deploy가 의심되면 즉시 rollback (artifact registry에서 직전 image digest pin)
  • OOM 패턴이면 affected pod evict → ASG/HPA로 replacement 유도
  • LB에서 unhealthy pod 격리 (readiness probe failure 유도)

3. Diagnosis

  • log query: {service="app"} | http.status>=500 | stats count by error.code
  • metric panel: jvm_memory_used_bytes{area="heap"}, jvm_gc_pause_seconds, process_cpu_seconds_total, http_server_requests_seconds_count{status=~"5.."}
  • trace: 실패 request의 traceId로 span chain 확인 → stack trace에서 root exception 추출
  • heap dump 위치: /var/tmp/heap/heapdump-<pid>.hprof (JVM ergonomics: -XX:MaxRAMPercentage=75 -XX:+HeapDumpOnOutOfMemoryError)
  • 가능한 원인:
    • 직전 deploy의 회귀 버그 → rollback
    • JVM OOM (메모리 leak 또는 부하 증가) → heap dump 분석
    • 외부 의존성 설정 오류 (INTERNAL_AUTH_MISCONFIGURATION) → config secret 확인
    • thread starvation (pool 고갈) → thread dump (jstack <pid>)

4. Mitigation

  • 단기: 직전 deploy rollback, OOM pod replacement, traffic 일시 감소(scale-out 또는 rate-limit 강화)
  • config 오류면 secret/configmap rollback
  • 장기: heap dump 기반 leak 수정, capacity planning 재검토

5. Escalation

  • 다음 on-call로 page: 10분 내 회복 안 되면 incident commander 호출, severity 1 incident 선언
  • 데이터 손상 의심되면 DBA team page

6. Recovery / Verification

  • 회복 확인 metric: 5xx rate < 0.5% 5분 지속, JVM heap usage < 70%, GC pause p99 < 500ms
  • post-incident:
    • rollback 원인 RCA 작성 (배포 게이트 강화 필요 여부)
    • heap dump 분석 결과 공유
    • JVM ergonomics(-XX:MaxRAMPercentage) 재검토
    • rollback 자동화 절차 점검

Stub 상태 안내: 이 runbook은 skeleton 단계의 stub. 도메인 도입 시 실제 deploy 파이프라인·heap dump 보관 경로·rollback 자동화 명령으로 보강 필요.