API 모니터링

이 페이지에서는 API 게이트웨이가 자동으로 유지관리하는 로그와 측정항목을 사용하여 API 게이트웨이 API의 상태를 모니터링하는 방법을 설명합니다.

API를 만들면 API 게이트웨이가 해당 관리형 서비스를 자동으로 만듭니다. 생성된 관리형 서비스의 이름은 다음 명령어의 결과에서 찾을 수 있습니다.

gcloud api-gateway apis describe API_ID

서비스 이름은 managedService 필드의 값입니다.

사용자가 API를 요청하면 API 게이트웨이가 요청 및 응답 정보를 로깅합니다. API 게이트웨이는 또한 모니터링의 4가지 골든 신호 중 지연 시간, 트래픽, 오류의 3가지 신호를 추적합니다. 이러한 사용 및 성능 측정항목은 API를 모니터링하는 데 유용합니다.

시작하기 전에

보기에 대해 로그 및 측정항목을 생성하려면 API를 배포하고 여기에 요청을 전송합니다. 아직 API를 만들고 게이트웨이에 배포하지 않았으면 API 게이트웨이 빠른 시작을 참조하세요.

API 개요

서비스 문제를 디버깅하거나 예상대로 작동하는지 확인하려면 API 개요로 이동합니다.

  1. Google Cloud 콘솔에서 프로젝트의 API 게이트웨이 > API 페이지로 이동합니다.

    API로 이동

  2. API가 2개 이상 있으면 모니터링하려는 항목을 선택합니다.

  3. 개요 탭이 표시되었는지 확인합니다.

그래프

개요 페이지에서는 일부 측정항목에 대해 다양한 그래프가 제공되므로, 사용량 급증이나 저하 등 예상치 않은 활동을 즉시 확인할 수 있습니다. 페이지 상단의 필터는 다음 기능을 제공합니다.

  • 그래프 선택 드롭다운 목록을 사용해서 원하는 측정항목에 대한 그래프를 표시하고 원치 않는 측정항목은 삭제할 수 있습니다.
  • 여러 시간 범위 중에서 선택하여 그래프 범위를 조정할 수 있습니다. 이렇게 하면 표시되는 값의 시간 범위가 조정되고 점 단위도 변경됩니다.

메서드 표

더 상세히 보려면 그래프 아래로 스크롤하여 API에 있는 개별 메서드에 대한 측정항목 표를 확인합니다. 다음을 수행할 수 있습니다.

  • 테이블 왼쪽 위에서 테이블 필터 아이콘을 클릭하여 드롭다운 테이블에서 미세 조정된 필터 쿼리를 선택합니다. 여러 항목을 검색하려면 각 필터 쿼리 사이에 OR을 추가합니다.
  • 표의 오른쪽 상단에서 열 표시 옵션 아이콘을 클릭하여 드롭다운 목록을 표시합니다. 원하는 측정항목을 선택하고 표시하지 않을 측정항목은 삭제합니다.
  • 개요 오른쪽 상단에서 기간 선택도구를 사용해서 표에 있는 측정항목-값에 대한 기간을 선택합니다. 그러면 그래프와 표 모두에 대해 하나의 기간이 선택됩니다.

로그

측정항목에서 문제가 발견되면 Google Cloud 콘솔의 로그 탐색기 페이지를 사용하여 API에 대한 요청 및 응답 로그를 확인할 수 있습니다.

  • API의 개별 메서드에 대한 로그를 확인하려면 표에서 로그 보기를 클릭합니다.

  • API의 모든 메서드에 대해 로그를 보려면 오른쪽 하단에서 모든 로그 보기를 클릭합니다.

  • 로그 탐색기 페이지에서 직접 API 게이트웨이 로그를 찾으려면 다음 안내를 따르세요.

    1. Google Cloud 콘솔에서 로그 탐색기 페이지로 이동합니다.

      로그 탐색기로 이동

    2. 생성된 API, SERVICE_NAME을 선택합니다. 여기서 SERVICE_NAME은 관리형 서비스의 이름입니다.

로그 탐색기의 로그 구조에 대한 자세한 내용은 API 게이트웨이 로그 참조를 확인하세요.

로그로 할 수 있는 다른 작업도 알아보세요.

  • 로그 탐색기를 사용합니다.

    쿼리 창을 사용해서 대기 시간이 300밀리초를 초과하는 모든 요청 가져오기 등 확인하려는 로그 항목 집합을 지정합니다.

  • 싱크 구성 및 관리. 이렇게 하면 추가 분석을 위해 로그를 BigQuery로 스트리밍하거나, 원본 로그를 Cloud Storage에 저장하거나, Pub/Sub 메시지 주제로 로그를 보낼 수 있습니다.

특정 소비자 프로젝트를 위한 필터

특정 소비자 프로젝트의 측정항목을 필터링하려면 다음 단계를 따르세요.

  1. API 소비자 프로젝트의 프로젝트 번호를 가져옵니다. API 소비자 프로젝트에 액세스할 권한이 없는 경우 해당 권한이 있는 사용자에게 프로젝트 번호 확인을 요청하세요.

  2. Google Cloud 콘솔에서 프로젝트의 API 게이트웨이 > API 페이지로 이동합니다.

    API로 이동

  3. 개요 페이지의 왼쪽 상단에서 프로젝트 번호로 필터링 필드에 프로젝트 번호를 입력합니다.

  4. 필터를 클릭합니다.

지정한 프로젝트의 트래픽만 반영하도록 페이지의 측정항목이 업데이트됩니다.

다음 단계