개요

Amazon API Gateway는 개발자가 어떠한 규모에서도 API를 쉽게 생성, 게시, 유지 관리, 모니터링, 보호할 수 있도록 지원하는 완전관리형 서비스입니다.

이 통합을 활성화하여 Datadog에서 모든 API Gateway 메트릭을 확인할 수 있습니다.

설정

설치

아직 설정하지 않은 경우 [먼저 Amazon Web Service 통합]을 설정하세요(https://docs.datadoghq.com/integrations/amazon_web_services/).

메트릭 수집

1. AWS 통합 페이지에서 API Gateway가 Metric Collection 탭에서 활성화되어 있는지 확인하세요.

2. API Gateway Stage에 적용되는 커스텀 태그를 얻으려면 Datadog IAM 정책에 다음 권한을 추가하세요.

   • apigateway:GET
   • tag:GetResources

3. Datadog - Amazon API Gateway 통합을 설치합니다.

AWS에서 검색된 각 메트릭에는 AWS 콘솔에 표시되는 것과 동일한 태그가 할당됩니다. 여기에는 호스트 이름, 보안 그룹 등이 포함됩니다.

참고: 자세한 CloudWatch 메트릭을 활성화한 경우 단계 내의 모든 리소스 또는 경로에서 이를 활성화해야 합니다. 그러지 않으면 Datadog의 집계 값이 부정확해집니다.

로그 수집

API Gateway 로깅 활성화 방법:

1. AWS 콘솔에서 API Gateway로 이동합니다.

2. 원하는 API를 선택합니다.

3. 왼쪽 탐색 탭의 Monitor 드롭다운에서 Logging을 선택합니다. 왼쪽 탐색 탭이 보이지 않으면 왼쪽 상단 API Gateway 브레드크럼 옆의 햄버거 아이콘을 클릭합니다.

4. 단계를 선택합니다.

5. Access logging 섹션에서 Edit를 클릭합니다.

6. Access logging 토글을 활성화합니다.

7. Log destination의 경우 CloudWatch 로그 그룹 이름이 api-gateway로 시작하는지 확인합니다.

8. JSON 형식(CLF 및 CSV도 지원됨)을 선택하고 Log format 상자에 다음을 추가합니다.

   {
       "apiId": "$context.apiId",
       "stage": "$context.stage",
       "requestId":"$context.requestId",
       "ip":"$context.identity.sourceIp",
       "caller":"$context.identity.caller",
       "user":"$context.identity.user",
       "requestTime":$context.requestTimeEpoch,
       "httpMethod":"$context.httpMethod",
       "resourcePath":"$context.resourcePath",
       "status":$context.status,
       "protocol":"$context.protocol",
       "responseLength":$context.responseLength
   }
   

9. Save를 클릭합니다.

Datadog로 로그 전송

1. 아직 설정하지 않은 경우 [먼저 Datadog 로그 수집 AWS Lambda 함수]를 설정하세요(https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function).
2. 람다 함수가 설치되면 AWS 콘솔에서 API Gateway 로그를 포함하는 클라우드와치(CloudWatch) 로그 그룹에 대해 수동으로 트리거를 추가합니다. 해당 CloudWatch Log 그룹을 선택하고 필터 이름을 추가한 다음(필터는 비워 두어도 됨) 트리거를 추가합니다.

완료되면 로그 페이지로 이동하여 로그 탐색을 시작하세요.

수집한 데이터

Metrics

이벤트

Amazon API Gateway 통합에는 어떠한 이벤트도 포함되지 않습니다.

서비스 점검

Amazon API Gateway 통합에는 어떠한 서비스 점검도 포함되지 않습니다.

트러블슈팅

도움이 필요하세요? Datadog 지원 팀에 문의하세요.