Referenční informace k nastavení diagnostických protokolů: API Management
PLATÍ PRO: Všechny úrovně služby API Management
Tento odkaz popisuje nastavení protokolování diagnostiky rozhraní API z instance služby API Management. Pokud chcete povolit protokolování požadavků rozhraní API, projděte si následující doprovodné materiály:
- Shromažďování protokolů prostředků
- Integrace služby Azure API Management s Aplikace Azure lication Insights
Poznámka:
Některá nastavení, kde je uvedeno, se vztahují pouze na protokolování do Application Insights.
| Nastavení | Typ | Popis |
|---|---|---|
| Povolit | boolean | Určuje, jestli je povolené protokolování tohoto rozhraní API. Protokolování je možné povolit pro všechna rozhraní API nebo pro jednotlivá rozhraní API. Nastavení pro jednotlivá nastavení přepsání rozhraní API pro všechna rozhraní API, pokud je povoleno. |
| Cíl | protokolovací služba Aplikace Azure lication Insights | Určuje protokolovací nástroj, který se má použít pro protokolování Application Insights. |
| Vzorkování (%) | decimal | Hodnoty od 0 do 100 (procent) Určuje procento zaprotokolovaných požadavků. 0 % vzorkování znamená, že se protokolují nulové požadavky, zatímco 100% vzorkování znamená, že se protokolují všechny požadavky. Výchozí hodnota: 100 Informace o dopadu na výkon protokolování Application Insights najdete v tématu Vliv na výkon a vzorkování protokolů. |
| Vždy protokolovat chyby | boolean | Pokud je toto nastavení povolené, protokolují se všechna selhání bez ohledu na nastavení vzorkování . |
| Ip adresa klienta protokolu | boolean | Pokud je toto nastavení povolené, zaprotokoluje se IP adresa klienta pro požadavky rozhraní API. |
| Podrobnosti | Určuje úroveň podrobností protokolů a to, jestli se protokolují vlastní trasování nakonfigurovaná v zásadách trasování . * Chyba – neúspěšné požadavky a vlastní trasování závažnosti error* Informace – neúspěšné a úspěšné požadavky a vlastní trasování závažnosti error a information* Podrobné – neúspěšné a úspěšné požadavky a vlastní trasování závažnosti error, informationa verboseVýchozí: Informace |
|
| Korelační protokol | Určuje protokol použitý ke korelaci telemetrie odesílaných více komponentami do Application Insights. Výchozí: Starší verze Informace najdete v tématu Korelace telemetrie v Application Insights. |
|
| Hlavičky pro protokolování | list | Určuje hlavičky, které jsou protokolovány pro požadavky a odpovědi. Výchozí hodnota: Nejsou zaprotokolovány žádné hlavičky. |
| Počet bajtů datové části ,které se mají protokolovat | integer | Určuje počet počátečních bajtů front-endu nebo back-endového požadavku nebo textu odpovědi, které se protokolují. Maximum: 8 192. Výchozí hodnota: 0 |
| Front-endový požadavek | Určuje, jestli se protokolují front-endové požadavky (požadavky příchozí do brány služby API Management). Pokud je toto nastavení povolené, zadejte hlavičky, které se mají protokolovat, počet bajtů datové části, které se mají protokolovat, nebo obojí. |
|
| Front-endová odpověď | Určuje, jestli se protokolují front-endové odpovědi (odchozí odpovědi z brány služby API Management). Pokud je toto nastavení povolené, zadejte hlavičky, které se mají protokolovat, počet bajtů datové části, které se mají protokolovat, nebo obojí. |
|
| Žádost back-endu | Určuje, jestli se protokolují požadavky back-endu (požadavky odchozí z brány služby API Management). Pokud je toto nastavení povolené, zadejte hlavičky, které se mají protokolovat, počet bajtů datové části, které se mají protokolovat, nebo obojí. |
|
| Odpověď back-endu | Určuje, jestli se protokolují odpovědi back-endu (odpovědi příchozí do brány služby API Management). Pokud je toto nastavení povolené, zadejte hlavičky, které se mají protokolovat, počet bajtů datové části, které se mají protokolovat, nebo obojí. |
Důležité
Pokud je tato možnost povolená, může protokolovaná datová část požadavku nebo odpovědi obsahovat až 8 192 bajtů. Api Management také vynucuje limit 32 kB pro položku diagnostického protokolu odesílanou do služby Azure Monitor, která zahrnuje datové části a další atributy, jako jsou stavové kódy, hlavičky a časové razítka. Pokud kombinovaná velikost atributů překročí 32 kB, služba API Management položku oříznou odebráním veškerého obsahu textu a trasování.
Další kroky
- Další informace najdete v referenčních informacích pro diagnostickou entitu v rozhraní REST API služby API Management.
- Pomocí zásad trasování můžete přidat vlastní trasování do telemetrie Application Insights, protokolů prostředků nebo trasování požadavků.