Traccia

SI APPLICA A: Tutti i livelli di Gestione API

Il criterio trace aggiunge una traccia personalizzata nell'output di traccia delle richieste nella console di test, nelle telemetrie di Application Insights e/o nei log delle risorse.

• Il criterio aggiunge una traccia personalizzata all'output della traccia delle richieste nella console di test quando viene attivata la traccia.
• Il criterio crea una telemetria della traccia in Application Insights quando l'integrazione di Application Insights è abilitata e il valore di severity specificato nel criterio è uguale o maggiore di quello di verbosity specificato nell'impostazione di diagnostica.
• Il criterio aggiunge una proprietà nella voce di log quando i log risorse sono abilitati e il livello di gravità specificato nel criterio è uguale o superiore al livello di dettaglio specificato nell'impostazione di diagnostica.
• Il criterio non è interessato dal campionamento di Application Insights. Tutte le chiamate del criterio verranno registrate.

Importante

• Sarà presto deprecata la traccia delle richieste di Gestione API con l'intestazione Ocp-Apim-Trace in una richiesta e con il valore dell'intestazione di risposta Ocp-Apim-Trace-Location.
• Per migliorare la sicurezza, la traccia può ora essere abilitata a livello di una singola API ottenendo un token a tempo limitato tramite l'API REST Gestione API e passando il token in una richiesta al gateway. Per informazioni dettagliate, vedere Abilitare la traccia di un'API.
• Prestare attenzione quando si abilita la traccia, in quanto può esporre informazioni riservate nei dati di traccia. Assicurarsi di avere misure di sicurezza appropriate per proteggere i dati di traccia.

Nota

La traccia delle richieste API non è attualmente supportata nei livelli Basic v2 e Standard v2.

Nota

Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione del criterio. Altre informazioni su come impostare o modificare i criteri di API Management.

Istruzione del criterio

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

Attributi

Attributo	Descrizione	Richiesto	Valore predefinito
source	Valore letterale della stringa significativo per il visualizzatore di tracce e che specifica l'origine del messaggio. Le espressioni di criteri non sono consentite.	Sì	N/D
severity	Specifica il livello di gravità dell'analisi. I valori consentiti sono: verbose, information, error (dal minimo al massimo). Le espressioni di criteri non sono consentite.	No	verbose

Elementi

Nome	Descrizione	Richiesto
messaggio	Stringa o espressione da registrare. Le espressioni di criteri sono consentite.	Sì
metadata	Aggiunge una proprietà personalizzata ai dati di telemetria di Traccia di Application Insights.	No

attributi di metadati

Attributo	Descrizione	Richiesto	Valore predefinito
name	Nome della proprietà.	Sì	N/D
value	Valore della proprietà.	Sì	N/D

Utilizzo

• Sezioni del criterio: inbound, outbound, back-end
• Ambiti del criterio: globale, area di lavoro, prodotto, API, operazione
• Gateway: classico, v2, consumo, self-hosted

Esempio

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

Criteri correlati

• Registrazione

Contenuto correlato

Per ulteriori informazioni sull'utilizzo dei criteri, vedere:

• Esercitazione: trasformare e proteggere l'API
• Informazioni di riferimento sui criteri per un elenco completo delle istruzioni dei criteri e delle relative impostazioni
• Espressioni di criteri
• Impostare o modificare criteri
• Riutilizzare le configurazioni dei criteri
• Repository dei frammenti di criteri
• Creare criteri con Microsoft Copilot per Azure