Generare metriche personalizzate
SI APPLICA A: Tutti i livelli di Gestione API
Il criterio emit-metric
invia metriche personalizzate nel formato specificato ad Application Insights.
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.
Limiti per le metriche personalizzate
Monitoraggio di Azure impone limiti di utilizzo per le metriche personalizzate che possono influire sulla capacità di emettere metriche da Gestione API. Ad esempio, Monitoraggio di Azure imposta attualmente un limite di 10 chiavi di dimensione per metrica e un limite di 50.000 serie temporali attive totali per area in una sottoscrizione (in un periodo di 12 ore).
Questi limiti hanno le implicazioni seguenti per la configurazione di metriche personalizzate in un criterio di Gestione API, emit-metric
ad esempio o azure-openai-emit-token-metric
:
È possibile configurare un massimo di 10 dimensioni personalizzate per criterio .
Il numero di serie temporali attive generate dal criterio entro un periodo di 12 ore è il prodotto del numero di valori univoci di ogni dimensione configurata durante quel periodo. Ad esempio, se nel criterio sono state configurate tre dimensioni personalizzate e ogni dimensione ha 10 valori possibili all'interno del periodo, il criterio contribuirà con 1.000 (10 x 10 x 10) serie temporali attive.
Se si configura il criterio in più istanze di Gestione API che si trovano nella stessa area di una sottoscrizione, tutte le istanze possono contribuire al limite di serie temporali attive a livello di area.
Altre informazioni sulle limitazioni e sulle considerazioni sulla progettazione per le metriche personalizzate in Monitoraggio di Azure.
Prerequisiti
- L'istanza di Gestione API deve essere integrata con Application Insights. Per altre informazioni, vedere Come integrare Gestione API di Azure con Azure Application Insights.
- Abilitare la registrazione di Application Insights per le API.
- Abilitare metriche personalizzate con dimensioni in Application Insights. Per altre informazioni, vedere Creare metriche personalizzate.
Istruzione del criterio
<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace">
<dimension name="dimension name" value="dimension value" />
</emit-metric>
Attributi
Attributo | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
name | Stringa . Nome della metrica personalizzata. Le espressioni di criteri non sono consentite. | Sì | N/D |
namespace | Stringa . Spazio dei nomi della metrica personalizzata. Le espressioni di criteri non sono consentite. | No | Gestione API |
value | Valore della metrica personalizzata espressa come double. Le espressioni di criteri sono consentite. | No | 1 |
Elementi
Elemento | Descrizione | Richiesto |
---|---|---|
dimension | Aggiungere uno o più di questi elementi per ogni dimensione inclusa nella metrica personalizzata. | Sì |
attributi dimensione
Attributo | Descrizione | Richiesto | Valore predefinito |
---|---|---|---|
name | Una stringa o espressione di criteri. Nome della dimensione. | Sì | N/D |
value | Una stringa o espressione di criteri. Valore della dimensione. Può essere omesso solo se name corrisponde a una delle dimensioni predefinite. In tal caso, il valore viene fornito in base al nome della dimensione. |
No | N/D |
Nomi di dimensione predefiniti che possono essere usati senza valore
- ID API
- ID operazione
- ID prodotto
- ID utente
- ID sottoscrizione
- Ufficio
- ID gateway
Utilizzo
- Sezioni del criterio: inbound, outbound, backend, on-error
- Ambiti del criterio: globale, area di lavoro, prodotto, API, operazione
- Gateway: classico, v2, consumo, self-hosted, area di lavoro
Note sull'utilizzo
- È possibile configurare al massimo 10 dimensioni personalizzate per questo criterio.
Esempio
L'esempio seguente invia una metrica personalizzata per contare il numero di richieste API insieme all'ID API come dimensione personalizzata.
<policies>
<inbound>
<emit-metric name="Request" value="1" namespace="my-metrics">
<dimension name="API ID" />
</emit-metric>
</inbound>
<outbound>
</outbound>
</policies>
Criteri correlati
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 usando Microsoft Copilot in Azure