Files
clean-architecture-backend-…/docs/runbooks/dependency-unavailable.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.8 KiB

title, category, error_codes, severity, owner, last_updated, status
title category error_codes severity owner last_updated status
Runbook — 외부 의존성 unavailable TRANSIENT_DEPENDENCY
DEPENDENCY_TIMEOUT
DEPENDENCY_CONNECT_FAILED
DEPENDENCY_DNS_FAILED
DEPENDENCY_CIRCUIT_OPEN
DEPENDENCY_5XX_SERVER
CACHE_UNAVAILABLE
DB_UNAVAILABLE
P1 oncall 2026-05-22 초안

Runbook: 외부 의존성 unavailable

1. Trigger

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

  • alert name: dependency_error_rate_critical 또는 circuit_breaker_open
  • alert payload 필수 field: operation, error.code, error.category, dependency_name, dependency_kind(required|optional), runbook_link
  • 임계:
    • P1: required dependency의 error rate > 50% 1분 OR circuit_open state 활성
    • P2: optional dependency degraded (fail-open으로 동작 중)

2. First Response (5분 이내)

Step 1 — 확인

  1. dependency_name 별 status page 확인 (외부 SaaS면 vendor status, internal이면 해당 service dashboard)
  2. log query로 실패 패턴 확인: timeout / connect / DNS / 5xx 중 어떤 모드인지
  3. runtime-health Dependency Matrix에서 required vs optional 분류 확인
  4. circuit breaker state 확인 (Resilience4j metric)

Step 2 — 임시 격리

  • required dep이면 readiness probe로 traffic 차단 (회복 대기) — cascade failure 방지
  • optional dep이면 fail-open with degraded mode 확인. degraded banner를 client에 노출
  • DNS failure면 resolver/coredns 상태 확인. cache 강제 flush 검토

3. Diagnosis

  • log query: {service="app"} | dependency_name="<name>" | stats count by error.code
  • metric panel:
    • resilience4j_circuitbreaker_state{name="<name>"}
    • resilience4j_retry_calls_total{kind="failed_without_retry"}
    • hikaricp_connections_active, hikaricp_connections_pending (DB_UNAVAILABLE)
    • http_client_requests_seconds_count{outcome="SERVER_ERROR"}
  • trace: 실패 request의 outbound span에서 timeout/connect/DNS 분류, target endpoint 확인
  • 가능한 원인:
    • vendor outage → status page 확인, 회복 대기
    • 네트워크 문제 (DNS, security group, NAT) → infra team 확인
    • connection pool 고갈 (Hikari) → pool size/timeout 점검
    • circuit breaker open 후 half-open 전환 실패 → 수동 reset 검토
    • retry-storm으로 인한 self-DoS → retry budget 축소

4. Mitigation

  • 단기: required면 회복 대기 + traffic 차단, optional이면 degraded mode로 유지
  • pool 고갈이면 일시 pool size 상향 + leak detection 활성화
  • circuit이 stuck이면 수동 reset (actuator/circuitbreakerevents)
  • 장기: retry budget·timeout·circuit 임계 재조정, fallback path 보강, vendor SLA 재협상

5. Escalation

  • 다음 on-call로 page: required dep 5분 내 회복 안 되면 외부 dep team 또는 vendor에 page
  • 다중 dep 동시 장애면 incident commander 호출 (네트워크 전반 문제 의심)

6. Recovery / Verification

  • 회복 확인 metric: dependency error rate < 1% 5분 지속, circuit_breaker_state = CLOSED, pool utilization 정상
  • post-incident:
    • vendor postmortem 요청 (외부 SaaS면)
    • timeout/retry/circuit 설정 재검토
    • degraded mode가 사용자 경험에 미친 영향 측정
    • chaos test에 해당 시나리오 추가
  • error-codes.yaml rows: DEPENDENCY_TIMEOUT, DEPENDENCY_CONNECT_FAILED, DEPENDENCY_DNS_FAILED, DEPENDENCY_CIRCUIT_OPEN, DEPENDENCY_5XX_SERVER, CACHE_UNAVAILABLE, DB_UNAVAILABLE
  • metrics.yaml: resilience4j_circuitbreaker_state, hikaricp_connections_active, http_client_requests_seconds_count
  • 관련 branch: feature-outbound-http-client-baseline, feature-persistence-failure-baseline

Stub 상태 안내: 이 runbook은 skeleton 단계의 stub. 도메인 도입 시 실제 dependency 목록·required/optional 분류·vendor 연락 체계·circuit/timeout 임계로 보강 필요.