Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.
Questo argomento è un riferimento per le metriche, le dimensioni e i filtri di Analytics. Per saperne di più sull'utilizzo di queste funzionalità, consulta la panoramica dell'analisi delle API.
Questo argomento mostra i nomi delle metriche e delle dimensioni così come vengono visualizzati nella UI e quando devi utilizzarli nelle chiamate API.
- Vedrai i nomi dell'interfaccia utente quando crei e gestisci i report personalizzati.
- Utilizza i nomi specifici dell'API quando ricevi metriche, crei una definizione di report o aggiorna una definizione di report.
Metriche
Di seguito sono riportate le metriche API che puoi recuperare nei report personalizzati e nelle chiamate API Apigee.
Metrica | Nome da utilizzare nell'API Apigee | Funzioni | Descrizione |
---|---|---|---|
Media transazioni al secondo | tps |
Nessuna selezione |
Numero medio di transazioni al secondo, ovvero 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 essere pari a zero nei report personalizzati dell'interfaccia utente se il numero è inferiore a due cifre decimali. Sintassi API: |
Hit della cache | cache_hit |
somma |
Numero di richieste API riuscite che utilizzano Sintassi API: |
Numero di elementi cache L1 | ax_cache_l1_count |
media, min, max |
Numero di elementi nella cache L1 (in memoria) per transazione in un determinato periodo di tempo. Ad esempio, se scegli Sintassi API: |
Errori dei criteri | policy_error |
somma |
Numero totale di errori delle norme nel periodo di tempo specificato. In genere gli errori dei criteri sono dovuti alla progettazione. Ad esempio, il criterio Un errore del criterio viene registrato in Analytics solo se genera un errore del proxy API.
Ad esempio, se l'attributo La dimensione Nome del criterio in caso di errore ( Un errore di destinazione (ad esempio Sintassi API: |
Errori del proxy | is_error |
somma |
Numero totale di volte in cui i proxy API non sono riusciti nel periodo di tempo specificato. L'errore del proxy può verificarsi quando un criterio non funziona o si verifica un errore di runtime, ad esempio un errore La dimensione Proxy ( Sintassi API: |
Latenza di elaborazione delle richieste | request_processing_latency |
media, min, max |
Quantità di tempo (media, minima o massima), in millisecondi, necessaria ad Apigee per elaborare le richieste in entrata. L'orario inizia quando la richiesta raggiunge Apigee e termina quando Apigee inoltra la richiesta al servizio di destinazione. Utilizzando dimensioni diverse, puoi esaminare le latenze di elaborazione delle richieste in base a proxy API, app dello sviluppatore, regione e così via. Sintassi API: |
Dimensioni richiesta | request_size |
somma, media, min, max |
Dimensioni del payload della richiesta ricevuto da Apigee, espresse in byte. Sintassi API: |
Cache di risposte eseguita | ax_cache_executed |
somma |
Numero totale di volte in cui un criterio Poiché il criterio Tuttavia, l'esecuzione della cache delle risposte è 0 se
l'elemento Nello strumento di debug,
puoi fare clic sull'icona Sintassi API: |
Latenza elaborazione risposta | response_processing_latency |
media, min, max |
Tempo (media, minimo o massimo), in millisecondi, necessario ad Apigee per elaborare le risposte dell'API. Il timestamp 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 al proxy API, alla regione e così via. Sintassi API: |
Dimensioni risposta | response_size |
somma, media, min, max |
Dimensioni del payload di risposta restituito al client, in byte. Sintassi API: |
Errori target | target_error |
somma |
Numero totale di risposte Sintassi API: |
Tempo di risposta target | target_response_time |
somma, media, min, max |
Il 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 momento in cui Apigee inoltra una richiesta al servizio di destinazione e termina quando Apigee riceve la risposta. Tieni presente che se una chiamata API restituisce una risposta dalla cache (ad esempio, utilizzando il criterio Sintassi API: |
Tempo totale di risposta | total_response_time |
somma, media, min, max |
Quantità di tempo (somma, media, minima o massima), in millisecondi, da quando Apigee riceve una richiesta da un client a quando Apigee invia la risposta al client. Sono inclusi 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 nell'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 API: |
Traffico | message_count |
somma |
Numero totale di chiamate API elaborate da Apigee nel periodo di tempo specificato. Utilizza le dimensioni per raggruppare i conteggi di traffico nei modi più significativi per te. Sintassi API: |
Monetizzazione | |||
Tariffe | fees |
somma, media, min, max |
Importo che rappresenta la tariffa di configurazione, le tariffe ricorrenti o la ricarica prepagata. Sintassi API: |
Quota di compartecipazione alle entrate dello sviluppatore | x_apigee_mintng_dev_share |
somma, media, min, max |
Quota dello sviluppatore nelle entrate di una transazione. Apigee calcola la quota dello sviluppatore solo se hai attivato la condivisione delle entrate nel tuo piano tariffario. La quota dello sviluppatore viene calcolata utilizzando la seguente formula: x_apigee_mintng_dev_share = revShareGrossPrice * (share percentage)
Il valore della percentuale di condivisione viene recuperato dal tuo piano tariffario. Sintassi API: |
Prezzo di monetizzazione | x_apigee_mintng_price |
somma, media, min, max |
Entrate totali di una transazione.
Le entrate di una transazione sono impostate sul valore della variabile di monetizzazione Sintassi API: |
Moltiplicatore di prezzo delle API | x_apigee_mintng_price_multiplier |
somma, media, min, max |
Il fattore (moltiplicatore) per cui viene moltiplicato il costo per transazione. Il costo per transazione è specificato nei prezzi Tariffe a consumo del piano tariffario. Sintassi API: |
Tassi di monetizzazione | x_apigee_mintng_rate |
somma, media, min, max |
Tariffa addebitata per una transazione. L'aliquota addebitata per una transazione viene calcolata utilizzando la seguente formula: x_apigee_mintng_rate = (consumption-based pricing rate) * perUnitPriceMultiplier value
Il valore della tariffa basata sul consumo viene recuperato dal piano tariffario e il
valore Sintassi API: |
Dimensioni
Le dimensioni ti consentono di visualizzare le metriche in raggruppamenti significativi. Ad esempio, la visualizzazione dei conteggi totali del traffico diventa molto più efficace quando li visualizzi per ogni app per sviluppatori o proxy API.
Di seguito sono riportate le dimensioni preconfigurate di Apigee.
Dimensioni | Nome da utilizzare nell'API Apigee | Descrizione |
---|---|---|
Token di accesso | access_token |
Token di accesso OAuth dell'utente finale dell'app. |
Prodotto API | api_product |
|
Chiave cache | ax_cache_key |
Chiave contenente il valore Nello strumento di debug, quando selezioni un criterio |
Nome cache | ax_cache_name |
Nome della cache contenente le chiavi/valori utilizzati dal criterio Nello strumento di debug,
quando selezioni un criterio |
Origine cache | ax_cache_source |
Livello cache (database L1 in memoria o L2) da cui è stato recuperato Nello strumento di debug,
quando selezioni il criterio Per ulteriori informazioni sui livelli della cache, consulta Dati interni della cache. |
ID client | client_id |
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 Apigee. Per maggiori informazioni, consulta Come faccio a generare dati di analisi completi?. Se i criteri riportati sopra non vengono soddisfatti, viene visualizzato il valore |
App sviluppatore | developer_app |
App per sviluppatori registrata su Apigee che effettua chiamate API. Per ottenere questa dimensione, le app devono essere 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 la chiamata API. La chiave o il token identifica l'app sviluppatore. Per ulteriori informazioni, consulta Come faccio a generare dati di analisi completi?. Se i criteri riportati sopra non vengono soddisfatti, viene visualizzato il valore |
Email sviluppatore | developer_email |
|
ID sviluppatore | developer |
ID sviluppatore univoco generato da Apigee sotto forma di
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 inviati con le chiamate API. La chiave o il token identifica lo sviluppatore. Per saperne di più, consulta Come faccio a generare dati di analisi completi?. Se i criteri riportati sopra non vengono soddisfatti, viene visualizzato il valore |
Ambiente | environment |
Ambiente Apigee in cui viene eseguito il deployment dei proxy API. Ad esempio, test o prod . |
Codice di guasto in caso di errore | ax_edge_execution_fault_code |
Il codice di guasto dell'errore. Ad esempio:
|
Nome flusso in caso di errore | ax_execution_fault |
Denominato flusso in un proxy API che ha generato un errore. Ad esempio, Tieni presente che il nome completo da utilizzare nell'API Apigee è
Se non si sono verificati errori, viene visualizzato il valore |
Risorsa flusso | flow_resource |
Solo per uso di Apigee. Se vuoi utilizzare la dimensione "Flusso di risorse" in Analytics, consulta Come utilizzare la dimensione "Flusso di risorse". |
Stato del flusso in caso di errore | ax_execution_fault |
Nome degli stati del flusso proxy API che hanno generato errori, ad esempio Tieni presente che il nome completo da utilizzare nell'API Apigee è |
ID flusso gateway | gateway_flow_id |
Man mano che le chiamate API passano attraverso Apigee, ogni chiamata riceve il proprio ID flusso del gateway. Esempio: rrt329ea-12575-114653952-1. L'ID flusso del gateway è utile per distinguere le metriche in situazioni con TPS elevato in cui altre dimensioni, come organizzazione, ambiente e timestamp, sono identiche nelle chiamate. |
Organizzazione | organization |
Organizzazione Apigee in cui viene eseguito il deployment dei proxy API. |
Nome del criterio in caso di errore | ax_execution_fault |
Nome del criterio che ha generato un errore e che ha causato l'esito negativo della chiamata API. Tieni presente che il nome completo da utilizzare nell'API Apigee è Se un criterio genera un errore, ma l'attributo principale del criterio |
Proxy | apiproxy |
Nome macchina (non il nome visualizzato) di un proxy API. |
Percorso di base proxy | proxy_basepath |
BasePath configurato sul proxy API 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 è Il valore è anche memorizzato nella variabile di flusso |
Tipo di distribuzione proxy | proxy_deployment_type |
Il tipo di proxy API per i proxy di cui è stato eseguito il deployment. Se specifichi un tipo di proxy, i risultati saranno limitati a quel tipo di proxy. I valori potenziali sono |
Suffisso percorso proxy | proxy_pathsuffix |
Percorso della risorsa aggiunto al percorso di base del proxy API. Ad esempio, se l'URL di base di un proxy API è Se non viene utilizzato Il valore è anche memorizzato nella variabile di flusso |
Revisione proxy | apiproxy_revision |
Numero di revisione del proxy API che ha gestito le chiamate API. Questo non significa necessariamente che sia stata eseguita l'ultima revisione di un proxy API. Se un proxy API ha 10 revisioni, attualmente può essere eseguito il deployment dell'8a revisione. Inoltre, un'API può avere più revisioni di cui è stato eseguito il deployment, purché le revisioni abbiano percorsi di base diversi, come descritto in Eseguire il deployment dei proxy. |
IP client risolto | ax_resolved_client_ip |
Indirizzo IP client di origine. Il valore della dimensione Tieni presente che quando utilizzi prodotti di routing come Akamai per acquisire i veri indirizzi IP dei client, l'IP client viene passato ad Apigee nell'intestazione HTTP Il valore della dimensione
|
Codice di stato risposta | response_status_code |
Codice di stato della risposta HTTP inoltrato da Apigee al client, come 200 , 404 , 503 e così via. In Apigee, il codice di stato della risposta del target può essere sovrascritto con criteri come il criterioAssignMessage e il Criterio RaiseFault, motivo per cui questa dimensione può essere diversa dal Codice di risposta target (target_response_code). |
Host virtuale | virtual_host |
Il nome dell'host virtuale a cui è stata effettuata la chiamata API. Per saperne di più, vedi Informazioni sugli ambienti e sui gruppi di ambienti. |
In entrata/cliente | ||
Indirizzo IP client | client_ip |
Indirizzo IP del sistema che contatta il router, ad esempio il client originale (proxy_client_ip) o un bilanciatore del carico. Se ci sono più IP nell'intestazione X-Forwarded-For , questo è l'ultimo IP elencato. |
Categoria dispositivo | ax_ua_device_category |
Tipo di dispositivo da cui è stata effettuata la chiamata API, ad esempio Tablet o Smartphone . |
Famiglia di sistemi operativi | ax_ua_os_family |
Famiglia del sistema operativo del dispositivo che effettua la chiamata, ad esempio Android o iOS . |
Versione sistema operativo | ax_ua_os_version |
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 vedere le versioni dei sistemi operativi. |
IP client proxy | proxy_client_ip |
Indirizzo IP del client chiamante, archiviato nella variabile di flusso |
IP client di riferimento | ax_true_client_ip |
Quando utilizzi prodotti di routing come Akamai per acquisire gli indirizzi IP reali dei client, gli IP client vengono passati ad Apigee nell'intestazione HTTP Per determinare l'indirizzo IP del client originale, a cui si accede tramite la dimensione |
Percorso richiesta | request_path |
Percorso della risorsa (escluso il dominio) al servizio di destinazione, esclusi i parametri di query. Ad esempio, il target di esempio Apigee |
URI di richiesta | request_uri |
Percorso della risorsa (escluso il dominio) al servizio di destinazione, inclusi i parametri di query. Ad esempio, il target di esempio Apigee |
Richiedi verbo | request_verb |
Verbo di richiesta HTTP nelle richieste API, ad esempio GET, POST, PUT, DELETE. |
User agent | useragent |
Nome dello user agent o dell'agente software utilizzato per effettuare la chiamata API. Esempi:
|
Famiglia user agent | ax_ua_agent_family |
Famiglia dello user agent, ad esempio Chrome Mobile o curl . |
Tipo di user agent | ax_ua_agent_type |
Il tipo di useragent, ad esempio Browser , Mobile Browser , Library e così via. |
Versione user agent | ax_ua_agent_version |
Versione dello user agent. È utile utilizzarla come seconda dimensione di visualizzazione in dettaglio con Famiglia user agent (ax_ua_agent_family) per ottenere la versione della famiglia di agenti. |
In uscita/Target | ||
Destinazione | target |
Endpoint di destinazione che ha gestito la richiesta. Ad esempio, default . |
Percorso di base target | target_basepath |
Percorso della risorsa (escluso il dominio) al servizio di destinazione, esclusi i parametri di query, definito nell'elemento 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 è Se il target fosse questo: <TargetEndpoint name="default"> ... <HTTPTargetConnection> <URL>http://mocktarget.apigee.net</URL> </HTTPTargetConnection> il campo target_basepath sarà nullo. Nello strumento di debug, quando selezioni l'icona AX alla fine del diagramma di flusso, la variabile di flusso |
Nome servizio gRPC | x_apigee_grpc_service_name |
Applicabile solo quando il servizio di destinazione è gRPC. Il nome del servizio gRPC. Per informazioni sui proxy gRPC, consulta la pagina relativa alla creazione di proxy API gRPC. |
Stato gRPC | x_apigee_grpc_status |
Applicabile solo quando il servizio di destinazione è gRPC. Lo stato della richiesta gRPC. Per informazioni sui proxy gRPC, consulta la pagina relativa alla creazione di proxy API gRPC. |
Host di destinazione | target_host |
Host del servizio di destinazione. Ad esempio, se un proxy API chiama
http://mocktarget.apigee.net/help , target_host è
mocktarget.apigee.net . |
Indirizzo IP di destinazione | target_ip |
Indirizzo IP del servizio di destinazione che restituisce la risposta al proxy API. |
Codice di risposta target | target_response_code |
Codice di stato della risposta HTTP restituito dal servizio di destinazione al proxy API, come Il valore È diversa dalla dimensione Codice di stato della risposta (response_status_code). |
Nome RPC gRPC | x_apigee_grpc_rpc_name |
Applicabile solo quando il servizio di destinazione è gRPC. Il nome RPC. Per informazioni sui proxy gRPC, consulta la pagina relativa alla creazione di proxy API gRPC. |
URL di destinazione | target_url |
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 è Tieni presente che puoi eseguire l'override dell'URL durante l'elaborazione del proxy API con la variabile di flusso Nel concatenamento proxy, il target_url nel proxy di chiamata è null. |
IP inoltrato X | x_forwarded_for_ip |
L'elenco di indirizzi IP nell'intestazione Per determinare l'indirizzo IP del client originale, a cui si accede tramite la dimensione |
X-Forwarded-For Proto | x_forwarded_proto |
Protocollo che il client ha utilizzato per connettersi al router. I valori validi sono |
Ora | ||
Giorno della settimana | ax_day_of_week |
Abbreviazione del giorno della settimana di tre lettere in cui sono state effettuate le chiamate API. Ad esempio, lun, mar, mer. |
Mese | ax_month_of_year |
Il mese numerico in cui sono state effettuate le chiamate API. Ad esempio, 03 per marzo. |
Ora del giorno | ax_hour_of_day |
Sulla base di un orologio di 24 ore, l'ora di 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. |
Fuso orario | ax_geo_timezone |
Nomi comuni dei fusi orari da cui sono state effettuate le chiamate API, come
America/New_York e Europe/Dublin . |
Settimana del mese | ax_week_of_month |
Settimana numerica del mese. Ad esempio, per le chiamate API effettuate nella terza settimana di un
mese, ax_week_of_month è 3. |
Località | ||
Città | ax_geo_city |
Città da cui sono state effettuate le chiamate API. |
Continente | ax_geo_continent |
Codice di due lettere del continente da cui sono state effettuate le chiamate API. Ad esempio,
NA per il Nord America. |
Paese | ax_geo_country |
Codice di due lettere del paese da cui sono state effettuate le chiamate API. Ad esempio, US
per gli Stati Uniti. |
Regione geografica | ax_geo_region |
Codice troncato per la regione geografica, ad esempio STATE-COUNTRY . Ad esempio,
WA-US per Washington-Stati Uniti. |
Regione | ax_dn_region |
Nome del data center Apigee in cui viene eseguito il deployment dei proxy API, ad esempio us-east-1 . |
Monetizzazione | ||
Data/ora creazione | created |
Attualmente disponibile nelle organizzazioni Apigee, non nelle organizzazioni ibride Apigee. Timestamp Unix del momento in cui è stata aggiunta la pianificazione delle tariffe per lo sviluppatore di app e il prodotto API. |
Tipo di commissioni | fees_type |
Tipo di tariffa. Può trattarsi di una tariffa di configurazione, di una tariffa ricorrente o di una ricarica prepagata. Questo valore viene compilato solo se hai selezionato la metrica Fees . |
Valuta delle entrate | x_apigee_mintng_currency |
|
ID piano tariffario | x_apigee_mintng_rate_plan_id |
Attualmente disponibile nelle organizzazioni Apigee, non nelle organizzazioni ibride Apigee. Il piano del tasso di monetizzazione per lo sviluppatore di app. |
Transazione riuscita | x_apigee_mintng_tx_success |
Lo stato di monetizzazione della transazione è impostato sul valore della variabile di monetizzazione transactionSuccess acquisita nelle norme Data Capture. |
Filtri
I filtri ti consentono di limitare i risultati a metriche con caratteristiche specifiche. Di seguito sono riportati alcuni filtri di esempio. Quando definisci i filtri, utilizza nomi in stile API di metriche e dimensioni.
Restituisce metriche per i proxy API con i libri dei nomi o la musica:
filter=(apiproxy in 'books','music')
Restituisce le metriche per i proxy API con nomi che iniziano con m
:
filter=(apiproxy like 'm%')
Restituisce le metriche per i proxy API con nomi che non iniziano con m
:
filter=(apiproxy not like 'm%')
Restituisce metriche per le chiamate API con codici di stato della risposta compresi tra 400
e 599
:
filter=(response_status_code ge 400 and response_status_code le 599)
Restituisce metriche per le chiamate API con un codice di stato della risposta di 200
e un codice di risposta target di
404
:
filter=(response_status_code eq 200 and target_response_code eq 404)
Restituisce metriche per le chiamate API con un codice di stato di risposta 500
:
filter=(response_status_code eq 500)
Restituisce le metriche per le chiamate API che non hanno generato errori:
filter=(is_error eq 0)
Restituisce metriche per le chiamate API che non hanno generato risposte null
:
filter=(response_status_code isnot null)
Di seguito sono riportati gli operatori che puoi utilizzare per creare filtri dei report.
Operatore | Descrizione |
---|---|
in |
Includi nell'elenco |
notin |
Escludi dall'elenco |
is |
Utilizza response_status_code is null per filtrare in base alle risposte il cui codice di stato è null . |
isnot |
Utilizza response_status_code isnot null per filtrare in base alle risposte il cui codice di stato non è null . |
eq |
È uguale a == |
ne |
Non uguale a != |
gt |
Maggiore di > |
lt |
Minore di < |
ge |
Maggiore di o uguale a >= |
le |
Minore o uguale a <= |
like |
Restituisce true se il pattern stringa corrisponde al pattern fornito. |
not like |
Restituisce false se il pattern stringa corrisponde al pattern fornito. |
similar to |
Restituisce true o false a seconda che il suo pattern corrisponda alla stringa specificata. È simile a like , ad eccezione del fatto che interpreta il pattern utilizzando la definizione di espressione regolare dello standard SQL. |
not similar to |
Restituisce false o true a seconda che il suo pattern corrisponda alla stringa specificata. È simile a not like , ad eccezione del fatto che interpreta il pattern utilizzando la definizione di espressione regolare dello standard SQL. |
and |
Consente di utilizzare la logica AND per includere più di un'espressione di filtro. Il filtro include i dati che soddisfano tutte le condizioni. |
or |
Consente di utilizzare la logica OR per valutare diverse espressioni di filtro possibili. Il filtro include i dati che soddisfano almeno una delle condizioni. |