Trasování

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Tato trace zásada přidá vlastní trasování do výstupu trasování požadavků v testovací konzole, telemetrických datech Application Insights a/nebo protokolech prostředků.

  • Zásada při aktivaci trasování přidá do výstupu trasování požadavků v testovací konzole vlastní trasování.
  • Zásada vytvoří telemetrii trasování ve službě Application Insights, když je povolená integrace Application Insights a severity zadaná v zásadách je rovna nebo větší než verbosity zadaná v nastavení diagnostiky.
  • Zásada přidá do položky protokolu vlastnost, pokud jsou povoleny protokoly prostředků a úroveň závažnosti zadaná v zásadách je vyšší nebo vyšší než úroveň podrobností zadaná v nastavení diagnostiky.
  • Na zásadu nemá vliv vzorkování Application Insights. Zaprotokolují se všechna vyvolání zásad.

Důležité

  • Api Management už nepodporuje předplatná pro trasování nebo hlavičku Ocp-Apim-Trace .
  • Pokud chcete zlepšit zabezpečení rozhraní API, můžete teď trasování povolit na úrovni jednotlivých rozhraní API získáním časově omezeného tokenu pomocí rozhraní REST API služby API Management a předáním tokenu v požadavku na bránu. Podrobnosti najdete v tématu Povolení trasování rozhraní API.
  • Při povolování trasování je potřeba dbát na to, jak může v datech trasování vystavit citlivé informace. Ujistěte se, že máte k ochraně dat trasování zavedená vhodná bezpečnostní opatření.

Poznámka:

Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách. Přečtěte si další informace o tom, jak nastavit nebo upravit zásady služby API Management.

Prohlášení o zásadách

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

Atributy

Atribut Popis Požaduje se Výchozí
zdroj Řetězcový literál smysluplný pro prohlížeč trasování a určení zdroje zprávy. Výrazy zásad nejsou povolené. Yes –
závažnost Určuje úroveň závažnosti trasování. Povolené hodnoty jsou verbose, informationerror (od nejnižšího po nejvyšší). Výrazy zásad nejsou povolené. No verbose

Elementy

Název Popis Povinní účastníci
zpráva Řetězec nebo výraz, který se má protokolovat. Výrazy zásad jsou povolené. Ano
metadata Přidá vlastní vlastnost do telemetrie trasování Application Insights. No

atributy metadat

Atribut Popis Požaduje se Výchozí
name Název vlastnosti. Yes –
hodnota Hodnota vlastnosti Yes –

Využití

  • Oddíly zásad: příchozí, odchozí, back-end
  • Obory zásad: globální, pracovní prostor, produkt, rozhraní API, operace
  • Brány: Classic, v2, consumption, self-host, workspace

Příklad

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

Související obsah

Další informace o práci se zásadami najdete v tématech: