Samouczek: debugowanie interfejsów API przy użyciu śledzenia żądań
DOTYCZY: Zużycie | Deweloper | Podstawowa | Standardowa | Premium
W tym samouczku opisano sposób inspekcji (śledzenia) przetwarzania żądań w usłudze Azure API Management. Śledzenie ułatwia debugowanie interfejsu API i rozwiązywanie problemów z tym interfejsem API.
Z tego samouczka dowiesz się, jak wykonywać następujące czynności:
- Śledzenie przykładowego wywołania
- Przeglądanie kroków przetwarzania żądań
Uwaga
Obecnie śledzenie żądań interfejsu API nie jest obsługiwane w warstwach Podstawowa w wersji 2 i Standardowa w wersji 2.
Wymagania wstępne
- Poznaj terminologię dotyczącą usługi Azure API Management.
- Wykonaj procedury przedstawione w następującym przewodniku Szybki start: Tworzenie wystąpienia usługi Azure API Management.
- Wykonaj czynności opisane w poniższym samouczku: Importowanie i publikowanie pierwszego interfejsu API.
Sprawdzanie ustawienia zezwalania na śledzenie
Aby śledzić przetwarzanie żądań, musisz włączyć ustawienie Zezwalaj na śledzenie dla subskrypcji używanej do debugowania Twojego interfejsu API. Aby zaewidencjonować portal:
Przejdź do wystąpienia usługi API Management i wybierz pozycję Subskrypcje , aby przejrzeć ustawienia.
Jeśli śledzenie nie jest włączone dla używanej subskrypcji, wybierz subskrypcję i włącz opcję Zezwalaj na śledzenie.
Ostrzeżenie
- Zezwalaj na śledzenie tylko w przypadku subskrypcji przeznaczonych do celów debugowania. Udostępnianie kluczy subskrypcji z dozwolonym śledzeniem nieautoryzowanym użytkownikom może prowadzić do ujawnienia poufnych informacji zawartych w dziennikach śledzenia, takich jak klucze, tokeny dostępu, hasła, wewnętrzne nazwy hostów i adresy IP.
- W konsoli testowej usługa API Management automatycznie wyłącza śledzenie 1 godzinę po włączeniu jej w ramach subskrypcji.
Śledzenie wywołania
Zaloguj się do witryny Azure Portal i przejdź do wystąpienia usługi API Management.
Wybierz pozycję Interfejsy API.
Wybierz pozycję Pokazowy interfejs API konferencji z listy interfejsów API.
Wybierz kartę Test.
Wybierz operację GetSpeakers.
Opcjonalnie sprawdź wartość nagłówka Ocp-Apim-Subscription-Key używanego w żądaniu, wybierając ikonę "oko".
Napiwek
Możesz zastąpić wartość Ocp-Apim-Subscription-Key , pobierając klucz dla innej subskrypcji w portalu. Wybierz pozycję Subskrypcje i otwórz menu kontekstowe (...) dla innej subskrypcji. Wybierz pozycję Pokaż/ukryj klucze i skopiuj jeden z kluczy. W razie potrzeby można również ponownie wygenerować klucze. Następnie w konsoli testowej wybierz pozycję + Dodaj nagłówek, aby dodać nagłówek Ocp-Apim-Subscription-Key z nową wartością klucza.
Wybierz pozycję Ślad.
Jeśli subskrypcja jeszcze nie zezwala na śledzenie, zostanie wyświetlony monit o jej włączenie, jeśli chcesz śledzić wywołanie.
Możesz również wysłać żądanie bez śledzenia.
Przeglądanie informacji śledzenia
Po zakończeniu wywołania przejdź do karty Śledzenie w odpowiedzi HTTP.
Wybierz dowolne z poniższych linków, aby przejść do szczegółowych informacji o śledzeniu: przychodzące, zaplecze, wychodzące, przy błędzie.
Przychodzące — pokazuje oryginalne żądanie usługi API Management odebrane od obiektu wywołującego i zasady zastosowane do żądania. Jeśli na przykład dodano zasady w artykule Samouczek: przekształcanie i ochrona interfejsu API, zostaną one wyświetlone tutaj.
Zaplecze — pokazuje żądania usługi API Management wysłane do zaplecza interfejsu API i odebraną odpowiedź.
Wychodzący — pokazuje zasady zastosowane do odpowiedzi przed wysłaniem z powrotem do elementu wywołującego.
Po błędzie — pokazuje błędy, które wystąpiły podczas przetwarzania żądania i zasady zastosowane do błędów.
Napiwek
Przy każdym kroku widać również czas, jaki upłynął od odebrania żądania przez usługę API Management.
Na karcie Komunikat nagłówek ocp-apim-trace-location pokazuje lokalizację danych śledzenia przechowywanych w usłudze Azure Blob Storage. W razie potrzeby przejdź do tej lokalizacji, aby pobrać ślad. Dostęp do danych śledzenia można uzyskać przez maksymalnie 24 godziny.
Włączanie śledzenia przy użyciu nagłówka Ocp-Apim-Trace
Podczas wprowadzania żądań do usługi API Management przy użyciu usługi curl, klient REST, taki jak Postman lub aplikacja kliencka, włącz śledzenie, dodając następujące nagłówki żądań:
- Ocp-Apim-Trace — ustaw wartość na
true - Ocp-Apim-Subscription-Key — ustaw wartość klucza dla subskrypcji z obsługą śledzenia, która umożliwia dostęp do interfejsu API
Odpowiedź zawiera nagłówek Ocp-Apim-Trace-Location z adresem URL lokalizacji danych śledzenia w usłudze Azure Blob Storage.
Aby uzyskać informacje na temat dostosowywania informacji śledzenia, zobacz zasady śledzenia .
Następne kroki
W tym samouczku zawarto informacje na temat wykonywania następujących czynności:
- Śledzenie przykładowego wywołania
- Przeglądanie kroków przetwarzania żądań
Przejdź do następnego samouczka: