Referenz zu Diagnoseprotokolleinstellungen: API Management
GILT FÜR: Alle API Management-Ebenen
In dieser Referenz werden die Einstellungen für die API-Diagnoseprotokollierung von einer API Management-Instanz beschrieben. Informationen zum Aktivieren der Protokollierung von API-Anforderungen finden Sie in den folgenden Anleitungen:
- Sammeln von Ressourcenprotokollen
- Integrieren von Azure API Management mit Azure Application Insights
Hinweis
Bestimmte Einstellungen gelten, sofern angegeben, nur für die Protokollierung in Application Insights.
| Einstellung | type | BESCHREIBUNG |
|---|---|---|
| Aktivieren | boolean | Gibt an, ob die Protokollierung dieser API aktiviert ist. Die Protokollierung kann für alle APIs oder für eine einzelne API aktiviert werden. Einstellungen für eine einzelne API setzen Einstellungen für alle APIs, sofern aktiviert, außer Kraft. |
| Destination | Azure Application Insights-Protokollierung | Gibt die für die Azure Application Insights-Protokollierung zu verwendende Protokollierung an. |
| Sampling (%) | Decimal | Werte von 0 bis 100 (Prozent). Gibt den Prozentsatz der Anforderungen an, die protokolliert werden. 0% Sampling bedeutet, dass 0 (null) Anforderungen protokolliert werden, während ein Sampling von 100% bedeutet, dass alle Anforderungen protokolliert werden. Standardwert: 100 Auswirkungen der Application Insights-Protokollierung auf die Leistung finden Sie unter Leistungsauswirkungen und Protokollstichprobenentnahme. |
| Fehler immer protokollieren | boolean | Wenn diese Einstellung aktiviert ist, werden alle Fehler unabhängig von der Einstellung Sampling protokolliert. |
| Client-IP-Adresse protokollieren | boolean | Wenn diese Einstellung aktiviert ist, wird die Client-IP-Adresse für API-Anforderungen protokolliert. |
| Ausführlichkeit | Gibt die Ausführlichkeit der Protokolle an und ob benutzerdefinierte Ablaufverfolgungen, die in Ablaufverfolgungsrichtlinien konfiguriert sind, protokolliert werden. * Fehler: fehlerhafte Anforderungen und benutzerdefinierte Ablaufverfolgungen des Schweregrads error.* Information: fehlgeschlagene und erfolgreiche Anforderungen sowie benutzerdefinierte Ablaufverfolgungen der Schweregrade error und information.* Ausführlich: fehlgeschlagene und erfolgreiche Anforderungen sowie benutzerdefinierte Ablaufverfolgungen der Schweregrade error, information und verbose.Standard: Information |
|
| Korrelationsprotokoll | Gibt das Protokoll an, das verwendet wird, um Telemetriedaten zu korrelieren, die von mehreren Komponenten an Application Insights gesendet wurden. Standard: Legacy Weitere Informationen finden Sie unter Telemetriekorrelation in Application Insights. |
|
| Zu protokollierende Header | list | Gibt die Header an, die für Anforderungen und Antworten protokolliert werden. Standard: Es werden keine Header protokolliert. |
| Anzahl der zu protokollierenden Nutzlastbytes (Textkörper) | integer | Gibt die Anzahl der anfänglichen Bytes des Frontend- oder Back-End-Anforderungs- oder Antworttexts an, die protokolliert werden. Höchstwert: 8.192 Standardwert: 0 |
| Front-End-Anforderung | Gibt an, ob und wie Front-End-Anforderungen (eingehende Anforderungen an das API Management-Gateway) protokolliert werden. Wenn diese Einstellung aktiviert ist, geben Sie Zu protokollierende Header, Anzahl zu protokollierender Nutzlastbytes oder beides an. |
|
| Front-End-Antwort | Gibt an, ob und wie Front-End-Antworten (vom API Management-Gateway ausgehende Antworten) protokolliert werden. Wenn diese Einstellung aktiviert ist, geben Sie Zu protokollierende Header, Anzahl zu protokollierender Nutzlastbytes oder beides an. |
|
| Back-End-Anforderung | Gibt an, ob und wie Back-End-Anforderungen (vom API Management-Gateway ausgehende Anforderungen) protokolliert werden. Wenn diese Einstellung aktiviert ist, geben Sie Zu protokollierende Header, Anzahl zu protokollierender Nutzlastbytes oder beides an. |
|
| Back-End-Antwort | Gibt an, ob und wie Back-End-Antworten (eingehende Antworten an das API Management-Gateway) protokolliert werden. Wenn diese Einstellung aktiviert ist, geben Sie Zu protokollierende Header, Anzahl zu protokollierender Nutzlastbytes oder beides an. |
Wichtig
Wenn diese Option aktiviert ist, können protokollierte Anforderungs- oder Antwortnutzlasten bis zu 8.192 Byte betragen. Die API-Verwaltung erzwingt außerdem einen Grenzwert von 32 KB für einen an Azure Monitor gesendeten Diagnoseprotokolleintrag, der die Nutzlasten und andere Attribute wie Statuscodes, Header und Zeitstempel umfasst. Wenn die kombinierte Größe der Attribute 32 KB überschreitet, kürzt die API-Verwaltung den Eintrag, indem alle Textkörper- und Ablaufverfolgungsinhalte entfernt werden.
Nächste Schritte
- Weitere Informationen finden Sie in der Referenz für die Diagnose-Entität in der API Management-REST-API.
- Verwenden Sie die Ablaufverfolgungsrichtlinie, um benutzerdefinierte Ablaufverfolgungen zu Application Insights-Telemetriedaten, Ressourcenprotokollen oder Anforderungsablaufverfolgungen hinzuzufügen.