Trace

  • Artikel

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.
  • 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 die verbosity, 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.

Wichtig

  • Es ist nicht mehr möglich, die Anforderungsablaufverfolgung von API Management zu aktivieren, indem der Ocp-Apim-Trace-Header in einer Anforderung festgelegt und der Wert des Ocp-Apim-Trace-Location-Headers in der Antwort zum Abrufen der Ablaufverfolgung verwendet wird.
  • Zum Verbessern der Sicherheit wird die Ablaufverfolgung jetzt auf der Ebene einer einzelnen API aktiviert, indem ein zeitlich begrenztes Token mithilfe der API Management-REST-API abgerufen und das Token in einer Anforderung an das Gateway übergeben wird. Ausführliche Informationen finden Sie weiter unten in diesem Tutorial.
  • Gehen Sie beim Aktivieren der Ablaufverfolgung mit Bedacht vor, da sie vertrauliche Informationen in den Ablaufverfolgungsdaten verfügbar machen kann. Stellen Sie sicher, dass Sie über geeignete Sicherheitsmaßnahmen zum Schützen der Ablaufverfolgungsdaten verfügen.

Hinweis

Derzeit wird die Ablaufverfolgung von API-Anforderungen in den Dienstebenen „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

Beispiel

<trace source="PetStore API" severity="verbose">
    <message>@((string)context.Variables["clientConnectionID"])</message>
    <metadata name="Operation Name" value="New-Order"/>
</trace>

Zugehöriger Inhalt

Weitere Informationen zum Arbeiten mit Richtlinien finden Sie hier: