Självstudie: Felsöka dina API:er med hjälp av spårning av begäranden

  • Artikel

GÄLLER FÖR: Förbrukning | Utvecklare | Grundläggande | Standard | Premium

I den här självstudien beskrivs hur du inspekterar (spårning) bearbetning av begäranden i Azure API Management. Spårning hjälper dig att felsöka ditt API.

I den här självstudien lär du dig att:

  • Spåra ett exempelanrop
  • Granska bearbetningssteg för begäran

Skärmbild som visar API-inspektören.

Kommentar

För närvarande stöds inte spårning av API-begäranden på nivåerna Basic v2 och Standard v2.

Förutsättningar

Kontrollera inställningen Tillåt spårning

Om du vill spåra bearbetning av begäranden måste du aktivera inställningen Tillåt spårning för prenumerationen som används för att felsöka ditt API. Så här checkar du in portalen:

  1. Gå till DIN API Management-instans och välj Prenumerationer för att granska inställningarna.

    Skärmbild som visar hur du tillåter spårning för prenumeration.

  2. Om spårning inte är aktiverat för den prenumeration du använder väljer du prenumerationen och aktiverar Tillåt spårning.

Varning

  • Tillåt endast spårning av prenumerationer som är avsedda för felsökning. Delning av prenumerationsnycklar med spårning som tillåts med obehöriga användare kan leda till avslöjande av känslig information som finns i spårningsloggar, däribland nycklar, åtkomsttoken, lösenord, interna värdnamn och IP-adresser.
  • I testkonsolen inaktiverar API Management automatiskt spårning 1 timme efter att den har aktiverats för en prenumeration.

Spåra ett anrop

  1. Logga in på Azure-portalen och gå till din API Management-instans.

  2. Välj API:er.

  3. Välj Demo Conference API i din API-lista.

  4. Välj fliken Test.

  5. Välj åtgärden GetSpeakers.

  6. Du kan också kontrollera värdet för rubriken Ocp-Apim-Subscription-Key som används i begäran genom att välja ikonen "eye".

    Dricks

    Du kan åsidosätta värdet ocp-apim-subscription-key genom att hämta en nyckel för en annan prenumeration i portalen. Välj Prenumerationer och öppna snabbmenyn (...) för en annan prenumeration. Välj Visa/dölj nycklar och kopiera en av nycklarna. Du kan också återskapa nycklar om det behövs. I testkonsolen väljer du sedan + Lägg till rubrik för att lägga till ett Ocp-Apim-Subscription-Key-huvud med det nya nyckelvärdet.

  7. Välj Spåra.

    • Om prenumerationen inte redan tillåter spårning uppmanas du att aktivera den om du vill spåra anropet.

    • Du kan också välja att skicka begäran utan spårning.

      Skärmbild som visar hur du konfigurerar API-spårning.

Granska spårningsinformation

  1. När anropet är klart går du till fliken Spårning i HTTP-svaret.

  2. Välj någon av följande länkar för att gå till detaljerad spårningsinformation: Inkommande, Serverdel, Utgående, På-fel.

    Granska svarsspårning

    • Inkommande – visar den ursprungliga begäran som API Management tog emot från anroparen och de principer som tillämpas på begäran. Om du till exempel har lagt till principer i Självstudie: Transformera och skydda ditt API visas de här.

    • Serverdelen – Visar begäranden som API Management skickade till API-serverdelen och det svar som den tog emot.

    • Utgående – Visar de principer som tillämpas på svaret innan du skickar tillbaka till anroparen.

    • Vid fel – Visar de fel som inträffade under bearbetningen av begäran och de principer som tillämpas på felen.

    Dricks

    Alla steg visar också hur lång tid det tog efter att begäran togs emot av API Management.

  3. På fliken Meddelande visar huvudet ocp-apim-trace-location platsen för spårningsdata som lagras i Azure Blob Storage. Om det behövs går du till den här platsen för att hämta spårningen. Spårningsdata kan nås i upp till 24 timmar.

    Spårningsplats i Azure Storage

Aktivera spårning med ocp-apim-trace-huvudet

När du gör begäranden till API Management med , curlen REST-klient som Postman eller en klientapp, aktiverar du spårning genom att lägga till följande begärandehuvuden:

  • Ocp-Apim-Trace – ange värdet till true
  • Ocp-Apim-Subscription-Key – ange värdet till nyckeln för en spårningsaktiverad prenumeration som ger åtkomst till API:et

Svaret innehåller huvudet Ocp-Apim-Trace-Location med en URL till platsen för spårningsdata i Azure Blob Storage.

Information om hur du anpassar spårningsinformation finns i spårningsprincipen .

Nästa steg

I den här självstudiekursen lärde du dig att:

  • Spåra ett exempelanrop
  • Granska bearbetningssteg för begäran

Gå vidare till nästa kurs:

Använd revideringar