Zelfstudie: Gepubliceerde API's bewaken

Met Azure Monitor kunt u visualiseren, query's uitvoeren, routeren, archiveren en actie ondernemen op basis van de metrische gegevens en logboeken vanuit uw Azure API Management-service.

In deze zelfstudie leert u het volgende:

U kunt ook de ingebouwde analytische gegevens van API Management gebruiken om het gebruik en de prestaties van uw API's te bewaken.

Vereisten

• Informatie over de terminologie van Azure API Management.
• Voltooi de volgende snelstartgids: Een Azure API Management-exemplaar maken.
• Voltooi ook de volgende zelfstudie: Uw eerste API importeren en publiceren.

Beschikbaarheid

Metrische gegevens van uw API's weergeven

API Management geeft elke minuut metrische gegevens vrij, waardoor u in vrijwel realtime inzicht hebt in de status van uw API's. Hierna staan de twee meestgebruikte metrische gegevens. Zie ondersteunde metrische gegevens voor een lijst met alle beschikbare metrische gegevens.

• Capaciteit: hiermee kunt u beslissingen nemen over het uitvoeren van een up- of downgrade van uw APIM-services. Dit gegeven komt elke minuut beschikbaar en is een weerspiegeling van de capaciteit van de gateway ten tijde van de export. Het gegevensbereik loopt van 0 tot 100 en wordt berekend op basis van gateway-resources als CPU- en geheugengebruik.
• Aanvragen: helpt u bij het analyseren van API-verkeer via uw API Management-services. De meetwaarde wordt iedere minuut verzonden en rapporteert het aantal gateway-aanvragen met dimensies, inclusief responscodes, locatie, hostnaam en fouten.

Metrische gegevens openen:

1. Blader in Azure Portal naar uw API Management-exemplaar. Bekijk op de pagina Overzicht de belangrijkste metrische gegevens voor uw API's.

2. Als u de metrische gegevens grondig wilt onderzoeken, selecteert u Metrische gegevens in het menu onderaan de pagina.

   

3. Selecteer in de vervolgkeuzelijst de gewenste metrische gegevens. Bijvoorbeeld Aanvragen.

4. De grafiek toont het totale aantal API-aanroepen.

5. De grafiek kan worden gefilterd met behulp van de dimensies van de meetwaarde Aanvragen. Selecteer bijvoorbeeld Filter toevoegen, selecteer Categorie Antwoordstatus van back-end en voer 500 in als de waarde. De grafiek toont nu het aantal aanvragen dat is mislukt in de API-back-end.

Een waarschuwingsregel instellen

U kunt waarschuwingen ontvangt op basis van metrische gegevens en activiteitenlogboeken. Met Azure Monitor kunt u een waarschuwing configureren om het volgende te doen bij activering:

• Een e-mailmelding verzenden
• Een webhook aanroepen
• Een logische Azure-app aanroepen

Een voorbeeld van een waarschuwingsregel configureren op basis van een aangevraagd metrisch gegeven:

1. Blader in Azure Portal naar uw API Management-exemplaar.

2. Selecteer Waarschuwingen in de menubalk onderaan de pagina.

   

3. Selecteer + Nieuwe waarschuwingsregel.

4. In het venster Waarschuwingsregel maken Voorwaarde selecteren.

5. In het venster Signaallogica configureren:

   1. Selecteer in Signaaltype Metrische gegevens.
   2. Selecteer in Signaalnaam Aanvragen.
   3. Selecteer in Splitsen op dimensies in Dimensienaam Categorie antwoordcode van gateway.
   4. Selecteer in Dimensiewaarden 4xx voor clientfouten, zoals niet-geautoriseerde of ongeldige aanvragen.
   5. Geef in Waarschuwingslogica een drempelwaarde op waarna de waarschuwing moet worden geactiveerd en selecteer Gereed.

   

6. Selecteer een bestaande actiegroep of maak een nieuwe groep. In het volgende voorbeeld wordt een nieuwe actiegroep gemaakt. Er wordt een e-mailmelding verzonden naar admin@contoso.com.

   

7. Voer een naam en beschrijving van de waarschuwingsregel in en selecteer het ernstniveau.

8. Selecteer Waarschuwingsregel maken.

9. Test nu de waarschuwingsregel door de Conference API aan te roepen zonder een API-sleutel. Bijvoorbeeld:

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

   Er wordt een waarschuwing geactiveerd op basis van de evaluatieperiode en er wordt een e-mail verzonden naar admin@contoso.com.

   Waarschuwingen worden ook weergegeven op de pagina Waarschuwingen voor het API Management-exemplaar.

   

Activiteitenlogboeken

Activiteitenlogboeken bieden inzicht in de bewerkingen die zijn uitgevoerd voor uw API Management-services. Met activiteitenlogboeken kunt u het 'wat, wie en wanneer' bepalen voor schrijfbewerkingen (PUT, POST, DELETE) die voor uw API Management-services worden uitgevoerd.

U kunt activiteitenlogboeken in uw API Management-service openen. U kunt alle logboeken van al uw Azure-resources in Azure Monitor openen.

Het activiteitenlogboek weergeven:

1. Blader in Azure Portal naar uw API Management-exemplaar.

2. Selecteer Activiteitenlogboek.

   

3. Selecteer het gewenste filterbereik en vervolgens Toepassen.

Resourcelogboeken

Resourcelogboeken bieden uitgebreide informatie over bewerkingen en fouten die belangrijk zijn voor zowel controles als het oplossen van problemen. Resourcelogboeken verschillen van activiteitenlogboeken. Het activiteitenlogboek biedt inzicht in de bewerkingen die zijn uitgevoerd op uw Azure-resources. Resourcelogboeken bieden inzicht in bewerkingen die door de resources zelf zijn uitgevoerd.

Ga als volgt te werk om resourcelogboeken te configureren:

1. Blader in Azure Portal naar uw API Management-exemplaar.

2. Selecteer Diagnostische instellingen.

   

3. Selecteer + Diagnostische instelling toevoegen.

4. Selecteer de logboeken of metrische gegevens die u wilt verzamelen.

   U kunt resourcelogboeken samen met metrische gegevens naar een opslagaccount archiveren, ze naar een Event Hub streamen of ze naar een Log Analytics-werkruimte verzenden.

Raadpleeg Diagnostische instellingen maken om logboeken en metrische gegevens van het platform te verzenden naar verschillende bestemmingen voor meer informatie.

Diagnostische gegevens weergeven in Azure Monitor

Als u het verzamelen van GatewayLogs of metrische gegevens in een Log Analytics-werkruimte inschakelt, kan het enkele minuten duren voordat gegevens worden weergegeven in Azure Monitor. De gegevens weergeven:

1. Blader in Azure Portal naar uw API Management-exemplaar.

2. Selecteer Logboeken in het menu onderaan de pagina.

   

Voer query's uit om de gegevens weer te geven. Er worden verschillende voorbeeldquery's gegeven of u kunt uw eigen query's uitvoeren. Met de volgende query wordt bijvoorbeeld de meest recente 24 uur aan gegevens opgehaald uit de GatewayLogs-tabel:

ApiManagementGatewayLogs
| where TimeGenerated > ago(1d) 

Raadpleeg voor meer informatie over het gebruik van resourcelogboeken voor API Management:

• Aan de slag met Azure Monitor Log Analytics of probeer de Log Analytics-testomgeving.

• Overzicht van logboekquery’s in Azure Monitor.

De volgende JSON geeft een voorbeeldvermelding in GatewayLogs aan voor een succesvolle API-aanvraag. Raadpleeg de naslaginformatie over schema's voor meer informatie.

{
    "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"
}

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

Ga door naar de volgende zelfstudie: