Śledzenie

DOTYCZY: Wszystkie warstwy usługi API Management

Zasady trace dodaje niestandardowy ślad do danych wyjściowych śledzenia żądań w konsoli testowej, Szczegółowe informacje telemetriach aplikacji i/lub dziennikach zasobów.

  • Zasady dodaje niestandardowy ślad do danych wyjściowych śledzenia żądań w konsoli testowej po wyzwoleniu śledzenia , czyli Ocp-Apim-Trace nagłówek żądania jest obecny i ustawiony na trueOcp-Apim-Subscription-Key nagłówek żądania oraz zawiera prawidłowy klucz, który umożliwia śledzenie.
  • Zasady tworzą dane telemetryczne śledzenia w aplikacji Szczegółowe informacje, gdy jest włączona integracja aplikacji Szczegółowe informacje, 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 aplikacji Szczegółowe informacje. Wszystkie wywołania zasad zostaną zarejestrowane.

Ostrzeżenie

  • Zezwalaj na śledzenie tylko w przypadku subskrypcji przeznaczonych do celów debugowania. Udostępnianie kluczy subskrypcji z dozwolonym śledzeniem nieautoryzowanym użytkownikom może prowadzić do ujawnienia poufnych informacji zawartych w dziennikach śledzenia, takich jak klucze, tokeny dostępu, hasła, wewnętrzne nazwy hostów i adresy IP.
  • W konsoli testowej usługa API Management automatycznie wyłącza śledzenie 1 godzinę po włączeniu jej w ramach subskrypcji.

Uwaga

Obecnie śledzenie żądań interfejsu API nie jest obsługiwane w warstwach Podstawowa w wersji 2 i Standardowa w wersji 2.

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 Application Szczegółowe informacje Trace. 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>

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