Trace
GILT FÜR: Alle API Management-Ebenen
Die trace
-Richtlinie fügt der Ausgabe der Anforderungsablaufverfolgung in der Testkonsole, in Application Insights-Telemetriedaten und/oder in Ressourcenprotokollen eine benutzerdefinierte Ablaufverfolgung hinzu.
- Die Richtlinie fügt der Ausgabe der Anforderungsablaufverfolgung in der Testkonsole eine benutzerdefinierte Ablaufverfolgung hinzu, wenn die Ablaufverfolgung ausgelöst wird, d. h. der
Ocp-Apim-Trace
-Anforderungsheader vorhanden und auftrue
festgelegt ist sowie derOcp-Apim-Subscription-Key
-Anforderungsheader vorhanden ist und einen gültigen Schlüssel enthält, der die Ablaufverfolgung zulässt. - Diese Richtlinie erstellt eine Ablaufverfolgungstelemetrie in Application Insights, wenn die Application Insights-Integration aktiviert ist und der in der Richtlinie angegebene
severity
gleich oder grösser ist als dieverbosity
, die in der Diagnoseeinstellung angegeben ist. - Die Richtlinie fügt eine Eigenschaft in den Protokolleintrag ein, wenn Ressourcenprotokolle aktiviert sind und der in der Richtlinie angegebene Schweregrad gleich oder höher als der Ausführlichkeitsgrad ist, der in der Diagnoseeinstellung angegeben ist.
- Die Richtlinie ist von Application Insights-Sampling nicht betroffen. Alle Aufrufe der Richtlinie werden protokolliert.
Warnung
- Lassen Sie die Ablaufverfolgung nur für Abonnements zu, die für Debugzwecke vorgesehen sind. Die Freigabe von Abonnementschlüsseln mit Ablaufverfolgung, die für nicht autorisierte Benutzer zulässig ist, kann zu Offenlegung vertraulicher Informationen führen, die in Ablaufverfolgungsprotokollen enthalten sind, wie Schlüssel, Zugriffstoken, Kennwörter, interne Hostnamen und IP-Adressen.
- API Management deaktiviert in der Testkonsole die Ablaufverfolgung automatisch eine Stunde, nachdem sie für ein Abonnement aktiviert wurde.
Hinweis
Derzeit wird die API-Anforderungsablaufverfolgung in den Tarifen „Basic v2“ und „Standard v2“ nicht unterstützt.
Hinweis
Legen Sie die Elemente und untergeordneten Elemente einer Richtlinie in der Reihenfolge fest, die in der Richtlinienanweisung angegeben ist. Erfahren Sie mehr darüber, wie Sie API Management-Richtlinien festlegen oder bearbeiten.
Richtlinienanweisung
<trace source="arbitrary string literal" severity="verbose | information | error">
<message>String literal or expressions</message>
<metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>
Attribute
Attribut | BESCHREIBUNG | Erforderlich | Standard |
---|---|---|---|
source | Das Zeichenfolgenliteral ist für die Ablaufverfolgungsanzeige aussagekräftig und gibt die Quelle der Nachricht an. Richtlinienausdrücke sind nicht zulässig. | Ja | – |
severity | Legt den Schweregrad der Ablaufverfolgung fest. Zulässige Werte sind verbose , information und error (vom niedrigsten zum höchsten Schweregrad). Richtlinienausdrücke sind nicht zulässig. |
Nein | verbose |
Elemente
Name | BESCHREIBUNG | Erforderlich |
---|---|---|
message | Eine Zeichenfolge oder ein Ausdruck, die bzw. der protokolliert werden soll. Richtlinienausdrücke sind zulässig. | Ja |
metadata | Fügt der Application Insights-Ablaufverfolgungstelemetrie eine benutzerdefinierte Eigenschaft hinzu. | Nein |
Metadatenattribute
attribute | BESCHREIBUNG | Erforderlich | Standard |
---|---|---|---|
name | Der Name der Eigenschaft. | Ja | – |
value | Der Wert der Eigenschaft. | Ja | – |
Verwendung
- Richtlinienabschnitte: inbound, outbound, backend
- Richtlinienbereiche: global, Arbeitsbereich, Produkt, API, Vorgang
- Gateways: classic, v2, consumption, self-hosted
Beispiel
<trace source="PetStore API" severity="verbose">
<message>@((string)context.Variables["clientConnectionID"])</message>
<metadata name="Operation Name" value="New-Order"/>
</trace>
Verwandte Richtlinien
Zugehöriger Inhalt
Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier:
- Tutorial: Transformieren und Schützen Ihrer API
- Unter Richtlinien für die API-Verwaltung finden Sie eine komplette Liste der Richtlinienanweisungen und der zugehörigen Einstellungen.
- Richtlinienausdrücke
- Festlegen oder Bearbeiten von Richtlinien
- Wiederverwenden von Richtlinienkonfigurationen
- Repository für Richtliniencodeausschnitte
- Erstellen von Richtlinien mit Microsoft Copilot für Azure