Traefik 헬스 체크 문서
Traefik 헬스 체크 문서 (Traefik Health Check Documentation)
본문
CLI & Ping
Traefik 인스턴스의 건강 상태 확인하기
CLI
CLI를 사용해 /ping 엔드포인트에 요청을 보내 Traefik의 건강 상태를 확인할 수 있어요. Traefik이 건강하면 종료 상태(exit status)가 0이고, 그렇지 않으면 1이에요.
이는 HEALTHCHECK 명령이나 다른 어떤 헬스 체크 오케스트레이션 메커니즘과도 함께 사용할 수 있어요.
사용법 (Usage)
traefik healthcheck [command] [flags] [arguments]
예시:
$ traefik healthcheck
OK: http://:8082/ping
Ping
/ping 헬스 체크 URL은 명령줄 --ping 옵션이나 설정 파일의 [ping] 옵션으로 활성화돼요.
/ping이 활성화되는 entryPoint는 entryPoint 옵션으로 커스터마이즈할 수 있는데,
기본값은 traefik(포트 8080)이에요.
| 경로 (Path) | 메서드 (Method) | 설명 (Description) |
| /ping | GET, HEAD | Traefik 프로세스 살아있음(liveness)을 확인하는 엔드포인트. 내용 OK와 함께 200 코드를 반환해요 |
설정 예시 (Configuration Example)
API 핸들러를 활성화하려면:
파일 (YAML)
ping: {}
파일 (TOML)
[ping]
CLI
--ping=true
설정 옵션 (Configuration Options)
| 필드 (Field) | 설명 (Description) | 기본값 (Default) | 필수 (Required) |
| ping.entryPoint | 전용 EntryPoint에서 /ping을 활성화해요. | traefik | 아니오 (No) |
| ping.manualRouting | true로 설정하면 기본 내부 라우터를 비활성화해 ping@internal 서비스용 커스텀 라우터를 만들 수 있게 해 줘요. | false | 아니오 (No) |
| ping.terminatingStatusCode | 정상 종료(graceful shut down) 중 ping 핸들러가 반환할 상태 코드를 정의해요. 자세한 내용은 여기를 참고하세요 | 503 | 아니오 (No) |
terminatingStatusCode
Traefik이 정상 종료되는 동안 ping 핸들러는 기본적으로 503 상태 코드를 반환해요.
예를 들어 Traefik 뒤에 헬스 체크를 수행하는 로드 밸런서(Kubernetes LivenessProbe 같은)가 있다면,
정상 종료의 신호로 다른 코드를 기대할 수도 있어요.
그런 경우 terminatingStatusCode를 사용해 종료 중 ping 핸들러가 반환할 코드를 설정할 수 있어요.
파일 (YAML)
ping:
terminatingStatusCode: 204
파일 (TOML)
[ping]
terminatingStatusCode = 204
CLI
--ping.terminatingStatusCode=204