자습서: 요청 추적을 사용하여 API 디버그

적용 대상: 사용량 | 개발자 | 기본 | 표준 | 프리미엄

이 자습서에서는 Azure API Management에서 요청 처리를 조사(추적)하는 방법을 설명합니다. 추적은 API를 디버그하고 문제를 해결하는 데 도움을 줍니다.

이 자습서에서는 다음을 하는 방법을 알아볼 수 있습니다.

  • 예제 호출 추적
  • 요청 처리 단계 검토

API 검사기를 보여 주는 스크린샷

참고 항목

현재 API 요청 추적은 기본 v2 및 표준 v2 계층에서 지원되지 않습니다.

필수 조건

추적 허용 설정 확인

요청 처리를 추적하려면 API를 디버그하는 데 사용되는 구독에 대해 추적 허용 설정을 사용하도록 설정해야 합니다. 포털에서 확인하려면 다음을 수행합니다.

  1. API Management 인스턴스로 이동하여 구독을 선택하고 설정을 검토합니다.

    구독 추적을 허용하는 방법을 보여 주는 스크린샷

  2. 사용 중인 구독에 추적을 사용하도록 설정하지 않은 경우 구독을 선택하고 추적 허용을 사용하도록 설정합니다.

Warning

  • 디버깅 목적으로 의도된 구독에 대해서만 추적을 허용합니다. 권한이 없는 사용자와 추적이 허용된 구독 키를 공유하면 키, 액세스 토큰, 암호, 내부 호스트 이름, IP 주소와 같은 추적 로그에 포함된 중요한 정보가 공개될 수 있습니다.
  • 테스트 콘솔에서 API Management는 구독에서 추적을 사용하도록 설정한 후 1시간이 지나면 자동으로 사용하지 않도록 설정합니다.

호출 추적

  1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

  2. API를 선택합니다.

  3. API 목록에서 Demo Conference API를 선택합니다.

  4. 테스트 탭을 선택합니다.

  5. GetSpeakers 작업을 선택합니다.

  6. 필요에 따라 "눈" 아이콘을 선택하여 요청에 사용된 Ocp-Apim-Subscription-Key 헤더의 값을 확인합니다.

    포털에서 다른 구독에 대한 키를 검색하여 Ocp-Apim-Subscription-Key 값을 재정의할 수 있습니다. 구독을 선택하고 다른 구독에 대한 바로 가기 메뉴(...)를 엽니다. 키 표시/숨기기를 선택하고 키 중 하나를 복사합니다. 필요한 경우 키를 다시 생성할 수도 있습니다. 그런 다음, 테스트 콘솔에서 + 헤더 추가를 선택하여 새 키 값이 있는 Ocp-Apim-Subscription-Key 헤더를 추가합니다.

  7. 추적을 선택합니다.

    • 구독에서 추적을 아직 허용하지 않는 경우 호출을 추적하려는 경우 사용하도록 설정하라는 메시지가 표시됩니다.

    • 추적 없이 요청을 보내도록 선택할 수도 있습니다.

      API 추적 구성을 보여 주는 스크린샷

추적 정보 검토

  1. 호출이 완료되면 HTTP 응답추적 탭으로 이동합니다.

  2. 다음 링크 중 하나를 선택하여 자세한 추적 정보로 이동합니다. 인바운드, 백 엔드, 아웃바운드, 오류 발생 시.

    응답 추적 검토

    • 인바운드 - 호출자로부터 받은 원래 요청 API Management 및 요청에 적용된 정책을 보여줍니다. 예를 들어 자습서: API 변환 및 보호에 정책을 추가한 경우 여기에 표시됩니다.

    • 백 엔드 - API Management가 API 백 엔드로 보낸 요청과 수신된 응답을 보여줍니다.

    • 아웃바운드 - 호출자에게 다시 보내기 전에 응답에 적용되는 정책을 보여줍니다.

    • 오류 발생 시 - 요청을 처리하는 동안 발생한 오류와 오류에 적용된 정책을 표시합니다.

    각 단계는 API Management에서 요청이 수신된 이후에 경과된 시간도 표시합니다.

  3. 메시지 탭에서 ocp-apim-trace-location 헤더는 Azure Blob 스토리지에 저장된 추적 데이터의 위치를 보여줍니다. 필요한 경우 이 위치로 이동하여 추적을 검색합니다. 추적 데이터는 최대 24시간 동안 액세스할 수 있습니다.

    Azure Storage의 추적 위치

Ocp-Apim-Trace 헤더를 사용하여 추적 사용

curl를 사용하여 API Management 요청할 때 Postman과 같은 REST 클라이언트 또는 클라이언트 앱에서 다음 요청 헤더를 추가하여 추적을 사용하도록 설정합니다.

  • Ocp-Apim-Trace - true로 값 설정
  • Ocp-Apim-Subscription-Key - API에 대한 액세스를 허용하는 추적 사용 구독에 대한 키로 값 설정

응답에는 Azure Blob Storage의 추적 데이터 위치에 대한 URL과 함께 Ocp-Apim-Trace-Location 헤더가 포함됩니다.

추적 정보를 사용자 지정하는 방법에 대한 자세한 내용은 추적 정책을 참조하세요.

다음 단계

이 자습서에서는 다음 작업 방법을 알아보았습니다.

  • 예제 호출 추적
  • 요청 처리 단계 검토

다음 자습서를 진행합니다.