Amazon API Gateway 차원 및 지표 - Amazon API Gateway

Amazon API Gateway 차원 및 지표

API Gateway가 Amazon CloudWatch에 전송하는 지표와 차원은 다음과 같습니다. 자세한 내용은 Amazon CloudWatch 지표를 사용한 REST API 실행 모니터링 단원을 참조하세요.

API Gateway 지표

Amazon API Gateway는 1분마다 지표 데이터를 CloudWatch로 전송합니다.

AWS/ApiGateway 네임스페이스에는 다음 지표가 포함되어 있습니다.

지표 설명

4XXError

지정한 기간 내에 캡처된 클라이언트 측 오류 수

API Gateway는 수정된 게이트웨이 응답 상태 코드를 4XXError 오류로 계산합니다.

Sum 통계는 이 지표 즉, 지정된 기간 내 총 4XXError 오류 개수를 나타냅니다. Average 통계는 4XXError 오류율 즉, 총 4XXError 오류 개수를 해당 기간 동안의 총 요청 수로 나눈 것입니다. 분모는 Count 지표에 해당합니다(아래).

Unit: Count

5XXError

지정한 기간 내에 캡처된 서버 측 오류 수.

Sum 통계는 이 지표 즉, 지정된 기간 내 총 5XXError 오류 개수를 나타냅니다. Average 통계는 5XXError 오류율 즉, 총 5XXError 오류 개수를 해당 기간 동안의 총 요청 수로 나눈 것입니다. 분모는 Count 지표에 해당합니다(아래).

Unit: Count

CacheHitCount

지정된 기간 내 API 캐시에서 처리한 요청 수

Sum 통계는 이 지표 즉, 지정된 기간 내 총 캐시 적중 수를 나타냅니다. Average 통계는 캐시 적중률 즉, 총 캐시 적중 수를 해당 기간 동안의 총 요청 수로 나눈 것입니다. 분모는 Count 지표에 해당합니다(아래).

Unit: Count

CacheMissCount

API 캐싱이 활성화되어 있을 때 지정된 기간 동안 백엔드에서 처리된 요청 수

Sum 통계는 이 지표 즉, 지정된 기간 내 총 캐시 누락 수를 나타냅니다. Average 통계는 캐시 누락률 즉, 총 캐시 누락 수를 해당 기간 동안의 총 요청 수로 나눈 것입니다. 분모는 Count 지표에 해당합니다(아래).

Unit: Count

Count

지정된 기간 동안의 총 API 요청 수.

SampleCount 통계는 이 지표를 나타냅니다.

Unit: Count

IntegrationLatency

API Gateway가 요청을 백엔드로 릴레이할 때부터 백엔드에서 응답을 수신할 때까지의 시간입니다.

Unit: Millisecond

Latency

API Gateway가 클라이언트에서 요청을 수신할 때부터 클라이언트에게 응답을 반환할 때까지의 시간입니다. 지연 시간에는 통합 지연 시간과 기타 API Gateway 오버헤드가 포함됩니다.

Unit: Millisecond

지표 차원

다음 표의 차원을 사용하여 API Gateway 지표를 필터링할 수 있습니다.

참고

API Gateway는 지표를 CloudWatch로 전송하기 전에 ApiName 차원에서 비 ASCII 문자를 제거합니다. APIName에 ASCII 문자가 없는 경우 API ID가 ApiName으로 사용됩니다.

차원 설명

ApiName

지정한 API 이름을 사용하여 REST API에 대한 API Gateway 지표를 필터링합니다.

ApiName, Method, Resource, Stage

지정한 API 이름, 단계, 리소스 및 메서드를 사용하여 API 메서드에 대한 API Gateway 지표를 필터링합니다.

사용자가 세부 CloudWatch 지표를 명시적으로 활성화하지 않으면 API Gateway는 이러한 지표를 전송하지 않습니다. 콘솔에서 스테이지를 선택한 다음 로그 및 추적에서 편집을 선택합니다. 세부 지표를 선택한 다음 변경 사항 저장을 선택합니다. 또는 update-stage AWS CLI 명령을 호출하여 metricsEnabled 속성을 true로 업데이트할 수 있습니다.

이러한 지표를 활성화하면 계정에 추가 비용이 발생합니다. 요금에 대한 자세한 내용은 Amazon CloudWatch 요금을 참조하십시오.

ApiName, Stage

지정한 API 이름과 단계를 사용하여 API 단계 리소스에 대한 API Gateway 지표를 필터링합니다.