Waarneembaarheid in Azure API Management

VAN TOEPASSING OP: Alle lagen van API Management

Waarneembaarheid is de mogelijkheid om inzicht te verkrijgen in de interne status van een systeem van de gegevens die het produceert en de mogelijkheid om die gegevens te verkennen om vragen te beantwoorden over wat er is gebeurd en waarom.

Met Azure API Management kunnen organisaties het beheer van alle API's centraliseren. Omdat het fungeert als een single point of entry van alle API-verkeer, is het een ideale plek om de API's te observeren.

Overzicht

Met Azure API Management kunt u ervoor kiezen om de beheerde gateway of zelf-hostende gateway te gebruiken, hetzij zelf geïmplementeerd of met behulp van een Azure Arc-extensie.

De volgende tabel bevat een overzicht van alle waarneembaarheidsmogelijkheden die worden ondersteund door API Management om API's te gebruiken en welke implementatiemodellen ze ondersteunen. API-uitgevers en anderen met machtigingen om het API Management-exemplaar te gebruiken of te beheren, kunnen deze mogelijkheden gebruiken.

Notitie

Voor API-gebruikers die de ontwikkelaarsportal gebruiken, is er een ingebouwd API-rapport beschikbaar. Het biedt alleen informatie over hun afzonderlijke API-gebruik gedurende de voorgaande 90 dagen. Het ingebouwde API-rapport is momenteel niet beschikbaar in de ontwikkelaarsportal voor de v2-servicelagen.

Gereedschap Handig voor Gegevensvertraging4 Retentie Steekproeven Gegevenstype Ondersteunde implementatiemodellen
Verzoektracering (API Inspector) Testen en foutopsporing Meteen Laatste 100 traceringen Ingeschakeld per aanvraag Traceringen aanvragen Beheerd, zelf-hostend, Azure Arc, werkruimte
Ingebouwde analyse Rapportage en monitoring Minuten Levensduur 100% Rapporten en logboeken Beheerd
Metrische gegevens van Azure Monitor Rapportage en monitoring Minuten 90 dagen (upgrade om uit te breiden) 100% Metrische gegevens Beheerd, zelf-hostend2, Azure Arc
Azure Monitor-logboeken Rapportage, monitoring en foutopsporing Minuten 31 dagen/5 GB (upgrade om uit te breiden) 100% (aanpasbaar) Logboeken Beheerde1, zelf-gehoste3, Azure Arc3
Azure-toepassing Insights Rapportage, monitoring en foutopsporing Seconden 90 dagen/5 GB (upgrade om uit te breiden) Op maat Logboeken, metrische gegevens Beheerde1, Zelf-gehoste1, Azure Arc1, Werkruimte1
Logboekregistratie via Azure Event Hubs Aangepaste scenario's Seconden Door gebruiker beheerd Op maat Op maat Beheerde1, zelf-gehoste1, Azure Arc1
OpenTelemetry Controleren Minuten Door gebruiker beheerd 100% Metrische gegevens Zelfgehost2

1 Optioneel, afhankelijk van de configuratie van de functie in Azure API Management.
2 Optioneel, afhankelijk van de configuratie van de gateway.
3 De zelf-hostende gateway verzendt momenteel geen diagnostische logboeken naar Azure Monitor. Het is echter mogelijk om logboeken lokaal te configureren en te behouden waar de zelf-hostende gateway wordt geïmplementeerd. Zie voor meer informatie het configureren van lokale metrische gegevens en logboeken voor zelf-hostende gateway.
4 Behalve voor het traceren van aanvragen, vindt alle logboekregistratie in API Management asynchroon plaats.

Aanbevolen procedures

Met de volgende procedures kunt u uw API-waarneembaarheid verbeteren:

  • Gedetailleerde bewaking: schakel metrische gegevens per methode in voor gedetailleerde inzichten in reactietijden en foutpercentages.
  • Bewaking van tail-latentie: configureer waarschuwingen per methode voor tail-latentie (bijvoorbeeld 90e, 95e of 99e percentiel), omdat de gemiddelde latentie misleidend kan zijn. Als u deze functie wilt implementeren, gebruikt u Kusto Query Language (KQL) om logboeken door te sturen naar een Log Analytics werkruimte.
  • Proactieve waarschuwingen: stel waarschuwingen per methode in voor foutpercentages en lage slagingspercentages , gebruikspercentages in plaats van aantallen om nauwkeurigheid te garanderen.
  • Gedistribueerde tracering: schakel tracering in om knelpunten in de prestaties te identificeren en problemen op te lossen.
  • Resourcetagging: tags toepassen op API's voor nauwkeurige kostentracking en -allocatie.

Verwante inhoud

  • Last updated on