Files
clean-architecture-backend-…/docs/runbooks/rate-limit-exceeded.md
T
DongHyeonka 0fded57cb3
pr / done (pull_request) Canceled after 0s
docs(runbooks): runbook 신호를 지금 코드가 내는 응답·로그·지표로 고친다
runbook이 코드가 내지 않는 신호로 장애를 찾게 한다. actuator·cross-tenant
runbook은 아무 코드도 내지 않는 ACTUATOR_FORBIDDEN·AUTHZ_TENANT_MISMATCH를
증상으로 적고, 없는 경보·지표·로그 칸을 적는다. auth runbook은 로그에서
token payload·Authorization 원문을 보라고 하고(남지도 않고 남겨서도 안
된다), 없는 JWKS 캐시 손잡이와 decoder가 읽지 않는 Spring issuer 키를
적는다. rate-limit·dependency runbook은 없는 gateway 지표·헤더·
CACHE_UNAVAILABLE·dependency_name 칸을, web runbook은 연산마다의 TTL,
시험 도구 GracefulShutdownProbe, 없는 tag routeTemplate, 기동이 거부하는
CORS 설정을 「기동은 된다」고 적는다. job runbook은 내는 코드가 없는
JOB_DEAD_LETTER·JOB_TIMEOUT과 job.* 지표에 경보를 걸게 한다.

각 runbook을 지금 코드가 내는 신호로 다시 쓴다: 응답 코드·헤더, 보안
로그 줄 `security failure: code=… path=…`, 요청 로그 줄, ServerFailureLog
의 고정 문구(`dependency failure classified as … dependency=<이름>`,
`persistence failure classified as …`), 실제 설정 키
APP_SECURITY_JWT_ISSUER, registry에 있는 지표. 이 템플릿에 경보 규칙이
없다는 것, 내는 코드가 없는 코드·지표는 서비스가 낼 때만 있다는 것을
적는다. 진단 순서도 고친다: actuator 노출은 관리 포트 9001로 가르고,
INTERNAL_AUTH_MISCONFIGURATION은 issuer discovery(4xx·issuer 불일치·
jwks_uri 없음은 500, 연결 실패·5xx·JSON 아님은 503)부터, 종료 예산은
웹 drain 30s + async 19s + preStop의 합으로 본다. 같은 원인의 다른
자리(경보 이름을 지어 적은 job·outbox·internal-error-spike, traceId로
적은 칸, 지적 밖 auth·dependency·db·outbox runbook, error-codes.yaml 주석,
같은 틀린 신호를 적은 shared-contract README·web README·
DependencyFailureException Javadoc)도 고치고, 본문의 리뷰 ID는 지운다.

버린 안: 선언만 있는 두 코드를 내는 WARN·counter를 새로 만들기. actuator
노출 밖 경로는 메인 chain이 401 AUTH_TOKEN_MISSING(익명)·404(인증됨)로
답해 403 상황이 없고, cross-tenant는 정한 규칙(남의 것은 404)이라 판정
자리가 서비스 코드에 있다. 새 신호는 서비스가 더할 일로 runbook에 적는다.

위험: 문서만 바뀐다. runbook은 모두 status 초안으로 둔다.
dependency-unavailable이 적은 hikaricp.connections.pending·timeout 행과
job.* 행의 emitted_when은 관측 registry 변경(같은 묶음의 다른 PR)이
더하고, auth-jwks-unavailable의 「캐시가 지난 뒤 503」은 인증 PR의 JWKS
재조회 분류 수정이 만든다. 세 PR을 함께 병합한다.

검증: python3 scripts/check-docs.py·check-work-docs.py OK, desktop
:app-bootstrap:documentContractTest :app-bootstrap:repositoryContractTest,
scripts/verify.sh pr rc=0.

Refs: RR9-02-04, RR9-02-24, RR9-04-34, RR9-04-37
2026-11-13 09:35:50 +09:00

38 lines
2.2 KiB
Markdown

---
title: Runbook — Rate limit 초과 spike
category: RATE_LIMIT
error_codes: [RATE_LIMIT_EXCEEDED, IDEMPOTENT_IN_FLIGHT]
severity: P3
owner: oncall
last_updated: 2026-11-13
status: 초안
---
# Runbook: Rate limit 초과 spike
## 증상
- HTTP 429 `RATE_LIMIT_EXCEEDED`, `Retry-After`(초), `X-RateLimit-Limit`·`X-RateLimit-Remaining`·`X-RateLimit-Reset` 헤더(`RateLimitInterceptor`). 저장소에 닿지 못하면 503 `RATE_LIMIT_UNAVAILABLE`이다.
- 앱 안 limiter는 기본으로 꺼져 있다(`APP_RATE_LIMIT_ENABLED=false`, `docs/security/rate-limiting.md`). 켠 서비스에서만 이 증상이 난다.
- 429에는 전용 WARN 줄이 없다. 요청 로그 INFO 줄 `http_request method=… uri_template=… status=429 duration_ms=…`(`RequestLoggingFilter`, `APP_LOG_SAMPLING_RATE` 표본)과 `http.server.requests`의 `status=429`가 신호다. 이 템플릿은 경보 규칙·대시보드를 두지 않는다. 서비스가 그 둘로 만든다.
- `IDEMPOTENT_IN_FLIGHT`는 요청률 제한이 아니다. 같은 멱등 키의 요청이 아직 처리 중이라는 409(CONFLICT)다(`docs/web/runbook.md`).
## 진단
- limiter key는 「호출자 × 연산」이다(`RateLimitKeyResolver`). 호출자는 인증된 사용자, `service` 역할을 가진 principal(종류 이름 `API_KEY`, header의 API key가 아니다), 인증이 없으면 client IP(`getRemoteAddr()`)다. 연산은 method와 route template(`GET /v1/orders/{id}`)이다. tenant 단위는 없다. 호출자 값(사용자 id·IP)은 가명으로 바꿔 쓰고 로그·지표에 남기지 않는다.
- 정책 값(`APP_RATE_LIMIT_LIMIT`·`_WINDOW` 등)은 정책 id마다 하나이고 재시작해야 바뀐다. key 하나만 올리는 손잡이는 없다.
## 조치
- 남용이면 앞단(WAF·gateway)에서 막는다.
- 정상 트래픽이 늘었으면 정책 값을 올리고 재배포한다.
- 클라이언트가 `Retry-After`를 지키지 않고 재시도하면 backoff를 요청한다.
## 에스컬레이션
- 정상 클라이언트가 30분 넘게 막히면 제품 팀에 알린다.
---
> **Stub 상태 안내**: 이 runbook은 skeleton 단계의 stub. 도메인 도입 시 실제 gateway 제품(NGINX/Envoy/Kong 등)·tenant tier 정책·WAF 연동 절차로 보강 필요.