Oktatóanyag: A közzétett API-k monitorozása

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Az Azure Monitorral az Azure API Management szolgáltatásból az Azure-ba érkező metrikákat vagy naplókat jelenítheti meg, kérdezheti le, irányíthatja át, archiválhatja, illetve különböző műveleteket is végezhet velük.

Ebben az oktatóanyagban az alábbiakkal fog megismerkedni:

• Az API-k mérőszámainak megtekintése
• Riasztási szabály beállítása
• Tevékenységnaplók megtekintése
• Erőforrásnaplók engedélyezése és megtekintése

Feljegyzés

Az API Management számos további eszközt támogat az API-k megfigyeléséhez, beleértve a beépített elemzéseket és az Alkalmazás Elemzések való integrációt. További információ

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 a következő oktatóanyagot is: Az első API importálása és közzététele.

Az API-k metrikáinak megtekintése

Az API Management percenként bocsát ki metrikákat, így közel valós idejű betekintést nyújt az API-k állapotába és állapotába. A két leggyakrabban használt metrika a következő. Az elérhető metrikák teljes listáját lásd: támogatott metrikák.

• Kapacitás – segít döntéseket hozni az API Management-szolgáltatások frissítésével/visszaminősítésével kapcsolatban. A metrikát percenként bocsátja ki a rendszer, és a jelentéskészítéskor az átjáró becsült kapacitását tükrözi. A mérőszám értéke a 0–100 tartományban mozog, és az érték számítása az átjáró erőforrásai, például a processzor és a memória kihasználtsága alapján történik.
• Kérések – segít elemezni az API-forgalmat az API Management-szolgáltatásokon keresztül. A metrikát percenként bocsátja ki a rendszer, és a dimenziókkal rendelkező átjárókérések számát jelenti. A kérelmek szűrése válaszkódok, hely, állomásnév és hibák szerint.

Fontos

A következő metrikák 2019 májusától elavultak, és 2023 augusztusában megszűnnek: Összes átjárókérés, Sikeres átjárókérések, Jogosulatlan átjárókérések, Sikertelen átjárókérések, Egyéb átjárókérések. Térjen át a Kérések metrikára, amely egyenértékű funkciókat biztosít.

A mérőszámok elérése:

1. Az Azure Portalon keresse meg az API Management-példányt. Az Áttekintés lapon, a Monitor lapon tekintse át az API-k főbb mérőszámait.

2. A metrikák részletes vizsgálatához válassza a Metrikák lehetőséget a bal oldali menüben.

   

3. A legördülő menüben válassza ki azokat a metrikákat, amelyekre kíváncsi. Például kérések.

4. A diagram az API-hívások teljes számát mutatja, Állítsa be az időtartományt, hogy a kamatidőszakokra összpontosítson.

5. A diagramot a Kérések metrika dimenziói alapján szűrheti. Válassza például a Szűrő hozzáadása lehetőséget, válassza a Háttér válaszkód kategóriát, és adja meg 500 az értéket. A diagram a sikertelen kérelmek számát mutatja az API háttérrendszerében.

Riasztási szabály beállítása

Metrikák és tevékenységnaplók alapján kaphat riasztásokat . Az Azure Monitorban konfiguráljon egy riasztási szabályt egy művelet végrehajtásához, amikor aktiválódik. Gyakori műveletek:

• E-mail-értesítés küldése
• Webhook meghívása
• Egy Azure Logic App-alkalmazás meghívása

Példariasztási szabály konfigurálása kérelemmetrika alapján:

1. Az Azure Portalon keresse meg az API Management-példányt.

2. Válassza a Riasztások lehetőséget a bal oldali menüben.

   

3. Válassza a + Riasztási szabály létrehozása>lehetőséget.

4. A Feltétel lap Jel kiválasztása ablakában:

   1. Jeltípusban válassza a Metrikák lehetőséget.
   2. A Jel mezőben válassza a Kérések lehetőséget.
   3. A Riasztási logikában adjon meg egy küszöbértéket, amely azoknak az előfordulásoknak a száma, amelyek után a riasztást aktiválni kell.
   4. Dimenziók szerinti felosztásban válassza az Átjáró válaszkód kategóriáját a Dimenzió névben.
   5. A Dimenzióértékekben válassza a 4xx lehetőséget az ügyfélhibák, például a jogosulatlan vagy érvénytelen kérések esetén. Ha a dimenzióérték nem jelenik meg, válassza az Egyéni érték hozzáadása lehetőséget , és írja be a 4xx értéket.
   6. A Mikor a kiértékelésre lehetőségnél fogadja el az alapértelmezett beállításokat, vagy válasszon más beállításokat a szabály futási gyakoriságának konfigurálásához. Válassza a Tovább lehetőséget.

   

5. A Műveletek lapon jelöljön ki vagy hozzon létre egy vagy több műveletcsoportot, amelyek értesítik a felhasználókat a riasztásról, és végrehajtanak egy műveletet. Hozzon létre például egy új műveletcsoportot egy értesítési e-mail admin@contoso.comküldéséhez. Részletes lépésekért tekintse meg a műveletcsoportok létrehozását és kezelését az Azure Portalon.

   

6. A Riasztási szabály létrehozása Lap Részletek lapján adja meg a riasztási szabály nevét és leírását, és válassza ki a súlyossági szintet.

7. Igény szerint konfigurálja a fennmaradó beállításokat. Ezután a Véleményezés + létrehozás lapon válassza a Létrehozás lehetőséget.

8. Most tesztelje a riasztási szabályt úgy, hogy meghívja a Conference API-t API-kulcs nélkül. Példa:

   curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1 
   

   A riasztás a kiértékelési időszak alapján aktiválódik, és e-mailt küld a következő címre admin@contoso.com: .

   A riasztások az API Management-példány Riasztások lapján is megjelennek.

   

Tevékenységnaplók

A tevékenységnaplók betekintést nyújtanak az API Management-szolgáltatások műveleteibe. A tevékenységnaplók segítségével az API Management-szolgáltatásokban végrehajtott írási műveletek (PUT, POST, DELETE) kapcsán megállapíthatja, hogy a „ki, mit és mikor” hajtott végre.

Feljegyzés

A tevékenységnaplók az olvasási (GET) műveleteket, illetve az Azure Portalon vagy az eredeti felügyeleti API-k használatával végzett műveleteket nem tartalmazzák.

A tevékenységnaplók az API Management szolgáltatásban, az összes Azure-erőforrás naplói pedig az Azure Monitorban érhetők el.

A tevékenységnapló megtekintése:

1. Az Azure Portalon keresse meg az API Management-példányt.

2. Válassza a Tevékenységnapló lehetőséget.

   

3. Válassza ki a kívánt szűrési hatókört, majd alkalmazza.

Erőforrásnaplók

Az erőforrásnaplók (Azure Monitor-naplók) részletes információkat nyújtanak az API Management műveleteiről és a naplózás és hibaelhárítás szempontjából fontos hibákról. Ha diagnosztikai beállítással engedélyezve van, a naplók információkat gyűjtenek az API Management-átjáró által fogadott és feldolgozott API-kérelmekről.

Feljegyzés

A használati szint nem támogatja az erőforrásnaplók gyűjtését.

Erőforrásnaplók konfigurálása:

1. Az Azure Portalon keresse meg az API Management-példányt.

2. Válassza a Diagnosztikai beállítások lehetőséget.

   

3. Válassza a + Diagnosztikai beállítás hozzáadása elemet.

4. Válassza ki az összegyűjteni kívánt naplókat vagy metrikákat.

   A naplók és metrikák elküldésére több lehetősége is van. Archiválhatja például az erőforrásnaplókat és a metrikákat egy tárfiókba, streamelheti őket egy eseményközpontba, vagy elküldheti őket egy Log Analytics-munkaterületre.

   Tipp.

   Ha Log Analytics-munkaterületet választ, az adatokat az erőforrás-specifikus ApiManagementGatewayLogs táblában vagy az általános AzureDiagnostics táblában tárolhatja. Javasoljuk, hogy használja az erőforrás-specifikus táblát az azt támogató naplócélok esetében. További információ

5. Miután konfigurálta a napló célhelyének vagy célhelyének adatait, válassza a Mentés lehetőséget.

Feljegyzés

Diagnosztikai beállítási objektum hozzáadása meghiúsulhat, ha az API Management szolgáltatás MinApiVersion tulajdonsága a 2022-09-01 előzetes verziónál magasabb API-verzióra van beállítva.

További információ: Diagnosztikai beállítások létrehozása platformnaplók és metrikák különböző célhelyekre való küldéséhez.

Diagnosztikai adatok megtekintése az Azure Monitorban

Ha engedélyezi a naplók vagy metrikák gyűjtését egy Log Analytics-munkaterületen, eltarthat néhány percig, amíg az adatok megjelennek az Azure Monitorban.

Az adatok megtekintése:

1. Az Azure Portalon keresse meg az API Management-példányt.

2. Válassza a Bal oldali menü Naplók elemét.

   

3. Lekérdezések futtatása az adatok megtekintéséhez. A rendszer több minta lekérdezést is biztosít, vagy futtathatja a sajátját. Az alábbi lekérdezés például a legutóbbi 24 órányi adatot kéri le az ApiManagementGatewayLogs táblából:

   ApiManagementGatewayLogs
   | where TimeGenerated > ago(1d) 
   

   

További információ az ERŐFORRÁSnaplók API Managementhez való használatáról:

• Log Analytics-oktatóanyag, vagy próbálja ki a Log Analytics bemutatókörnyezetét.

• A napló lekérdezéseinek áttekintése az Azure Monitorban.

• AZ API Management erőforrásnapló sémájának referenciája.

API-naplózási beállítások módosítása

Alapértelmezés szerint, amikor diagnosztikai beállítást hoz létre az erőforrásnaplók gyűjtésének engedélyezéséhez, a naplózás minden API-hoz engedélyezve van, alapértelmezett beállításokkal. Módosíthatja az összes API naplózási beállításait, vagy felülbírálhatja őket az egyes API-k esetében. Módosíthatja például a mintavételezési sebességet vagy az adatok részletességét, engedélyezheti az élőfejek naplózását, a kérelmek vagy válaszok hasznos adatainak naplózását, vagy letilthatja a naplózást egyes API-k esetében.

A naplózási beállításokkal kapcsolatos részletekért lásd a diagnosztikai naplózási beállításokra vonatkozó referenciát.

Az összes API naplózási beállításainak konfigurálása:

1. Az API Management-példány bal oldali menüjében válassza az API-k minden API-ját>.
2. Válassza a Gépház lapot a felső sávon.
3. Görgessen le a Diagnosztikai naplók szakaszhoz, és válassza az Azure Monitor lapot.
4. Tekintse át a beállításokat, és szükség esetén végezze el a módosításokat. Válassza a Mentés lehetőséget.

Egy adott API naplózási beállításainak konfigurálása:

1. Az API Management-példány bal oldali menüjében válassza az API-kat , majd az API nevét.
2. Válassza a Gépház lapot a felső sávon.
3. Görgessen le a Diagnosztikai naplók szakaszhoz, és válassza az Azure Monitor lapot.
4. Tekintse át a beállításokat, és szükség esetén végezze el a módosításokat. Válassza a Mentés parancsot.

Fontos

Ha engedélyezve van, a naplózott kérések vagy válaszok hasznos adatai legfeljebb 8192 bájtot tartalmazhatnak. Az API Management 32 KB-os korlátot is kényszerít az Azure Monitornak küldött diagnosztikai naplóbejegyzésre, amely tartalmazza a hasznos adatokat és egyéb attribútumokat, például az állapotkódokat, fejléceket és időbélyegeket. Ha az attribútumok együttes mérete meghaladja a 32 KB-ot, az API Management az összes törzs- és nyomkövetési tartalom eltávolításával levágja a bejegyzést.

Következő lépések

Ez az oktatóanyag bemutatta, hogyan végezheti el az alábbi műveleteket:

• Az API-k mérőszámainak megtekintése
• Riasztási szabály beállítása
• Tevékenységnaplók megtekintése
• Erőforrásnaplók engedélyezése és megtekintése

Folytassa a következő oktatóanyaggal:

Hívások nyomon követése