Pozorovatelnost ve službě Azure API Management

PLATÍ PRO: Všechny úrovně služby API Management

Pozorovatelnost je schopnost pochopit vnitřní stav systému z dat, která vytváří, a schopnost zkoumat tato data a odpovídat na otázky ohledně toho, co se stalo a proč.

Azure API Management pomáhá organizacím centralizovat správu všech rozhraní API. Protože slouží jako jediný vstupní bod veškerého provozu rozhraní API, je ideálním místem pro sledování rozhraní API.

Přehled

Azure API Management umožňuje použít spravovanou bránu nebo bránu v místním prostředí, a to buď samostatně nasazenou, nebo pomocí rozšíření Azure Arc.

Následující tabulka shrnuje všechny možnosti pozorovatelnosti podporované službou API Management za účelem provozu rozhraní API a modelů nasazení, které podporují. Vydavatelé rozhraní API a další uživatelé s oprávněními k provozování nebo správě instance služby API Management můžou tyto funkce používat.

Poznámka:

Pro uživatele rozhraní API, kteří používají portál pro vývojáře, je k dispozici integrovaná sestava rozhraní API. Poskytuje pouze informace o jejich individuálním využití rozhraní API během předchozích 90 dnů. V současné době není vestavěná zpráva API dostupná pro úrovně služby verze 2 na portálu pro vývojáře.

Nástroj Užitečné pro Zpoždění dat4 Uchovávání Vzorkování Druh dat Podporované modely nasazení
Trasování požadavků (inspektor rozhraní API) Testování a ladění Okamžitě Posledních 100 tras Zapnuto na požadavek Trasování požadavků Spravované, vlastní hosting, Azure Arc, pracovní prostor
Integrovaná analýza Sledování a vytváření sestav Minuty Životnost 100 % Sestavy a protokoly Spravované
Metriky Azure Monitoru Sledování a vytváření sestav Minuty 90 dnů (upgrade na prodloužení) 100 % Ukazatele Spravované, Vlastní hosting2, Azure Arc
Protokoly Azure Monitoru Zpráva, monitorování a ladění Minuty 31 dní/5 GB (upgrade na prodloužení) 100 % (nastavitelné) Záznamy Spravovaná1, samohostovaná3, Azure Arc3
Aplikace Azure Insights Zpráva, monitorování a ladění Sekundy 90 dní/5 GB (upgrade na prodloužení) Vlastní Protokoly, metriky Spravované1, vlastní hosting1, Azure Arc1, pracovní prostor1
Protokolování prostřednictvím Azure Event Hubs Vlastní scénáře Sekundy Spravované uživatelem Vlastní Vlastní Spravované1, Vlastní hostování1, Azure Arc1
OpenTelemetry Sledování Minuty Spravované uživatelem 100 % Ukazatele Vlastní hosting2

1 Volitelné v závislosti na konfiguraci funkce ve službě Azure API Management.
2 Volitelné v závislosti na konfiguraci brány.
3 Brána v místním prostředí aktuálně neodesílá diagnostické protokoly do služby Azure Monitor. Je ale možné nakonfigurovat a zachovat protokoly místně, kde je nasazená brána v místním prostředí. Další informace najdete v tématu Konfigurace místních metrik a protokolů pro bránu v místním prostředí.
4 S výjimkou trasování požadavků probíhá veškeré protokolování ve službě API Management asynchronně.

Doporučené postupy

Následující postupy můžou vylepšit pozorovatelnost rozhraní API:

  • Podrobné monitorování: Povolte metriky jednotlivých metod pro podrobné přehledy doby odezvy a míry chyb.
  • Monitorování latence v horním percentilu: Nakonfigurujte pro každou metodu upozornění na latenci v horním percentilu (například 90., 95. nebo 99. percentil), protože průměrná latence může být zavádějící. K implementaci této funkce použijte dotazovací jazyk Kusto (KQL) k předání protokolů do pracovního prostoru Log Analytics.
  • Proaktivní upozorňování: Vytvořte výstrahy pro jednotlivé metody pro chybové míry a nízké míry úspěšnosti , používejte sazby místo počtu, abyste zajistili přesnost.
  • Distribuované trasování: Povolte trasování, abyste mohli identifikovat úzká místa výkonu a odstraňovat problémy.
  • Označování prostředků: Použijte značky u rozhraní API pro přesné sledování a alokaci nákladů.

Související obsah

  • Last updated on