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.

Note

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). In Gestione API, 5 di questi vengono usati per le dimensioni predefinite, tra cui:

  • Region
  • ID del servizio
  • Nome servizio
  • Tipo di servizio

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

Prerequisites

Dichiarazione della politica

<emit-metric name="name of custom metric" value="value of custom metric" namespace="metric namespace"> 
    <dimension name="dimension name" value="dimension value" /> 
</emit-metric>

Attributes

Attribute Description Required Valore predefinito
name Una stringa. Nome della metrica personalizzata. Le espressioni di criteri non sono consentite. Yes N/A
namespace Una stringa. Spazio dei nomi della metrica personalizzata. Le espressioni di criteri non sono consentite. No API Management
value Valore della metrica personalizzata espressa come double. Le espressioni di criteri sono consentite. No 1

Elements

Element Description Required
dimension Aggiungere uno o più di questi elementi per ogni dimensione inclusa nella metrica personalizzata. Yes

Attributi dimensione

Attribute Description Required Valore predefinito
name Una stringa o espressione di criteri. Nome della dimensione. Yes N/A
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/A

Nomi di dimensione predefiniti che possono essere usati senza valore

  • API ID
  • ID operazione
  • ID prodotto
  • ID utente
  • ID sottoscrizione
  • Location
  • ID del Gateway
  • ID back-end (usare solo nella sezione criteri in uscita)

Usage

Note sull'utilizzo

  • È possibile configurare al massimo 5 dimensioni personalizzate per questo criterio.

Example

L'esempio seguente invia una metrica personalizzata per contare il numero di richieste API insieme all'ID API come dimensione predefinita.

<policies>
  <inbound>
    <emit-metric name="Request" value="1" namespace="my-metrics"> 
        <dimension name="API ID" /> 
    </emit-metric> 
  </inbound>
  <outbound>
  </outbound>
</policies>

Contenuti correlati

Per ulteriori informazioni sull'utilizzo dei criteri, vedere:

  • Last updated on