Oktatóanyag: Közzétett API-k figyelése

A Azure Monitor segítségével vizualizálhatja, lekérdezheti, irányíthatja, archiválhatja az Azure-szolgáltatásokból származó metrikákat vagy naplókat, és API Management műveleteket.

Eben 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

Az API API Management k használatának és teljesítményének figyelése érdekében az api-k beépített elemzésével is figyelheti.

Előfeltételek

Rendelkezésre állás

Fontos

Ez a funkció a API Management prémium, standard , alapszintű és fejlesztői szintjein érhető el.

Az API-k metrikáinak megtekintése

API Management percenként metrikákat bocsát ki, így közel valós idejű betekintést biztosít az API-k állapotába és állapotába. A két leggyakrabban használt metrika a következő. Az összes rendelkezésre álló metrika listájáért tekintse meg a támogatott metrikákat.

  • Kapacitás – segít döntéseket hozni az APIM-szolgáltatások frissítésével/visszalépésével kapcsolatban. A mérőszám percentként keletkezik, és az átjáró a jelentés pillanatában érvényes 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 a API Management szolgáltatásokon. A metrikát a rendszer percenként bocsátja ki, és a dimenziókkal kapcsolatos átjárókérések számát jelenti, beleértve a válaszkódokat, a helyet, az állomásnevet és a hibákat.

Fontos

A következő metrikák 2019 májusában elavultak, és 2023 augusztusában ki lesznek vezetve: Ö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. Kérjük, lépjen át a Requests (Kérések) metrikára, amely egyenértékű funkciókat biztosít.

Képernyőkép a metrikákról a API Management áttekintésében

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

  1. A Azure Portalkeresse meg a API Management példányát. Az Áttekintés lapon tekintse át az API-k fő metrikákat.

  2. A metrikák részletes vizsgálathoz válassza az oldal alján található menü Metrikák parancsát.

    A Figyelés menü Metrikák elemének képernyőképe

  3. A legördülő listából válassza ki a megtekinteni kívánt mérőszámokat. Például: Requests ( Kérések).

  4. A diagram az API-hívások teljes számát mutatja,

  5. A diagram a Kérelmek metrika dimenziói alapján szűrhető. 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ája lehetőséget, és adja meg az 500 értéket. A diagramon most az API-háttérben meghiúsult kérelmek száma látható.

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

Metrikák és tevékenységnaplók alapján kaphat riasztásokat. Azure Monitor lehetővé teszi, hogy a riasztásokat úgy konfigurálja, hogy az a következőt tegye, amikor az aktiválódik:

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

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

  1. A Azure Portalnyissa meg a API Management példányát.

  2. Válassza a lap alján található menüsáv Riasztások elemet.

    A Figyelés menü Riasztások lehetőségének képernyőképe

  3. Válassza a + Új riasztási szabály lehetőséget.

  4. A Riasztási szabály létrehozása ablakban válassza ki a feltételt.

  5. A Jellogika konfigurálása ablakban:

    1. A Jel típusa mezőben válassza a Metrikák lehetőséget.
    2. A Jel neve mezőben válassza a Kérelmek lehetőséget.
    3. A Felosztás dimenziók szerint mezőben a Dimenziónév mezőben válassza az Átjáró válaszkód-kategóriája lehetőséget.
    4. A Dimenzióértékek mezőben válassza a 4xx értéket az olyan ügyfélhibák esetén, mint a jogosulatlan vagy érvénytelen kérések.
    5. A Riasztási logika mezőben adjon meg egy küszöbértéket, amely után a riasztást aktiválni kell, majd válassza a Kész lehetőséget.

    A Jellogika konfigurálása ablak képernyőképe

  6. Válasszon ki egy meglévő műveletcsoportot, vagy hozzon létre egy újat. A következő példában egy új műveletcsoportot hozunk létre. A rendszer egy értesítő e-mailt küld a admin@contoso.com címre.

    Képernyőkép az új műveletcsoport értesítéseiről

  7. Adja meg a riasztási szabály nevét és leírását, és válassza ki a súlyossági szintet.

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

  9. Most tesztelje a riasztási szabályt úgy, hogy API-kulcs nélkül hívja meg a Conference API-t. Például:

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

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

    A riasztások a riasztáspéldány Riasztások API Management is megjelennek.

    A portálon látható riasztások képernyőképe

Tevékenységnaplók

A tevékenységnaplók betekintést engednek az API Management-szolgáltatásokban végrehajtott műveletekbe. 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.

Megjegyzé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.

Képernyőkép a tevékenységnaplóról a portálon

A tevékenységnapló megtekintése:

  1. A Azure Portalkeresse meg a API Management példányát.

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

    A Figyelés menü Tevékenységnapló elemének képernyőképe

  3. Válassza ki a kívánt szűrési hatókört, majd válassza az Alkalmaz lehetőséget.

Erőforrásnaplók

Az erőforrásnaplók részletes információkat nyújtanak a naplózáshoz és hibaelhárításhoz fontos műveletekkel és hibákkal kapcsolatban. Az erőforrásnaplók eltérnek a tevékenységnaplóktól. A tevékenységnapló betekintést nyújt az Azure-erőforrásokon végrehajtott műveletekbe. Az erőforrásnaplók betekintést nyújtanak az erőforrás által végrehajtott műveletekbe.

Az erőforrásnaplók konfigurálása:

  1. A Azure Portalkeresse meg a API Management példányát.

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

    A Figyelés menü Diagnosztikai beállítások elemének képernyőképe

  3. Válassza a + Diagnosztikai beállítás hozzáadása lehetőséget.

  4. Válassza ki a gyűjteni kívánt naplókat vagy metrikákat.

    Az erőforrásnaplókat és a metrikákat archiválhatja egy tárfiókba, streamelheti őket egy eseményközpontba, vagy elküldheti őket egy Log Analytics-munkaterületre.

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

Diagnosztikai adatok megtekintése a Azure Monitor

Ha engedélyezi a GatewayLogok vagy metrikák gyűjtését egy Log Analytics-munkaterületen, eltarthat néhány percig, hogy az adatok megjelenjenek a Azure Monitor. Az adatok megtekintése:

  1. A Azure Portalnyissa meg a API Management példányát.

  2. Válassza a Lap alján található menü Naplók menüpontját.

    A Figyelés menü Naplók elemének képernyőképe

Lekérdezések futtatásával megtekintheti az adatokat. Több mintás lekérdezés is rendelkezésre áll, vagy saját lekérdezéseket futtathat. A következő lekérdezés például a Legutóbbi 24 óra adatot olvassa be a GatewayLogs táblából:

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) 

További információ az erőforrásnaplóknak a API Management való használatával kapcsolatban:

Az alábbi JSON egy sikeres API-kéréshez egy mintabejegyzést jelez a GatewayLogsban. Részletekért tekintse meg a sémareferenciát.

{
    "Level": 4,
    "isRequestSuccess": true,
    "time": "2020-10-14T17:xx:xx.xx",
    "operationName": "Microsoft.ApiManagement/GatewayLogs",
    "category": "GatewayLogs",
    "durationMs": 152,
    "callerIpAddress": "xx.xx.xxx.xx",
    "correlationId": "3f06647e-xxxx-xxxx-xxxx-530eb9f15261",
    "location": "East US",
    "properties": {
        "method": "GET",
        "url": "https://apim-hello-world.azure-api.net/conference/speakers",
        "backendResponseCode": 200,
        "responseCode": 200,
        "responseSize": 41583,
        "cache": "none",
        "backendTime": 87,
        "requestSize": 526,
        "apiId": "demo-conference-api",
        "operationId": "GetSpeakers",
        "apimSubscriptionId": "master",
        "clientTime": 65,
        "clientProtocol": "HTTP/1.1",
        "backendProtocol": "HTTP/1.1",
        "apiRevision": "1",
        "clientTlsVersion": "1.2",
        "backendMethod": "GET",
        "backendUrl": "https://conferenceapi.azurewebsites.net/speakers"
    },
    "resourceId": "/SUBSCRIPTIONS/<subscription ID>/RESOURCEGROUPS/<resource group>/PROVIDERS/MICROSOFT.APIMANAGEMENT/SERVICE/APIM-HELLO-WORLD"
}

További 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: