Files
clean-architecture-backend-…/docs/runbooks/job-timeout.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

3.9 KiB

title, category, error_codes, severity, owner, last_updated, status
title category error_codes severity owner last_updated status
Runbook — background job timeout TRANSIENT_DEPENDENCY
JOB_TIMEOUT
P2 oncall 2026-11-13 초안

Runbook: background job timeout (runbook://job/timeout)

1. Trigger

JOB_TIMEOUT은 enum 상수와 registry 행이 있지만 템플릿 코드는 내지 않는다. job.retry.total도 서비스가 BackgroundJobMetrics.recordRetryOutcome을 부를 때만 생긴다. 그래서 이 runbook의 코드·지표 신호는 서비스가 job 시간 상한·재시도를 붙여 낼 때만 있다. 이 템플릿은 경보 규칙을 두지 않는다.

  • 템플릿이 내는 신호는 종료 때 하나다: async executor가 남은 작업을 19s 기다리고도 끝나지 않으면 Spring이 WARN 줄 Timed out while waiting for executor '<bean 이름>' to terminate를 남긴다 (AsyncExecutorConfig.AWAIT_TERMINATION_SECONDS). 남은 작업은 JVM이 끝날 때 함께 끊긴다.
  • 서비스가 낼 때 경보에 실을 만한 값: error.code=JOB_TIMEOUT, job_name, correlation_id
  • 임계: job.retry.total{outcome=RETRY} 급증

2. First Response (10분 이내)

Step 1 — 확인

  1. ERROR log에서 JOB_TIMEOUT 라인 확인: job_name, 마지막 단계, 소요 시간 추출
  2. timeout이 정상 실행 중 발생인지, graceful-shutdown(배포/스케일다운) 중 interrupt인지 구분
  3. 해당 job이 멱등(retry-on-next-cycle 안전)인지 확인 — 비멱등이면 §4에서 신중히 처리

Step 2 — 임시 격리

  • shutdown 중 interrupt면: 다음 기동 시 재시도 대상인지(멱등 전제) 확인, 중복 부작용 여부 점검
  • 정상 실행 중 timeout이면: 해당 job의 외부 의존성(DB/HTTP) 지연 여부 확인

3. Diagnosis

  • log query: {service="app"} | error.code="JOB_TIMEOUT" | stats count by job_name
  • metric panel: job.retry.total{job_name, outcome}
  • 가능한 원인 우선순위:
    • 외부 의존성(DB lock / 느린 HTTP) 지연으로 job p99 상승
    • job 작업량 증가로 단일 cycle이 19s 예산 초과 (D8 — interrupt 노출)
    • interrupt 미반응 blocking call(JDBC 등) → awaitTermination 초과 (K8S-POD-LC-C2 SIGKILL 경로)

4. Mitigation

  • 단기: 의존성 회복 / job 입력 배치 크기 축소
  • job p99가 구조적으로 19s를 넘으면: 작업을 분할하거나, grace period 연장 검토(parent project 운영 계약 소유자 승인 필요 — OUT_OF_BRANCH_SCOPE)
  • 비멱등 job이 재시도로 중복 부작용을 내면 멱등키/dedupe 도입 우선

5. Escalation

  • 의존성 지연이 근본 원인이면 해당 의존성 오너에게 escalate
  • 종료 예산은 차례로 더한 값이다: 웹 drain(APP_SERVER_SHUTDOWN_TIMEOUT, 기본 30s)이 끝난 뒤 async 대기 19s, 합계 49s에 preStop(5s)과 여유를 더한다. k8s terminationGracePeriodSeconds가 이보다 작으면(예: 기본 30s) async 대기 중 SIGKILL이다. compose는 60s(compose.yaml stop_grace_period, 합계는 DeveloperExperienceContractTest가 검사). 정합 이슈면 플랫폼/런타임 오너에게 escalate

6. Recovery / Verification

  • 회복 확인: JOB_TIMEOUT 신규 발생 멈춤, job.retry.total{outcome=SUCCESS} 정상 비율 회복
  • 멱등 재시도분의 부작용 중복 없음 확인
  • error-codes.yaml rows: JOB_TIMEOUT (TRANSIENT_DEPENDENCY, 500, retryable=true, retry_after 10s)
  • metrics.yaml: job.retry.total{job_name, outcome}
  • 코드: app-bootstrap async/AsyncExecutorConfig(awaitTermination 19s — D8 graceful shutdown)
  • env: APP_SERVER_SHUTDOWN_TIMEOUT(owner: feature-env-driven-runtime-configuration D2)
  • 관련 runbook: job-executor-rejected, job-dead-letter
  • 관련 branch: feature-background-job-async-contract (D4 retry / D8 shutdown)

Stub 상태 안내: 이 runbook은 skeleton 단계의 stub. 실제 retry carrier·job p99·shutdown 예산 확정 시 보강 필요.