Riferimento per metriche, dimensioni e filtri di analisi

Il numero medio di transazioni al secondo, ovvero le richieste proxy API. Tieni presente che se hai un numero relativamente basso di transazioni nel periodo di tempo, il numero medio di transazioni al secondo potrebbe sembrare zero nei report personalizzati dell'interfaccia utente se il numero è inferiore a due cifre decimali.

Sintassi dell'API: tps

Il numero di richieste API riuscite che utilizzano la cache delle risposte anziché la risposta del servizio di destinazione.

Sintassi dell'API: sum(cache_hit)

Restituisce il numero di elementi nella cache L1 (in memoria) per transazione in un determinato periodo di tempo. Ad esempio, se scegli max per il periodo di un giorno e, entro quel giorno, il numero più alto di elementi nella cache è 12 per una transazione specifica, il conteggio sarà 12. Per avg, se nel periodo di tempo su cui stai eseguendo la query sono presenti tre transazioni e il numero di cache è 5, 6 e 7, la media è 6. La cache L1 è memorizzata nella cache in memoria e non nella cache del database L2, come descritto in Elementi interni della cache.

Sintassi dell'API: avg(ax_cache_l1_count)

Il numero totale di errori relativi alle norme nel periodo di tempo specificato.

In genere gli errori dei criteri sono dovuti alla progettazione. Ad esempio, il criterio Verifica chiave API genera un errore quando nella richiesta viene trasmessa una chiave API non valida, mentre il criterio Spike Arrest genera un errore se il numero di chiamate API supera il limite definito nel criterio. Pertanto, questa metrica è utile per individuare potenziali punti problematici nelle API. Ad esempio, le metriche policy_error, raggruppate per dimensione developer_app, potrebbero aiutarti a scoprire che una chiave API o un token OAuth sono scaduti per una determinata app; oppure potresti scoprire che un proxy API specifico genera molti errori di Spike Arrest, portandoti a scoprire che il limite di picco di arresto del proxy non tiene conto di un aumento del traffico durante le festività.

Un errore dei criteri viene registrato in Analytics solo se genera un errore del proxy API. Ad esempio, se l'attributo continueOnError di un criterio viene impostato su true, il proxy API continua a elaborare una richiesta anche se il criterio non va a buon fine. In tal caso, un errore relativo alle norme non viene registrato in Analytics.

La dimensione Nome criterio in caso di errore (ax_execution_fault_policy_name) è utile per raggruppare gli errori dei criteri in base al nome.

Un errore di destinazione (ad esempio 404 o 503) non viene conteggiato come errore del criterio. Questi errori vengono conteggiati come errori del proxy API (is_error).

Sintassi dell'API: sum(policy_error)

Il numero totale di errori dei proxy API nel periodo di tempo specificato. L'errore del proxy può verificarsi quando un criterio ha esito negativo o quando si verifica un errore di runtime, ad esempio un errore 404 o 503 del servizio di destinazione.

La dimensione proxy (apiproxy) è utile per raggruppare gli errori del proxy API per proxy.

Sintassi dell'API: sum(is_error)

La quantità di tempo (media, minima o massima), in millisecondi, che impiega Edge per elaborare le richieste in entrata. Il tempo inizia quando la richiesta raggiunge Edge e termina quando Edge inoltra la richiesta al servizio di destinazione.

Utilizzando dimensioni diverse, puoi esaminare le latenze di elaborazione delle richieste in base al proxy API, all'app dello sviluppatore, alla regione e così via.

Sintassi dell'API: max(request_processing_latency)

Le dimensioni del payload della richiesta ricevuto da Edge, in byte.

Sintassi dell'API: avg(request_size)

Il numero totale di volte in cui un criterio della cache di risposta è stato eseguito nel periodo di tempo specificato.

Poiché il criterio della cache delle risposte è collegato in due posizioni in un proxy API (una volta nella richiesta e una volta nella risposta), di solito viene eseguito due volte in una chiamata API. I valori "get" della cache e "put" della cache contano ciascuno come un'esecuzione.

Tuttavia, l'esecuzione della cache delle risposte è 0 se l'elemento <SkipCacheLookup> nel criterio restituisce true (nella richiesta) e 0 se l'elemento <SkipCachePopulation> nel criterio restituisce true (nella risposta).

Nello strumento Traccia, puoi fare clic sull'icona Cache delle risposte in una chiamata API eseguita e visualizzare la variabile di flusso responsecache.executed per vedere se è stata eseguita o meno un'esecuzione della cache (valore pari a 1).

Sintassi dell'API: sum(ax_cache_executed)

La quantità di tempo (media, minima o massima), in millisecondi, che impiega Edge per elaborare le risposte dell'API. Il tempo inizia quando il proxy API riceve la risposta del servizio di destinazione e termina quando Apigee inoltra la risposta al chiamante originale.

Utilizzando dimensioni diverse, puoi esaminare le latenze di elaborazione delle risposte in base a proxy API, regione e così via.

Sintassi dell'API: min(response_processing_latency)

Le dimensioni del payload della risposta restituito al client, espresse in byte.

Sintassi dell'API: max(response_size)

Il numero totale di risposte 5xx del servizio di destinazione. Questi sono errori del servizio di destinazione non causati da Apigee.

Sintassi dell'API: sum(target_error)

La quantità di tempo (somma, media, minima o massima), in millisecondi, prima che il server di destinazione risponda a una chiamata. Questa metrica indica le prestazioni dei server di destinazione. Il tempo inizia quando Edge inoltra una richiesta al servizio di destinazione e termina quando Edge riceve la risposta.

Tieni presente che se una chiamata API restituisce una risposta dalla cache (ad esempio, utilizzando il criterio Cache delle risposte), non raggiungerà mai il servizio di destinazione e non vengono registrate metriche del tempo di risposta target.

Sintassi dell'API: avg(target_response_time)

La quantità di tempo (somma, media, minima o massima), in millisecondi, da quando Edge riceve una richiesta da un client a quando Edge invia la risposta al client. Il tempo include l'overhead di rete (ad esempio il tempo impiegato dai bilanciatori del carico e dai router per svolgere il proprio lavoro), la latenza di elaborazione delle richieste, la latenza di elaborazione delle risposte e il tempo di risposta target (se la risposta viene fornita dal servizio di destinazione anziché dalla cache).

Utilizzando dimensioni diverse, puoi esaminare le latenze di elaborazione per proxy API, app dello sviluppatore, regione e così via.

Sintassi dell'API: avg(total_response_time)

Il numero totale di chiamate API elaborate da Edge nel periodo di tempo specificato.

Utilizza le dimensioni per raggruppare i conteggi del traffico nei modi per te più significativi.

Sintassi dell'API: sum(message_count)

Il nome del prodotto API contenente i proxy API che vengono chiamati. Per ottenere questa dimensione, le app sviluppatore che effettuano le chiamate devono essere associate a uno o più prodotti API che contengono i proxy API, mentre i proxy chiamati devono verificare la presenza di una chiave API o di un token OAuth inviato con la chiamata API. La chiave o il token è associato a un prodotto API. Per maggiori informazioni, consulta Prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non vengono soddisfatti, viene visualizzato il valore "(not set)". Vedi anche Che cosa significa il valore "(not set)" dell'entità di analisi?.

La chiave contenente il valore Cache delle risposte a cui è stato eseguito l'accesso. Per saperne di più su come viene creata la chiave per la cache delle risposte, consulta Criterio cache delle risposte.

Nello strumento Traccia, quando selezioni un criterio della cache delle risposte che legge o scrive nella cache, puoi vedere questo valore nella variabile di flusso responsecache.cachekey.

Il nome della cache contenente le chiavi/valori utilizzati dal criterio Cache delle risposte, preceduto dal prefisso orgName__envName__. Ad esempio, se l'organizzazione è "foo", l'ambiente è "test" e il nome della cache è "myCache", ax_cache_name è foo__test__myCache.

Nello strumento Traccia, quando selezioni un criterio Cache delle risposte, puoi visualizzare questo valore nella variabile di flusso responsecache.cachename.

Il livello della cache ("L1" in memoria o database "L2") da cui è stata recuperata la cache delle risposte. Questa dimensione mostra anche "CACHE_MISS" quando la risposta è stata recapitata dalla destinazione anziché dalla cache (e la cache delle risposte è stata aggiornata con la risposta di destinazione) o quando una chiave cache nella richiesta non è valida. Le chiavi cache hanno una dimensione massima di 2 kB.

Nello strumento Traccia, quando selezioni il criterio Cache delle risposte, puoi visualizzare questo valore nella variabile di flusso responsecache.cachesource.

Per ulteriori informazioni sui livelli della cache, vedi Elementi interni della cache.

La chiave utente (chiave API) dell'app sviluppatore che effettua le chiamate API, se trasmesse nella richiesta come chiavi API o incluse nei token OAuth.

Per ottenere questa dimensione, i proxy che ricevono chiamate devono essere configurati in modo da verificare la presenza di una chiave API o di un token OAuth validi. Le app per sviluppatori ricevono chiavi API che possono essere utilizzate per generare token OAuth quando sono registrate in Edge. Per maggiori informazioni, consulta Prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non vengono soddisfatti, viene visualizzato il valore "(not set)". Vedi anche Che cosa significa il valore "(not set)" di un'entità di analisi?.

L'app per sviluppatori registrata a Edge che effettua chiamate API.

Per ottenere questa dimensione, le app devono essere associate a uno o più prodotti API che contengono i proxy API chiamati e i proxy devono verificare la presenza di una chiave API o di un token OAuth inviato con la chiamata API. La chiave o il token identifica l'app dello sviluppatore. Per ulteriori informazioni, consulta la sezione Per prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non vengono soddisfatti, viene visualizzato il valore "(not set)". Vedi anche Che cosa significa il valore "(not set)" di un'entità di analisi?.

L'email degli sviluppatori registrati a Edge la cui app ha effettuato le chiamate API.

Per ottenere questa dimensione, gli sviluppatori devono avere app associate a uno o più prodotti API che contengono i proxy API che vengono chiamati e i proxy devono verificare la presenza di una chiave API o un token OAuth inviato con la chiamata API. La chiave o il token identifica l'app dello sviluppatore. Per saperne di più, consulta Per prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non vengono soddisfatti, viene visualizzato il valore "(not set)". Vedi anche Che cosa significa il valore "(not set)" di un'entità di analisi?.

L'ID sviluppatore univoco generato da Edge nel formato org_name@@@unique_id.

Per ottenere questa dimensione, gli sviluppatori devono avere app associate a uno o più prodotti API contenenti i proxy API che vengono chiamati e i proxy devono verificare la presenza di una chiave API o di un token OAuth inviato con le chiamate API. La chiave o il token identifica lo sviluppatore. Per ulteriori informazioni, consulta Prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non vengono soddisfatti, viene visualizzato il valore "(not set)". Vedi anche Che cosa significa il valore "(not set)" di un'entità di analisi?.

Il codice di errore dell'errore. Ad esempio: messaging.adaptors.http.flow.GatewayTimeout

Il flusso denominato in un proxy API che ha generato un errore. Ad esempio, "PreFlow", "PostFlow" o il nome di un flusso condizionale che hai creato.

Tieni presente che il nome completo da utilizzare nell'API di gestione è ax_execution_fault_flow_name, senza interruzione di riga.

Se non si sono verificati errori, viene visualizzato il valore "(not set)".

Il nome dello stato del flusso proxy API che ha generato errori, ad esempio "PROXY_REQ_FLOW" o "TARGET_RESP_FLOW".

Tieni presente che il nome completo da utilizzare nell'API di gestione è ax_execution_fault_flow_state, senza interruzione di riga.

Il nome del criterio che ha generato un errore e ha causato l'esito negativo della chiamata API.

Tieni presente che il nome completo da utilizzare nell'API di gestione è ax_execution_fault_policy_name, senza interruzione di riga.

Se un criterio genera un errore, ma l'attributo principale del criterio continueOnError è impostato su true, il flusso del proxy dell'API continua senza errori e l'errore del criterio non viene conteggiato in questa dimensione.

Il BasePath configurato sul proxyAPI ProxyEndpoint. Il percorso di base non include la parte relativa al dominio e alla porta dell'URL del proxy API. Ad esempio, se l'URL di base di un proxy API è https://apigeedocs-test.apigee.net/releasenotes/, il percorso di base è /releasenotes.

Il valore è memorizzato anche nella variabile di flusso proxy.basepath.

Il percorso della risorsa aggiunto al percorso di base del proxy API. Ad esempio, se l'URL di base di un proxy API è https://apigeedocs-test.apigee.net/hello/ e viene effettuata una chiamata a https://apigeedocs-test.apigee.net/hello/json, il percorso è /json.

Se non viene utilizzato nessun pathuffix, il valore è vuoto.

Il valore è memorizzato anche nella variabile di flusso proxy.pathsuffix.

Contiene l'indirizzo IP del client di origine. Il valore della dimensione ax_resolved_client_ip viene calcolato dai valori nelle dimensioni ax_true_client_ip e x_forwarded_for_ip.

Tieni presente che quando utilizzi prodotti di routing come Akamai per acquisire i veri indirizzi IP dei client, l'IP client viene passato a Edge nell'intestazione HTTP True-Client-IP, che viene poi utilizzato per impostare la dimensione ax_true_client_ip.

Il valore della dimensione ax_resolved_client_ip viene calcolato come segue:

1. Se ax_true_client_ip non è null e non contiene un indirizzo IP locale, imposta ax_resolved_client_ip su ax_true_client_ip.
2. In caso contrario, imposta ax_resolved_client_ip sul primo indirizzo IP non locale in x_forwarded_for_ip.
3. Se ax_true_client_ip e x_forwarded_for_ip contengono solo indirizzi IP locali, imposta ax_resolved_client_ip sul primo indirizzo IP locale in x_forwarded_for_ip.
4. Se ax_true_client_ip e x_forwarded_for_ip sono nulli, imposta ax_resolved_client_ip su (not set).
5. Se ax_true_client_ip è un indirizzo IP locale e x_forwarded_for_ip è null, imposta ax_resolved_client_ip su (not set).

La versione del sistema operativo del dispositivo che effettua la chiamata.

È utile utilizzarla come seconda dimensione di "visualizzazione in dettaglio" con la famiglia di sistemi operativi (ax_ua_os_family) per visualizzare le versioni dei sistemi operativi.

L'indirizzo IP del client chiamante, archiviato nella variabile di flusso proxy.client.ip. Si tratta spesso dell'indirizzo X-Forwarded-For della chiamata in entrata, ovvero l'indirizzo IP ricevuto dall'edge ricevuto dall'ultimo handshake TCP esterno. Potrebbe essere il client chiamante o un bilanciatore del carico. Quando ci sono più IP nell'intestazione X-Forwarded-For, questo è l'ultimo IP elencato.

Quando utilizzi prodotti di routing come Akamai per acquisire i veri indirizzi IP dei client, gli IP client vengono passati a Edge nell'intestazione HTTP True-Client-IP. Questa dimensione acquisisce gli IP reali dei client da quell'intestazione.

Per determinare l'indirizzo IP del client originale, a cui si accede tramite la dimensione ax_resolved_client_ip, Edge utilizza le dimensioni ax_true_client_ip e x_forwarded_for_ip.

Il percorso della risorsa (escluso il dominio) al servizio di destinazione, esclusi i parametri di query.

Ad esempio, il target di esempio Apigee http://mocktarget.apigee.net include diverse risorse, tra cui /user, che restituisce un saluto. Indipendentemente da come il proxy API chiama http://mocktarget.apigee.net/user, il request_path è /user.

Il percorso della risorsa (escluso il dominio) al servizio di destinazione, inclusi i parametri di query.

Ad esempio, il target di esempio Apigee http://mocktarget.apigee.net include diverse risorse, tra cui la risorsa /user?user={name} e il parametro di query per restituire un saluto personalizzato al nome specificato. Indipendentemente da come il proxy API chiama http://mocktarget.apigee.net/user?user=Dude, request_uri è /user?user=Dude.

Il nome dello user agent o dell'agente software utilizzato per effettuare la chiamata API. Esempi:

• Pixel XL che effettua una chiamata mediante Chrome: Mozilla/5.0 (Linux; Android 7.1.2; Pixel XL Build/NHG47N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.92 Mobile Safari/537.36
• Un iPad che effettua una chiamata tramite Chrome: Mozilla/5.0 (iPad; CPU OS 10_2 like Mac OS X) AppleWebKit/602.1.50 (KHTML, like Gecko) CriOS/54.0.2840.91 Mobile/14C92 Safari/602.1
• cURL da un terminale: curl/7.51.0

La versione dello useragent.

È utile utilizzarlo come seconda dimensione di "visualizzazione dettagliata" con la famiglia di user agent (ax_ua_agent_family) per ottenere la versione della famiglia di agenti.

Il percorso della risorsa (escluso il dominio) al servizio di destinazione, esclusi i parametri di query, definito nell'elemento <TargetEndpoint> del proxy.

Ad esempio, supponiamo che un proxy API chiami il seguente target:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

In questo esempio, target_basepath è /user.

Se il target fosse questo:

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net</URL>
</HTTPTargetConnection>

target_basepath sarà nullo.

Nello strumento Traccia, quando selezioni l'icona AX alla fine del diagramma di flusso, la variabile di flusso target.basepath viene mappata alla dimensione target_basepath.

Il codice di stato della risposta HTTP restituito dal servizio di destinazione al proxy API, ad esempio 200, 404, 503 e così via.

Il valore "null" indica che la richiesta non ha mai raggiunto il servizio di destinazione. Questo si verifica quando la risposta viene gestita dal criterio della cache di risposta o quando si verifica un errore nell'elaborazione delle richieste.

È diverso dalla dimensione Codice di stato della risposta (response_status_code).

L'URL completo del servizio di destinazione definito in TargetEndpoint di un proxy API.

<TargetEndpoint name="default">
...
<HTTPTargetConnection>
  <URL>http://mocktarget.apigee.net/user?user=Dude</URL>
</HTTPTargetConnection>

In questo esempio, target_url è http://mocktarget.apigee.net/user?user=Dude.

Tieni presente che l'URL può anche essere sostituito durante l'elaborazione del proxy API con la variabile di flusso target.url.

Nel concatenamento del proxy e quando si utilizzano target degli script (Node.js), il valore target_url nel proxy chiamante è nullo.

L'elenco di indirizzi IP nell'intestazione X-Forwarded-For.

Per determinare l'indirizzo IP del client originale, a cui si accede tramite la dimensione ax_resolved_client_ip, Edge utilizza le dimensioni ax_true_client_ip e x_forwarded_for_ip.

In base al formato di 24 ore, l'ora a due cifre in cui sono state effettuate le chiamate API. Ad esempio, per le chiamate API effettuate nell'ora tra le 22 e le 23:00, ax_hour_of_day corrisponde a 22.

Il valore dell'ora è in UTC.