Riferimento per metriche, dimensioni e filtri di analisi

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

Sintassi API: tps

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

Sintassi 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 in quel giorno il numero più alto di elementi nella cache è 12 per una transazione specifica, il conteggio sarà 12. Per avg, se ci sono tre transazioni nel periodo di tempo per cui stai eseguendo la query e i loro conteggi della cache sono 5, 6 e 7, la media è 6. La cache L1 è una cache in memoria, a differenza della cache del database L2, come descritto in Interni della cache.

Sintassi API: avg(ax_cache_l1_count)

Il numero totale di errori delle norme nel periodo di tempo specificato.

Gli errori relativi alle norme in genere si verificano intenzionalmente. Ad esempio, il criterio Verifica chiave API genera un errore quando nella richiesta viene passata una chiave API non valida, mentre un criterio Spike Arrest genera un errore se il numero di chiamate API supera il limite definito nel criterio. Pertanto, questa metrica è utile per trovare potenziali punti critici nelle tue API. Ad esempio, le metriche policy_error, raggruppate in base alla dimensione developer_app, potrebbero aiutarti a scoprire che una chiave API o un token OAuth è scaduto per una determinata app oppure potresti scoprire che un proxy API specifico genera molti errori Spike Arrest, il che ti porta a scoprire che il limite di Spike Arrest del proxy non tiene conto di un aumento del traffico durante le festività.

Un errore di policy viene registrato in Analytics solo se l'errore comporta l'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 viene rispettato. In questo caso, in Analytics non viene registrato un errore relativo alle norme.

La dimensione Nome norma in caso di errore (ax_execution_fault_policy_name) è utile per raggruppare gli errori delle norme in base al nome della norma.

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

Sintassi API: sum(policy_error)

Il numero totale di volte in cui i proxy API non sono riusciti nel periodo di tempo specificato. L'errore del proxy può verificarsi quando una policy non va a buon fine o quando si verifica un errore 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 API: sum(is_error)

La quantità di tempo (media, minima o massima), in millisecondi, necessario a Edge per elaborare le richieste in entrata. Il conteggio del 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 per proxy API, app per sviluppatori, regione e così via.

Sintassi API: max(request_processing_latency)

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

Sintassi API: avg(request_size)

Il numero totale di volte in cui una policy di Response Cache è stata eseguita nel periodo di tempo specificato.

Poiché la policy Response Cache è collegata in due punti di un proxy API (una volta nella richiesta e una volta nella risposta), in genere viene eseguita due volte in una chiamata API. Un'operazione "get" e un'operazione "put" della cache vengono conteggiate come un'esecuzione ciascuna.

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

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

Sintassi API: sum(ax_cache_executed)

La quantità di tempo (media, minima o massima), in millisecondi, necessaria a Edge per elaborare le risposte API. Il conteggio del 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 per proxy API, regione e così via.

Sintassi API: min(response_processing_latency)

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

Sintassi API: max(response_size)

Il numero totale di risposte 5xx dal servizio di destinazione. Si tratta di errori del servizio di destinazione non causati da Apigee.

Sintassi API: sum(target_error)

La quantità di tempo (somma, media, minimo o massimo), in millisecondi, impiegato dal server di destinazione per rispondere a una chiamata. Questa metrica indica il rendimento dei server di destinazione. Il conteggio del 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 la policy Cache delle risposte), la chiamata non raggiungerà mai il servizio di destinazione e non verranno registrate metriche sul tempo di risposta della destinazione.

Sintassi API: avg(target_response_time)

La quantità di tempo (somma, media, minimo o massimo), in millisecondi, dal momento in cui Edge riceve una richiesta da un client a quello in cui Edge invia la risposta al client. Il tempo include l'overhead di rete (ad esempio, il tempo necessario ai bilanciatori del carico e ai router per svolgere il proprio lavoro), la latenza di elaborazione delle richieste, la latenza di elaborazione delle risposte e il tempo di risposta del 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 per sviluppatori, regione e così via.

Sintassi 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 più significativi per te.

Sintassi API: sum(message_count)

Il nome del prodotto API contenente i proxy API chiamati. Per ottenere questa dimensione, le app per sviluppatori che effettuano le chiamate devono essere associate a uno o più prodotti API che contengono i proxy API e 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 saperne di più, consulta Prima di tutto: come generare dati di analisi completi.

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

La chiave contenente il valore della cache delle risposte a cui è stato eseguito l'accesso. Per ulteriori informazioni su come viene creata la chiave per la cache delle risposte, consulta le norme sulla cache delle risposte.

Nello strumento di tracciamento, quando selezioni una policy di cache delle risposte che legge o scrive nella cache, puoi visualizzare questo valore nella variabile di flusso responsecache.cachekey.

Il nome della cache contenente le chiavi/i valori utilizzati dal criterio Response Cache, con il 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 di tracciamento, quando selezioni una policy della cache delle risposte, puoi visualizzare questo valore nella responsecache.cachename variabile di flusso.

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

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

Per saperne di più sui livelli di cache, consulta Elementi interni della cache.

La chiave utente (chiave API) dell'app per sviluppatori che effettua le chiamate API, passata nella richiesta come chiavi API o inclusa nei token OAuth.

Per ottenere questa dimensione, i proxy che ricevono chiamate devono essere configurati per 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 le app vengono registrate in Edge. Per saperne di più, consulta Prima di tutto: come generare dati di analisi completi.

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

L'app per sviluppatori registrata su 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 sviluppatore. Per maggiori informazioni, vedi Prima di tutto: come generare dati di analisi completi.

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

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 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 Prima di tutto: come generare dati di analisi completi.

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

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 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 saperne di più, consulta Prima di tutto: come generare dati di analisi completi.

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

Il codice di 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 Management è ax_execution_fault_flow_name, senza interruzione di riga.

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

Il nome degli stati del flusso del proxy API che hanno generato errori, ad esempio "PROXY_REQ_FLOW" o "TARGET_RESP_FLOW".

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

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

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

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

BasePath configurato in ProxyEndpoint del proxy API. Il percorso di base non include la parte di dominio e 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 proxy.basepath variabile di flusso.

Il percorso della risorsa aggiunto al percorso di base del proxy API. Ad esempio, se l'URL 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 suffisso del percorso è /json.

Se non viene utilizzato alcun suffisso del percorso, il valore è vuoto.

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

Contiene l'indirizzo IP del client di origine. Il valore della dimensione ax_resolved_client_ip viene calcolato dai valori delle 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 trasmesso a Edge nell'intestazione HTTP True-Client-IP, che viene poi utilizzata 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 sia ax_true_client_ip sia 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 sia ax_true_client_ip che 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 analisi in dettaglio con Famiglia di sistemi operativi (ax_ua_os_family) per visualizzare le versioni dei sistemi operativi.

L'indirizzo IP del client chiamante, memorizzato nella variabile di flusso proxy.client.ip. Spesso si tratta dell'indirizzo X-Forwarded-For della chiamata in entrata, ovvero l'indirizzo IP ricevuto da Edge dall'ultimo handshake TCP esterno. Potrebbe trattarsi del client chiamante o di un bilanciatore del carico. Quando nell'intestazione X-Forwarded-For sono presenti più indirizzi IP, 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 indirizzi IP client reali dall'intestazione.

Per determinare l'indirizzo IP 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 (senza includere il dominio) al servizio di destinazione, esclusi i parametri di query.

Ad esempio, la destinazione di esempio Apigee http://mocktarget.apigee.net include diverse risorse, tra cui /user, che restituisce un saluto. Indipendentemente dal modo in cui il proxy API chiama http://mocktarget.apigee.net/user, il percorso della richiesta è /user.

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

Ad esempio, la destinazione 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 fornito. Indipendentemente dal modo in cui il proxy API chiama http://mocktarget.apigee.net/user?user=Dude, l'URI richiesta è /user?user=Dude.

Il nome dello user agent o del software agent 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 dell'user agent.

È utile utilizzarla come seconda dimensione di "drill-down" con Famiglia user agent (ax_ua_agent_family) per ottenere la versione della famiglia di agenti.

Il percorso della risorsa (senza includere il dominio) al servizio di destinazione, esclusi i parametri di query, definito in <TargetEndpoint> del proxy.

Ad esempio, supponiamo che un proxy API chiami la seguente destinazione:

<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à null.

Nello strumento di tracciamento, quando selezioni l'icona AX alla fine del diagramma di flusso, la target.basepath variabile di flusso 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.

Un valore "null" indica che la richiesta non ha mai raggiunto il servizio di destinazione. Ciò si verifica quando la risposta viene fornita dalla norma Response Cache o quando si verifica un errore nell'elaborazione della richiesta.

È diversa 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ò essere sostituito anche durante l'elaborazione del proxy API con la variabile di flusso target.url.

Nel proxy chaining e quando si utilizzano destinazioni script (Node.js), target_url nel proxy chiamante è null.

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

Per determinare l'indirizzo IP 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 a un orologio 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:00 e le 23:00, ax_hour_of_day sarà 22.

Il valore dell'ora è in UTC.