Zelfstudie: Gepubliceerde API's bewaken

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

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:

  • Metrische gegevens van uw API weergeven
  • Een waarschuwingsregel instellen
  • Activiteitenlogboeken bekijken
  • Resourcelogboeken inschakelen en weergeven

Notitie

API Management ondersteunt een reeks extra hulpprogramma's voor het observeren van API's, waaronder ingebouwde analyses en integratie met Application Insights. Meer informatie

Vereisten

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 : helpt u beslissingen te nemen over het upgraden/downgraden van uw API Management-services. De metrische waarde wordt per minuut verzonden en weerspiegelt de geschatte gatewaycapaciteit op het moment van rapportage. 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 metrische waarde wordt per minuut verzonden en rapporteert het aantal gatewayaanvragen met dimensies. Filter aanvragen op antwoordcodes, locatie, hostnaam en fouten.

Belangrijk

De volgende metrische gegevens zijn vanaf mei 2019 afgeschaft en worden in augustus 2023 buiten gebruik gesteld: Totaal aantal gatewayaanvragen, geslaagde gatewayaanvragen, niet-geautoriseerde gatewayaanvragen, mislukte gatewayaanvragen, andere gatewayaanvragen. Migreer naar de metrische gegevens voor aanvragen met gelijkwaardige functionaliteit.

Schermopname van metrische gegevens in API Management-overzicht

Metrische gegevens openen:

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

  2. Als u metrische gegevens in detail wilt onderzoeken, selecteert u Metrische gegevens in het linkermenu.

    Schermopname van het item Metrische gegevens in het menu Bewaking in de portal.

  3. Selecteer in de vervolgkeuzelijst metrische gegevens waarin u geïnteresseerd bent. Bijvoorbeeld Aanvragen.

  4. De grafiek toont het totale aantal API-aanroepen. Pas het tijdsbereik aan om te focussen op perioden van interesse.

  5. U kunt de grafiek filteren met behulp van de dimensies van de metrische gegevens Voor aanvragen . Selecteer bijvoorbeeld Filter toevoegen, selecteer Categorie antwoordcode voor back-end en voer 500 deze in als de waarde. In de grafiek ziet u het aantal mislukte aanvragen in de API-back-end.

Een waarschuwingsregel instellen

U kunt waarschuwingen ontvangt op basis van metrische gegevens en activiteitenlogboeken. Configureer in Azure Monitor een waarschuwingsregel om een actie uit te voeren wanneer deze wordt geactiveerd. Veelvoorkomende acties zijn:

  • 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 het linkermenu.

    Schermopname van de optie Waarschuwingen in het menu Bewaking in de portal.

  3. Selecteer + Waarschuwingsregel maken>.

  4. In het venster Een signaal selecteren op het tabblad Voorwaarde :

    1. Selecteer in SignaaltypeMetrische gegevens.
    2. Selecteer in SignaalnaamAanvragen.
    3. Geef in waarschuwingslogica een drempelwaarde op, het aantal exemplaren waarna de waarschuwing moet worden geactiveerd.
    4. Selecteer in Splitsen op dimensies in DimensienaamCategorie antwoordcode van gateway.
    5. Selecteer in Dimensiewaarden4xxvoor clientfouten, zoals niet-geautoriseerde of ongeldige aanvragen. Als de dimensiewaarde niet wordt weergegeven, selecteert u Aangepaste waarde toevoegen en voert u 4xx in.
    6. Accepteer in Wanneer u de standaardinstellingen wilt evalueren of selecteer andere instellingen om te configureren hoe vaak de regel wordt uitgevoerd. Selecteer Volgende.

    Schermopname van het configureren van waarschuwingslogica in de portal.

  5. Selecteer of maak op het tabblad Acties een of meer actiegroepen om gebruikers op de hoogte te stellen van de waarschuwing en een actie te ondernemen. Maak bijvoorbeeld een nieuwe actiegroep om een e-mailmelding naar te admin@contoso.comverzenden. Zie Actiegroepen maken en beheren in Azure Portal voor gedetailleerde stappen.

    Schermopname van het configureren van meldingen voor een nieuwe actiegroep in de portal.

  6. Voer op het tabblad Details van Een waarschuwingsregel maken een naam en beschrijving van de waarschuwingsregel in en selecteer het ernstniveau.

  7. Configureer eventueel de overige instellingen. Selecteer Vervolgens op het tabblad Beoordelen en maken de optie Maken.

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

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

    Een waarschuwing wordt geactiveerd op basis van de evaluatieperiode en stuurt een e-mail naar admin@contoso.com.

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

    Schermopname van waarschuwingen in de portal.

Activiteitenlogboeken

Activiteitenlogboeken bieden inzicht in de bewerkingen in 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.

Notitie

Activiteitenlogboeken bevatten geen lees-bewerkingen (GET) of bewerkingen die zijn uitgevoerd in de Azure-portal of met behulp van de oorspronkelijke beheer-API's.

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

Schermopname van activiteitenlogboek in de portal.

Het activiteitenlogboek weergeven:

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

  2. Selecteer Activiteitenlogboek.

    Schermopname van het item Activiteitenlogboek in het menu Bewaking in de portal.

  3. Selecteer het gewenste filterbereik en vervolgens Toepassen.

Resourcelogboeken

Resourcelogboeken (Azure Monitor-logboeken) bieden uitgebreide informatie over API Management-bewerkingen en -fouten die belangrijk zijn voor controle- en probleemoplossingsdoeleinden. Wanneer deze optie is ingeschakeld via een diagnostische instelling, verzamelen de logboeken informatie over de API-aanvragen die worden ontvangen en verwerkt door de API Management-gateway.

Notitie

De verbruikslaag biedt geen ondersteuning voor het verzamelen van resourcelogboeken.

Ga als volgt te werk om resourcelogboeken te configureren:

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

  2. Selecteer Diagnostische instellingen.

    Schermopname van het item Diagnostische instellingen in het menu Bewaking in de portal.

  3. Selecteer + Diagnostische instelling toevoegen.

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

    U hebt verschillende opties voor het verzenden van de logboeken en metrische gegevens. Archiveer bijvoorbeeld resourcelogboeken samen met metrische gegevens naar een opslagaccount, stream ze naar een Event Hub of verzend ze naar een Log Analytics-werkruimte.

    Tip

    Als u een Log Analytics-werkruimte selecteert, kunt u ervoor kiezen om de gegevens op te slaan in de resourcespecifieke apiManagementGatewayLogs-tabel of om op te slaan in de algemene AzureDiagnostics-tabel. U wordt aangeraden de resource specifieke tabel te gebruiken voor logboekbestemmingen die dit ondersteunen. Meer informatie

  5. Nadat u details voor de doel- of bestemming van het logboek hebt geconfigureerd, selecteert u Opslaan.

Notitie

Het toevoegen van een object voor diagnostische instellingen kan leiden tot een fout als de eigenschap MinApiVersion van uw API Management-service is ingesteld op een API-versie die hoger is dan 2022-09-01-preview.

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 logboeken 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 linkermenu.

    Schermopname van het item Logboeken in het menu Bewaking in de portal.

  3. 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 worden bijvoorbeeld de meest recente 24 uur aan gegevens opgehaald uit de tabel ApiManagementGatewayLogs:

    ApiManagementGatewayLogs
| where TimeGenerated > ago(1d)

    Schermopname van het uitvoeren van query's op de tabel ApiManagementGatewayLogs in de portal.

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

Instellingen voor API-logboekregistratie wijzigen

Wanneer u een diagnostische instelling maakt om het verzamelen van resourcelogboeken in te schakelen, wordt logboekregistratie standaard ingeschakeld voor alle API's, met standaardinstellingen. U kunt de logboekinstellingen voor alle API's aanpassen of deze overschrijven voor afzonderlijke API's. Pas bijvoorbeeld de steekproefsnelheid of de uitgebreidheid van de gegevens aan of schakel logboekregistratie voor sommige API's uit.

Zie de naslaginformatie over de instellingen voor diagnostische logboekregistratie voor meer informatie over de instellingen voor logboekregistratie.

Instellingen voor logboekregistratie configureren voor alle API's:

  1. Selecteer in het linkermenu van uw API Management-exemplaar ALLE API's>.
  2. Selecteer het tabblad Instellingen in de bovenste balk.
  3. Schuif omlaag naar de sectie Diagnostische logboeken en selecteer het tabblad Azure Monitor .
  4. Controleer de instellingen en breng indien nodig wijzigingen aan. Selecteer Opslaan.

Logboekinstellingen voor een specifieke API configureren:

  1. Selecteer API's in het linkermenu van uw API Management-exemplaar en vervolgens de naam van de API.
  2. Selecteer het tabblad Instellingen in de bovenste balk.
  3. Schuif omlaag naar de sectie Diagnostische logboeken en selecteer het tabblad Azure Monitor .
  4. Controleer de instellingen en breng indien nodig wijzigingen aan. Selecteer Opslaan.

Volgende stappen

In deze zelfstudie heeft u het volgende geleerd:

  • Metrische gegevens van uw API weergeven
  • Een waarschuwingsregel instellen
  • Activiteitenlogboeken bekijken
  • Resourcelogboeken inschakelen en weergeven

Ga door naar de volgende zelfstudie:

Oproepen traceren