Śledzenie

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady trace dodaje niestandardowy ślad do danych wyjściowych śledzenia żądań w konsoli testowej, telemetriach usługi Application Insights i/lub dziennikach zasobów.

• Zasady dodaje niestandardowy ślad do danych wyjściowych śledzenia żądań w konsoli testowej po wyzwoleniu śledzenia .
• Zasady tworzą dane telemetryczne śledzenia w usłudze Application Insights, gdy jest włączona integracja usługi Application Insights, a severity określona w zasadach jest równa lub większa niż verbosity określona w ustawieniu diagnostycznym.
• Zasady dodaje właściwość we wpisie dziennika, gdy dzienniki zasobów są włączone, a poziom ważności określony w zasadach jest na poziomie lub wyższym niż poziom szczegółowości określony w ustawieniu diagnostycznym.
• Zasady nie mają wpływu na próbkowanie usługi Application Insights. Wszystkie wywołania zasad zostaną zarejestrowane.

Ważne

• Śledzenie żądań usługi API Management przy użyciu nagłówka Ocp-Apim-Trace w żądaniu i użycie wartości nagłówka odpowiedzi Ocp-Apim-Trace-Location jest przestarzałe.
• Aby zwiększyć bezpieczeństwo, śledzenie można teraz włączyć na poziomie pojedynczego interfejsu API przez uzyskanie tokenu ograniczonego czasowo przy użyciu interfejsu API REST usługi API Management i przekazanie tokenu w żądaniu do bramy. Aby uzyskać szczegółowe informacje, zobacz Włączanie śledzenia interfejsu API.
• Należy zachować ostrożność podczas włączania śledzenia, ponieważ może uwidaczniać poufne informacje w danych śledzenia. Upewnij się, że masz odpowiednie środki bezpieczeństwa, aby chronić dane śledzenia.

Uwaga

Ustaw elementy zasad i elementy podrzędne w kolejności podanej w instrukcji zasad. Dowiedz się więcej na temat ustawiania lub edytowania zasad usługi API Management.

Instrukcja zasad

<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>

Atrybuty

Atrybut	opis	Wymagani	Wartość domyślna
source	Literał ciągu zrozumiały dla przeglądarki śledzenia i określając źródło komunikatu. Wyrażenia zasad nie są dozwolone.	Tak	Nie dotyczy
ważność	Określa poziom ważności śledzenia. Dozwolone wartości to verbose, informationerror (od najniższego do najwyższego). Wyrażenia zasad nie są dozwolone.	Nie.	verbose

Elementy

Nazwa/nazwisko	opis	Wymagania
wiadomość	Ciąg lub wyrażenie do zarejestrowania. Wyrażenia zasad są dozwolone.	Tak
metadane	Dodaje właściwość niestandardową do telemetrii śledzenia usługi Application Insights.	Nie.

atrybuty metadanych

Atrybut	opis	Wymagani	Wartość domyślna
name	Nazwa właściwości.	Tak	Nie dotyczy
wartość	Wartość właściwości.	Tak	Nie dotyczy

Użycie

• Sekcje zasad: ruch przychodzący, wychodzący, zaplecze
• Zakresy zasad: globalny, obszar roboczy, produkt, interfejs API, operacja
• Bramy: klasyczne, v2, zużycie, self-hosted

Przykład

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

Powiązane zasady

• Rejestrowanie

Powiązana zawartość

Aby uzyskać więcej informacji na temat pracy z zasadami, zobacz:

• Samouczek: przekształcanie i ochrona interfejsu API
• Dokumentacja zasad dla pełnej listy instrukcji zasad i ich ustawień
• Wyrażenia zasad
• Ustawianie lub edytowanie zasad
• Ponowne używanie konfiguracji zasad
• Repozytorium fragmentów zasad
• Tworzenie zasad przy użyciu rozwiązania Microsoft Copilot na platformie Azure