AWS API Gateway¶

AWS API Gateway의 표시 지표에는 요청 응답 시간, 처리량, 동시 연결 수, 오류율이 포함되며, 이 지표들은 API Gateway가 API 요청을 처리하고 트래픽을 관리할 때의 성능과 안정성을 반영합니다.

설정¶

Func 설치¶

Guance 통합 - 확장 - 관리형 Func 활성화를 권장합니다: 모든 사전 조건이 자동으로 설치되므로, 스크립트 설치를 계속 진행하세요

Func를 직접 배포하는 경우 Func 직접 배포를 참고하세요

설치 스크립트¶

안내: 요구 사항을 충족하는 Amazon AK를 미리 준비하세요. (간단히 하려면 전역 읽기 전용 권한 ReadOnlyAccess를 직접 부여해도 됩니다.)

관리형 활성화 스크립트¶

Guance 콘솔에 로그인합니다.
【통합】 메뉴를 클릭하고 【클라우드 계정 관리】를 선택합니다.
【클라우드 계정 추가】를 클릭하고 【AWS】를 선택한 뒤, 화면에 필요한 정보를 입력합니다. 이전에 클라우드 계정 정보를 구성한 적이 있다면 이 단계를 건너뜁니다.
【테스트】를 클릭한 뒤 테스트가 성공하면 【저장】을 클릭합니다. 테스트에 실패하면 관련 구성 정보가 올바른지 확인한 뒤 다시 테스트합니다.
【클라우드 계정 관리】 목록에서 추가된 클라우드 계정을 확인할 수 있습니다. 해당 클라우드 계정을 클릭하여 상세 페이지로 들어갑니다.
클라우드 계정 상세 페이지의 【통합】 버튼을 클릭한 뒤 설치되지 않음 목록에서 AWS API Gateway를 찾아 【설치】 버튼을 클릭하면 설치 화면이 표시되며, 설치를 진행하면 됩니다.

수동 활성화 스크립트¶

Func 콘솔에 로그인한 뒤 【스크립트 마켓】을 클릭하여 Guance 스크립트 마켓으로 들어가 integration_aws_gateway를 검색합니다.
【설치】를 클릭한 뒤 AWS AK ID, AK Secret, 계정 이름을 입력합니다.
【배포 시작 스크립트】를 클릭하면 시스템이 자동으로 Startup 스크립트 세트를 생성하고, 대응하는 시작 스크립트를 자동으로 구성합니다.
활성화 후 「관리 / 자동 트리거 설정」에서 해당 자동 트리거 설정을 확인할 수 있습니다. 【실행】을 클릭하면 주기 시간을 기다리지 않고 즉시 한 번 실행할 수 있습니다. 잠시 후 실행 작업 기록과 해당 로그를 확인할 수 있습니다.

검증¶

「관리 / 자동 트리거 설정」에서 해당 작업의 자동 트리거 설정이 존재하는지 확인하고, 동시에 작업 기록과 로그를 확인하여 이상 여부를 점검합니다.
Guance의 「기반 시설 / 사용자 정의」에서 자산 정보가 있는지 확인합니다.
Guance의 「지표」에서 해당 모니터링 데이터가 있는지 확인합니다.

지표¶

아마존-클라우드 모니터링이 구성되어 있으면 기본 지표 집합은 다음과 같습니다. 구성을 통해 더 많은 지표를 수집할 수 있습니다. 아마존 클라우드 모니터링 지표 상세

인스턴스 지표¶

AWS/ApiGateway 네임스페이스에는 다음 인스턴스 지표가 포함됩니다.

지표	설명
`4XXError`	지정된 기간 동안 포착된 클라이언트 오류 수입니다. Sum 통계는 이 지표를 의미하며, 지정된 기간 내 4XXError 오류의 총 개수를 나타냅니다. Average 통계는 4XXError 오류율을 의미하며, 4XXError 오류의 총 개수를 해당 기간의 총 요청 수로 나눈 값입니다. 분모는 Count 지표를 따릅니다(아래 참조). Unit: Count
`5XXError`	지정된 기간 동안 포착된 서버 측 오류 수입니다. Sum 통계는 이 지표를 의미하며, 지정된 기간 내 5XXError 오류의 총 개수를 나타냅니다. Average 통계는 5XXError 오류율을 의미하며, 5XXError 오류의 총 개수를 해당 기간의 총 요청 수로 나눈 값입니다. 분모는 Count 지표를 따릅니다(아래 참조). Unit: Count
`Count`	지정된 기간 내의 API 요청 총수입니다. SampleCount 통계는 이 지표를 의미합니다. Unit: Count
`Latency`	API Gateway가 클라이언트로부터 요청을 받은 시점부터 응답을 클라이언트에게 반환할 때까지 걸린 시간입니다. 지연 시간에는 통합 지연 시간과 기타 API Gateway 오버헤드가 포함됩니다. Unit: Millisecond

객체¶

수집된 AWS API Gateway 객체 데이터 구조이며, 「기반 시설-사용자 정의」에서 객체 데이터를 확인할 수 있습니다.

{
  "measurement": "aws_gateway",
  "tags": {
    "account_name"   : "AWS",
    "api_name"       : "helloworld-API",
    "ApiId"          : "c72z3thtq8",
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "class"          : "aws_gateway",
    "cloud_provider" : "aws",
    "create_time"    : "2023/08/07 14:29:19",
    "CreatedDate"    : "2022-11-11T09:17:35Z",
    "date"           : "2023/08/07 14:29:19",
    "date_ns"        :"0",
    "Description"    :"Created by AWS Lambda",
    "instance_tags"  :"{}",
    "name"           :"c72z3thtq8",
    "ProtocolType"   :"HTTP",
    "region_id"      :"cn-northwest-1"
  }
}

주의: tags와 fields의 필드는 이후 업데이트에 따라 변경될 수 있습니다

안내1: ApiId 값은 인스턴스 ID이며, 고유 식별자로 사용됩니다