이 페이지는 Apigee 및 Apigee Hybrid에 적용됩니다.
Apigee Edge 문서 보기
Apigee는 사용 사례에 따라 활용할 수 있는 여러 수준에서 상태 점검을 노출합니다.
- 리전 수준 / Apigee 인스턴스 상태 점검: 한 리전의 전체 Apigee 인스턴스 상태를 반환합니다.
- 환경 수준 상태 점검: Apigee 인스턴스에서 특정 환경의 상태를 반환합니다.
- API 프록시를 통한 커스텀 상태 점검: 복잡한 사용 사례의 경우 전용 API 프록시를 커스텀 상태 점검 엔드포인트로 구성할 수 있습니다.
리전 수준 상태 확인 수행
Apigee는 리전 수준 / Apigee 인스턴스 상태 점검을 제공하여 특정 리전에 있는 Apigee 인스턴스의 전반적인 상태를 평가합니다. 부하 분산기에서 널리 사용하는 상태 점검 패턴은 Apigee 인스턴스의 상태를 확인하고 리전 장애 조치를 수행합니다. 다음과 같이 요청을 작성하여 리전 수준의 상태 점검을 수행할 수 있습니다.
- 상태 점검 경로:
/healthz/ingress
- 요청 헤더 추가:
User-Agent: GoogleHC
.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/ingress Apigee Ingress is healthy
$HOST
는 부하 분산기에서 제공하는 Apigee 환경 그룹에 정의된 호스트 이름을 나타냅니다.
환경 수준 상태 확인 수행
Apigee는 Apigee 인스턴스에서 제공하는 특정 환경의 상태를 평가하는 환경 수준의 상태 점검을 제공합니다. 이 상태 점검 패턴은 특정 중요/선택 환경의 상태에 따라 리전 장애 조치를 수행하려는 경우에 선호됩니다. 다음과 같이 요청을 작성하면 환경에서 유효한 API 프록시를 호출하여 환경 수준의 상태 점검을 수행할 수 있습니다.
- 프록시 기본 경로 앞에
/healthz/
를 추가합니다. - 요청 헤더 추가:
User-Agent: GoogleHC
.
예를 들어 /catalog
가 환경에 배포된 유효한 프록시 기본 경로라고 가정해 보세요. 상태 점검을 수행하려면 다음과 같이 프록시를 호출합니다.
$ curl -H 'User-Agent: GoogleHC' https://$HOST/healthz/catalog Server Ready
$HOST
는 부하 분산기에서 제공하는 Apigee 환경 그룹에 정의된 호스트 이름을 나타냅니다.
API 프록시를 통해 커스텀 상태 확인 수행
추가 검증을 수행하려면 환경에 배포된 API 프록시에서 커스텀 상태 점검 로직을 정의할 수 있습니다. 예를 들어 여러 환경이 작동 중지되면 상태 점검이 실패할 수 있습니다. 또는 대상 상태 또는 지연 시간에 따라 상태 점검이 실패할 수 있습니다.
이 경우에는 해당 프록시에 대한 일반 API를 호출하여 상태 점검을 수행할 수 있습니다.
예를 들어 prod
라는 환경의 상태를 확인하려 한다고 가정해 보세요.
기본 경로 /healthcheck-prod
를 사용하여 해당 환경에 API 프록시를 배포합니다.
Apigee 인스턴스에서 제공하는 prod
환경의 상태를 확인하려면 다음과 같이 프록시를 호출합니다.
$ curl https://$HOST/healthcheck-prod
$HOST
는 부하 분산기에서 제공하는 Apigee 환경 그룹에 정의된 호스트 이름을 나타냅니다.
사용 참고사항
리전 수준 및 환경 수준 상태 점검의 경우: Google Cloud 부하 분산기에서 이를 수행하는 경우 부하 분산기가 올바른 .User-Agent
헤더를 설정합니다. 클라이언트가 이 상태 점검 API 호출을 사용하는 경우에는 올바른 User-Agent
가 설정되었는지 확인해야 합니다.
Apigee Hybrid의 경우: 상태 점검 기능은 버전 1.4 이상에서만 사용할 수 있습니다.