Riferimento per metriche, dimensioni e filtri di analisi

Il numero medio di transazioni, ovvero richieste proxy API, al secondo. Tieni presente che se hai una soglia relativamente bassa numero di transazioni nel periodo di tempo, il numero medio di transazioni secondi potrebbe sembrare pari a zero nei report personalizzati dell'interfaccia utente se il numero è inferiore a due posizioni decimali.

Sintassi dell'API: tps

Il numero di richieste API riuscite che utilizzano la cache delle risposte al posto della la risposta desiderata dal servizio di destinazione.

Sintassi dell'API: sum(cache_hit)

Restituisce il numero di elementi nella cache L1 (in memoria) per transazione su una determinata periodo di tempo. Ad esempio, se scegli max per il periodo di un giorno e entro quel giorno il numero massimo di elementi nella cache è 12 per una transazione specifica. il conteggio sarà 12. Per avg, se ci sono tre transazioni nel periodo di tempo su cui esegui la query, con un numero di cache pari a 5, 6 e 7, la media è 6. L1 La cache è in memoria e non L2, come descritto in Cache interna.

Sintassi dell'API: avg(ax_cache_l1_count)

Il numero totale di errori dei criteri nel periodo di tempo specificato.

In genere gli errori dei criteri si verificano in base alla progettazione. Ad esempio, il criterio Verify API Key genera un errore quando nella richiesta viene passata una chiave API non valida e un criterio di arresto dei picchi genera un errore se il numero di chiamate API supera il limite definito nel criterio. Quindi... questa metrica è utile per individuare potenziali aree problematiche nelle API. Ad esempio: Le metriche policy_error, raggruppate in base alla dimensione developer_app, potrebbero aiutarti a scoprire Una chiave API o un token OAuth sono scaduti per una determinata app. o potresti scoprire che un proxy API specifico sta generando molti errori Spike Arrest, che ti portano a scoprire che il limite di arresto dei picchi del proxy non tiene conto di un aumento del traffico generato dalle festività.

In Analytics viene registrato un errore relativo ai criteri solo se l'errore provoca un errore del proxy API. Ad esempio, se l'attributo continueOnError di un criterio è impostato su true, il proxy API continua a elaborare una richiesta anche se il criterio non funziona. In questo caso, in Analytics non viene registrato un errore di criterio.

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

Un errore della destinazione (ad esempio 404 o 503) non viene conteggiato come un errore del criterio. Quelli 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. Proxy l'errore può verificarsi in caso di errore di un criterio o di runtime, ad esempio un errore 404 o 503 dal 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, richiede a Edge di elaborare le richieste in entrata. L'ora 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, app sviluppatore, regione e così via.

Sintassi dell'API: max(request_processing_latency)

La dimensione del payload della richiesta ricevuto da Edge, espressa in byte.

Sintassi dell'API: avg(request_size)

Il numero totale di volte in cui un criterio Response Cache è stato eseguito nel periodo specificato punto.

Poiché il criterio Response Cache è collegato in due posizioni in un proxy API (una volta e una nella risposta), di solito viene eseguita due volte in una chiamata API. Una cache "get" e "put" della cache ciascuna viene conteggiata come un'esecuzione.

Tuttavia, l'esecuzione della cache di risposta è pari a 0 se <SkipCacheLookup> del criterio viene restituito come true (nella richiesta) e 0 se <SkipCachePopulation> del criterio restituisce true (nella risposta).

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

Sintassi dell'API: sum(ax_cache_executed)

La quantità di tempo (media, minima o massima), in millisecondi, richiede a Edge di elaborare le risposte dell'API. L'ora inizia quando il proxy API riceve la risposta del servizio di destinazione e termina quando Apigee inoltra la risposta all'originale chiamante.

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

Sintassi dell'API: min(response_processing_latency)

La dimensione del payload di risposta restituito al client, byte.

Sintassi dell'API: max(response_size)

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

Sintassi dell'API: sum(target_error)

La quantità di tempo (somma, media, minima o massima) in millisecondi, affinché il server di destinazione risponda a una chiamata. Questa metrica indica le prestazioni dei server di destinazione. L'ora 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 (utilizzando il valore ad esempio), la chiamata non raggiungerà mai il servizio di destinazione e nessun target vengono registrate le metriche del tempo di risposta.

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 restituisce la risposta al client. Il tempo include l'overhead di rete (ad esempio il tempo impiegato da bilanciatori del carico e router per svolgere il loro lavoro), le richieste di elaborazione latenza, latenza di elaborazione della risposta e tempo di risposta target (se la risposta viene pubblicata) dal servizio di destinazione anziché dalla cache).

Utilizzando dimensioni diverse, puoi esaminare le latenze di elaborazione per proxy API, app 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 nel modo più significativo per te.

Sintassi dell'API: sum(message_count)

Il nome del prodotto API contenente i proxy API chiamati. Per ottenere questa dimensione, le app degli sviluppatori che effettuano le chiamate devono essere associate a una o più API prodotti contenenti proxy API, che i proxy chiamati devono verificare chiave o token OAuth inviato con la chiamata API. La chiave o il token è associato a un'API prodotto. Per ulteriori informazioni, vedi Per prima cosa: come generare dati di analisi completi.

Se i criteri sopra indicati non sono soddisfatti, verrà visualizzato il valore "(not set)". Vedi anche Che cos'è il valore dell'entità di analisi "(not set)" significa?.

La chiave contenente il valore Cache delle risposte a cui è stato eseguito l'accesso. Per ulteriori informazioni Come è strutturata la chiave per la cache delle risposte, consulta la sezione Criterio della cache di risposta.

Nello strumento Trace, Quando selezioni un criterio Cache risposte che ha letto o scritto nella cache, può vedere questo valore nella variabile di flusso responsecache.cachekey.

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

Nello strumento Trace, quando selezioni un criterio Cache delle risposte, puoi vedere questo valore nel responsecache.cachename variabile di flusso.

Il livello della cache ("database L1" in memoria o "L2") da cui la cache delle risposte era recuperato. Questa dimensione mostra anche "CACHE_MISS" quando la risposta è stata inviata la destinazione anziché la cache (e la cache delle risposte è stata aggiornata con la risposta della destinazione); o quando una chiave cache nella richiesta non è valida. Le chiavi cache sono limitate a Deve avere una dimensione di 2 kB.

Nello strumento Trace, quando selezioni il criterio Cache risposte, puoi vedere questo valore nel responsecache.cachesource variabile di flusso.

Per ulteriori informazioni sui livelli della cache, consulta Interna della cache.

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

Per ottenere questa dimensione, i proxy che ricevono chiamate devono essere configurati per verificare per una chiave API o un token OAuth validi. Le app sviluppatore ricevono chiavi API, che possono essere utilizzate per Generare token OAuth quando le app sono registrate in Edge. Per ulteriori informazioni, vedi Per prima cosa: come generare dati di analisi completi.

Se i criteri precedenti non sono soddisfatti, verrà visualizzato il valore "(not set)". Consulta anche Che cosa rende il valore dell'entità di analisi "(not set)" significa?.

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

Per ottenere questa dimensione, le app devono essere associate a uno o più prodotti API contenenti i proxy API chiamati, che devono verificare la presenza di una chiave API o Token OAuth inviato con la chiamata API. La chiave o il token identifica l'app sviluppatore. Per Per saperne di più, consulta la sezione Innanzitutto: come generare dati di analisi completi.

Se i criteri precedenti non sono soddisfatti, verrà visualizzato il valore "(not set)". Consulta anche Che cosa rende il valore dell'entità di analisi "(not set)" significa?.

L'email degli sviluppatori registrati su 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 chiamati, che devono verificare la presenza di una Chiave API o token OAuth inviato con la chiamata API. La chiave o il token identifica lo sviluppatore dell'app. Per ulteriori informazioni, consulta la sezione Operazioni preliminari: come generare dati di analisi completi.

Se i criteri precedenti non sono soddisfatti, verrà visualizzato il valore "(not set)". Consulta anche Che cosa rende il valore dell'entità di analisi "(not set)" significa?.

L'ID sviluppatore univoco generato da Edge sotto forma di org_name@@@unique_id.

Per ottenere questa dimensione, gli sviluppatori devono avere app associate a uno o più Prodotti API contenenti i proxy API chiamati, che devono verificare la presenza di Chiave API o token OAuth inviato con le chiamate API. La chiave o il token identifica sviluppatore. Per ulteriori informazioni, consulta la sezione Operazioni preliminari: come generare dati di analisi completi.

Se i criteri sopra indicati non sono soddisfatti, verrà visualizzato il valore "(not set)". Consulta anche Che cosa rende il valore dell'entità di analisi "(not set)" significa?.

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

Il flow 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 usare 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 del flusso proxy API indica che hanno generato errori, ad esempio "PROXY_REQ_FLOW" o "TARGET_RESP_FLOW."

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

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

Tieni presente che il nome completo da usare 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 API continua senza errori e il criterio l'errore non viene conteggiato in questa dimensione.

Il BasePath configurato sul proxyEndpoint del proxy API. Il percorso di base non include il dominio e la 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 viene memorizzato anche nella variabile di flusso proxy.basepath.

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

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

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

Contiene l'indirizzo IP del client di origine. Il valore dell'attributo ax_resolved_client_ip viene calcolata a partire dai valori in ax_true_client_ip e x_forwarded_for_ip dimensioni.

Tieni presente che quando utilizzi prodotti per il routing come Akamai per acquisire i veri indirizzi IP dei client, l'IP del client viene passato a Edge nell'intestazione HTTP True-Client-IP, che 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 è nullo e non contiene un indirizzo IP locale, quindi 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 sia ax_true_client_ip che x_forwarded_for_ip contengono indirizzi IP locali, quindi imposta ax_resolved_client_ip sul primo indirizzo IP locale in x_forwarded_for_ip.
4. Se sia ax_true_client_ip sia x_forwarded_for_ip sono null, imposta ax_resolved_client_ip su (not set).
5. Se ax_true_client_ip è un indirizzo IP locale e x_forwarded_for_ip è nullo, imposta ax_resolved_client_ip su (not set).

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

È utile utilizzarlo come seconda visualizzazione in dettaglio dimensione con Famiglia sistema operativo (ax_ua_os_family) per visualizzare le versioni dei sistemi operativi.

L'indirizzo IP del client chiamante, archiviato in proxy.client.ip variabile di flusso. Spesso si tratta dell'indirizzo X-Forwarded-For della chiamata in entrata, ovvero l'indirizzo IP che Edge ha ricevuto dall'ultimo handshake TCP esterno. Questo potrebbe come client chiamante o un bilanciatore del carico. Quando ci sono più IP nella 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 dei client vengono passati a Edge nell'intestazione HTTP True-Client-IP. Questo acquisisce gli IP del client veri da quell'intestazione.

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

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

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 valore di request_path è /user.

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

Ad esempio, il target di esempio Apigee http://mocktarget.apigee.net include varie risorse, tra cui /user?user={name} risorsa e query per restituire un saluto personalizzato al nome fornito. Indipendentemente dal modo in cui le API chiama http://mocktarget.apigee.net/user?user=Dude, il valore request_uri è /user?user=Dude.

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

• Un Pixel XL che effettua una chiamata tramite 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 user agent.

È utile utilizzarlo come seconda visualizzazione in dettaglio dimensione con Famiglia 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, esclusa la query definito nel parametro <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, il valore target_basepath è /user.

Se il target fosse questo:

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

target_basepath è nullo.

Nello strumento Tracce, quando seleziona l'icona AX alla fine del diagramma di flusso, target.basepath La variabile di flusso viene mappata la 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. Ciò si verifica quando la risposta viene fornita dal criterio Response Cache o si verifica un errore nella richiesta e l'elaborazione dei dati.

È diverso dal codice di stato della risposta (response_status_code).

L'URL completo del servizio di destinazione definito nel 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 è possibile eseguire l'override dell'URL anche durante l'elaborazione proxy API con target.url variabile di flusso.

In proxy concatenamento e quando si utilizza lo script target (Node.js), il valore target_url nel proxy di chiamata è nullo.

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

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

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

Il valore dell'ora è nel fuso orario UTC.