Oktatóanyag: API-k hibakeresése kérések nyomon követésével
A következőkre vonatkozik: Felhasználás | Fejlesztő | Alapszintű | Standard | Prémium
Ez az oktatóanyag bemutatja, hogyan vizsgálhatja meg (nyomon) a kérelmek feldolgozását az Azure API Managementben. A nyomkövetés segít az API hibakeresésében és hibaelhárításában.
Ebben az oktatóanyagban az alábbiakkal fog megismerkedni:
- Példahívás nyomon követése
- Kérelemfeldolgozási lépések áttekintése
Feljegyzés
Az API-kérések nyomkövetése jelenleg nem támogatott az alapszintű v2- és standard v2-szinteken.
Előfeltételek
- Az Azure API Management terminológiájának ismerete.
- Tekintse át a következő rövid útmutatót: Azure API Management-példány létrehozása.
- Végezze el az alábbi oktatóanyagot: Importálja és tegye közzé az első API-t.
A nyomkövetés engedélyezésének ellenőrzése
A kérésfeldolgozás nyomkövetéséhez be kell kapcsolnia az API hibakereséséhez használt előfizetés Nyomon követés engedélyezése beállítását. A portálon való bejelentkezéshez:
Lépjen az API Management-példányra, és válassza az Előfizetések lehetőséget a beállítások áttekintéséhez.
Ha a nyomkövetés nincs engedélyezve a használt előfizetéshez, válassza ki az előfizetést, és engedélyezze a nyomkövetés engedélyezését.
Figyelmeztetés
- Az előfizetésekben csak hibakeresési célból engedélyezze a nyomkövetést. Ha jogosulatlan felhasználókkal oszt meg olyan előfizetési kulcsokat, amelyek esetében a nyomkövetés engedélyezve van, az a nyomkövetési naplókban található bizalmas adatok, például kulcsok, hozzáférési jogkivonatok, jelszavak, belső gazdagépnevek és IP-címek nyilvánosságra kerüléséhez vezethet.
- A tesztkonzolon az API Management automatikusan letiltja a nyomkövetést 1 órával az előfizetésen való engedélyezés után.
Hívás nyomon követése
Jelentkezzen be az Azure Portalra, és keresse meg az API Management-példányt.
Válassza az API-k lehetőséget.
Válassza a Demo Conference API-t az API-listából.
Kattintson a Teszt fülre.
Válassza a GetSpeakers műveletet.
Ha szeretné, ellenőrizze a kérelemben használt Ocp-Apim-Subscription-Key fejléc értékét a "szem" ikon kiválasztásával.
Tipp.
Az Ocp-Apim-Subscription-Key értékét felülbírálhatja egy másik előfizetés kulcsának beolvasásával a portálon. Válassza az Előfizetések lehetőséget, és nyissa meg a helyi menüt (...) egy másik előfizetéshez. Válassza a Kulcsok megjelenítése/elrejtése lehetőséget, és másolja az egyik kulcsot. Szükség esetén újragenerálhatja a kulcsokat. Ezután a tesztkonzolon válassza a + Fejléc hozzáadása lehetőséget egy Ocp-Apim-Subscription-Key fejléc hozzáadásához az új kulcsértékkel.
Válassza a Nyomkövetés lehetőséget.
Ha az előfizetése még nem engedélyezi a nyomkövetést, a rendszer kérni fogja annak engedélyezését, ha nyomon szeretné követni a hívást.
Dönthet úgy is, hogy nyomkövetés nélkül küldi el a kérést.
Nyomkövetési információk áttekintése
A hívás befejezése után lépjen a HTTP-válasz Nyomkövetés lapjára.
Válassza ki az alábbi hivatkozások bármelyikét a részletes nyomkövetési adatokra való ugráshoz: Bejövő, Háttérrendszeri, Kimenő, Be hiba.
Bejövő – Megjeleníti a hívótól kapott eredeti KÉRÉS API Managementet és a kérelemre alkalmazott szabályzatokat. Ha például a következő oktatóanyagban hozzáadott szabályzatokat: Az API átalakítása és védelme, itt jelennek meg.
Háttérrendszer – Megjeleníti az API-háttérrendszernek küldött API Management-kérelmeket és a kapott választ.
Kimenő – Megjeleníti a válaszra alkalmazott szabályzatokat, mielőtt visszaküldené a hívónak.
Hiba esetén – A kérés feldolgozása során előforduló hibákat és a hibákra alkalmazott szabályzatokat jeleníti meg.
Tipp.
Az egyes lépések a hívás az API Management által való fogadása óta eltelt időt is mutatják.
Az Üzenet lapon az ocp-apim-trace-location fejléc az Azure Blob Storage-ban tárolt nyomkövetési adatok helyét jeleníti meg. Ha szükséges, lépjen erre a helyre a nyomkövetés lekéréséhez. A nyomkövetési adatok legfeljebb 24 óráig érhetők el.
Nyomkövetés engedélyezése az Ocp-Apim-Trace fejléc használatával
Ha REST-ügyféllel, például Postmannal vagy ügyfélalkalmazással curlküld kéréseket az API Managementhez, engedélyezze a nyomkövetést a következő kérésfejlécek hozzáadásával:
- Ocp-Apim-Trace – érték beállítása
true - Ocp-Apim-Subscription-Key – állítsa be az értéket egy nyomkövetési kompatibilis előfizetés kulcsára, amely lehetővé teszi az API-hoz való hozzáférést
A válasz tartalmazza az Ocp-Apim-Trace-Location fejlécet, a nyomkövetési adatok azure blobtárolóban való helyének URL-címével.
A nyomkövetési információk testreszabásával kapcsolatos információkért tekintse meg a nyomkövetési szabályzatot.
Következő lépések
Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:
- Példahívás nyomon követése
- Kérelemfeldolgozási lépések áttekintése
Folytassa a következő oktatóanyaggal: