Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza
documentazione di Apigee Edge.
Apigee registra un'ampia varietà di dati operativi e aziendali che passano per le API. Le metriche ricavate da questi dati sono utili per il monitoraggio operativo e aziendale. Con Apigee Analytics, puoi, ad esempio, Ad esempio, stabilire quali API hanno prestazioni soddisfacenti o scarse, quali sviluppatori offrono di valore più elevato e le app che causano il maggior numero di problemi per i tuoi servizi di backend.
Per accedere facilmente a questi dati delle metriche, utilizza l'API Metrics quando devi automatizzare determinate funzioni di analisi, ad esempio il recupero delle metriche periodicamente utilizzando uno script o un client di automazione. Puoi anche utilizzare l'API per creare le tue visualizzazioni sotto forma di widget personalizzati che puoi incorporare in portali o app personalizzate.
Per informazioni su come utilizzare Analytics nella UI di Apigee, consulta la panoramica di Apigee Analytics.
Informazioni sull'API Metrics
Puoi utilizzare l'API Metrics in due modi:
- Visualizza le metriche per un'organizzazione e un ambiente
in un periodo di tempo, ad esempio un'ora, un giorno o una settimana.
Questo metodo restituisce le metriche non elaborate per l'intera organizzazione e l'intero ambiente.
Ad esempio, per la settimana precedente, vuoi ottenere:
- Numero di errori dei criteri
- Tempo di risposta medio
- Traffico totale
Visualizza le metriche organizzate per dimensione in un periodo di tempo per un'organizzazione e un ambiente.
Ad esempio, per la settimana precedente puoi utilizzare le dimensioni per raggruppare le metriche per prodotto API, proxy API e email dello sviluppatore (che può anche essere un ID gruppo di app) per ottenere:
- Numero di errori relativi alle norme per prodotto API
- Tempo di risposta medio per proxy API
- Traffico totale per email sviluppatore
Per gestire il risultato restituito, l'API Metrics supporta le seguenti funzionalità:
Per ulteriori informazioni, consulta il riferimento all'API Metrics.
Inizia a utilizzare l'API Metrics
L'URL della richiesta per l'API Metrics è:
https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats[dimension]
Ad esempio, per ottenere le metriche raggruppate per proxy API, utilizza il seguente URL per chiamare l'API Apigee:
https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/apiproxy?timeRange=07/21/2018+00:00:00~08/23/2018+00:00:00
Ometti la dimensione per restituire le metriche non elaborate per l'intera organizzazione e l'intero ambiente per il periodo di tempo specificato:
https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats?timeRange=07/21/2019+00:00:00~08/23/2018+00:00:00
Specifica delle metriche da restituire
Utilizza il parametro di query
selectper specificare le metriche da recuperare e una funzione di aggregazione facoltativa nel seguente formato:?select=metric
oppure:
?select=aggFunction(metric)
Dove:
- metric specifica i dati che vuoi restituire. Ad esempio:
il numero di richieste API, i successi della cache o gli errori dei criteri. Consulta metrics
per una tabella che specifica il nome della metrica da utilizzare con il parametro di query
select. aggFunction specifica la funzione di aggregazione facoltativa eseguita sulla metrica. Ad esempio, puoi utilizzare le seguenti funzioni di aggregazione con la metrica della latenza di elaborazione:
avg: restituisce la latenza di elaborazione media.min: restituisce la latenza di elaborazione minima.max: restituisce la latenza massima di elaborazione.-
sum: restituisce la somma di tutte le latenze di elaborazione. -
p50: restituisce il 50° percentile per le latenze di elaborazione. -
p95: restituisce il 95° percentile delle latenze di elaborazione. -
p99: restituisce il 99° percentile delle latenze di elaborazione.
Non tutte le metriche supportano tutte le funzioni di aggregazione. La documentazione sulle metriche contiene una tabella che specifica il nome della metrica e la funzione (
sum,avg,min,max) supportata dalla metrica.
Ad esempio, per restituire il numero medio di transazioni al secondo, ovvero richieste proxy API:
?select=tps
Tieni presente che questo esempio non richiede una funzione di aggregazione. L'esempio seguente utilizza una funzione di aggregazione per restituire la somma dei hit della cache:
?select=sum(cache_hit)
Puoi restituire più metriche per una singola chiamata API. Per ottenere le metriche relative alla somma degli errori di criteri e alle dimensioni medie delle richieste, imposta il parametro di query
selectutilizzando un elenco di metriche separate da virgola:?select=sum(policy_error),avg(request_size)
Specificare il periodo di tempo
L'API Metrics restituisce i dati relativi a un periodo di tempo specificato. Utilizza il parametro di query
timeRange(massimo 6 mesi) per specificare il periodo di tempo, nel formato:?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM
Osserva
%20prima diHH:MM. Il parametrotimeRangerichiede uno spazio con codifica URL prima diHH:MMo un carattere+, ad esempio:MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.Ad esempio:
?timeRange=03/01/2018%2000:00~03/30/2018%2023:59
Non usare le 24:00 come ora perché finiscono per le 00:00. Usa invece 23:59.
Esempi di chiamata all'API Metrics
Questa sezione fornisce esempi di utilizzo dell'API Metrics. Per ulteriori esempi, consulta gli esempi di API Metrics.
Restituisce il numero totale di chiamate effettuate alle tue API per un mese
Per restituire il numero totale di chiamate effettuate a tutte le API della tua organizzazione e del tuo ambiente per un mese, utilizza una chiamata simile alla seguente:
curl -v "https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/?select=sum(message_count)&timeRange=03/01/2018%2000:00~03/31/2018%2023:59" \ -H "Authorization: Bearer $TOKEN"
Dove
$TOKENè impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzionicurlutilizzate in questo esempio, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.Di seguito viene fornito un esempio della risposta:
{ "environments": [ { "metrics": [ { "name": "sum(message_count)", "values": [ "7.44944088E8" ] } ], "name": "prod" } ], ... }Restituisce il conteggio totale dei messaggi per proxy API per due giorni
In questo esempio, restituisci le metriche relative al numero di richieste ricevute da tutti i proxy API in un periodo di due giorni. Il parametro di query
selectdefinisce la funzione aggregatasumper la metricamessage_countsulla dimensioneapiproxy. Il report restituisce il throughput dei messaggi di richiesta per tutte le API per il traffico ricevuto tra l'inizio del 20/06/2018 e la fine del 21/06/2018, nel tempo UTC:curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/apiproxy?"select=sum(message_count)&timeRange=06/20/2018%2000:00~06/21/2018%2023:59" \ -H "Authorization: Bearer $TOKEN"
dove
$TOKENè impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzionicurlutilizzate in questo esempio, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.Di seguito viene fornito un esempio della risposta:
{ "environments" : [ { "dimensions" : [ { "metrics" : [ { "name" : "sum(message_count)", "values" : [ { "timestamp" : 1498003200000, "value" : "1100.0" } ] } ], "name" : "target-reroute" } ], "name" : "test" } ]... }Questa risposta indica che 1100 messaggi sono stati ricevuti da un proxy API chiamato "target-reroute" in esecuzione nell'ambiente di test tra l'inizio del giorno 20/06/2018 e la fine del giorno 21/06/2018.
Per ottenere le metriche per altre dimensioni, specifica una dimensione diversa come parametro URI. Ad esempio, puoi specificare la dimensione
developer_appper recuperare le metriche per le app sviluppatore. La seguente chiamata API restituisce il throughput totale (messaggi ricevuti) da qualsiasi app per l'intervallo di tempo specificato:curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/developer_app?"select=sum(message_count)&timeRange=06/20/2018%2000:00~06/21/2018%2023:59&timeUnit=day" \ -H "Authorization: Bearer $TOKEN"
Di seguito viene fornito un esempio della risposta:
{ "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ { "timestamp": 1498003200000, "value": "886.0" } ] } ], "name": "Test-App" }, { "metrics": [ { "name": "sum(message_count)", "values": [ { "timestamp": 1498003200000, "value": "6645.0" } ] } ], "name": "johndoe_app" }, { "metrics": [ { "name": "sum(message_count)", "values": [ { "timestamp": 1498003200000, "value": "1109.0" } ] } ], "name": "marys_app" } ]... }Ordinamento dei risultati in base al ranking relativo
Spesso, quando ottieni le metriche, vuoi ottenere risultati solo per un sottoinsieme dell'insieme totale di dati. Di solito, è necessario ottenere i risultati per le "primi 10", ad esempio i "primi 10 più lenti API", le "10 app più attive". A tale scopo, puoi utilizzare il parametro di query
topkcome parte della richiesta.Ad esempio, potresti essere interessato a sapere chi sono i tuoi sviluppatori migliori, misurati in termini di throughput, o quali sono i tuoi sviluppatori con il rendimento peggiore (ad es. "più lente") sono in base alla latenza.
topk(ovvero le entità "top k") consente di generare report sulle entità associate con il valore più alto per una determinata metrica. In questo modo puoi filtrare le metriche per un elenco di entità che esemplificano una determinata condizione.Ad esempio, per trovare l'URL di destinazione con il maggiore rischio di errori nell'ultima settimana, il parametro
topkviene aggiunto alla richiesta, con il valore1:curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/target_url?"select=sum(is_error)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=week&sortby=sum(is_error)&topk=1" \ -H "Authorization: Bearer $TOKEN"
dove
$TOKENè impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzionicurlutilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.Di seguito è riportato un esempio di risposta:
{ "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(is_error)", "values": [ { "timestamp": 1494201600000, "value": "12077.0" } ] } ], "name": "http://api.company.com" } ]... }Il risultato di questa richiesta è un insieme di metriche che mostra che l'URL di destinazione più bug
http://api.company.com.Puoi anche utilizzare il parametro
topkper ordinare in base alle API con il tasso e la velocità effettiva effettiva. L'esempio seguente recupera le metriche dell'API con il ranking più alto, definita in base al throughput più elevato nell'ultima settimana:curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV}/stats/apiproxy?"select=sum(message_count)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=day&sortby=sum(message_count)&sort=DESC&topk=1" \ -H "Authorization: Bearer $TOKEN"
Di seguito è riportato un esempio di risposta:
{ "environments": [ { "dimensions": [ { "metrics": [ { "name": "sum(message_count)", "values": [ { "timestamp": 1494720000000, "value": "5750.0" }, { "timestamp": 1494633600000, "value": "5752.0" }, { "timestamp": 1494547200000, "value": "5747.0" }, { "timestamp": 1494460800000, "value": "5751.0" }, { "timestamp": 1494374400000, "value": "5753.0" }, { "timestamp": 1494288000000, "value": "5751.0" }, { "timestamp": 1494201600000, "value": "5752.0" } ] } ], "name": "testCache" } ], "name": "test" } ]... }Filtro dei risultati in corso...
Per una maggiore granularità, puoi filtrare i risultati per limitare i dati restituiti. Quando utilizzi i filtri, devi utilizzare le dimensioni come proprietà di filtro.
Supponiamo, ad esempio, che tu debba recuperare un conteggio di errori dai servizi di backend e viene filtrato in base al verbo HTTP della richiesta. Il tuo obiettivo è scoprire quante richieste POST e PUT generano errori per servizio di backend. Per farlo, devi utilizzare la dimensione
target_urlinsieme al filtrorequest_verb:curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/target_url?"select=sum(is_error)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=week&filter=(request_verb%20in%20'POST','PUT')" \ -H "Authorization: Bearer $TOKEN"
dove
$TOKENè impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzionicurlutilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.Di seguito è riportato un esempio di risposta:
{ "environments" : [ { "dimensions" : [ { "metrics" : [ { "name" : "sum(is_error)", "values" : [ { "timestamp" : 1519516800000, "value" : "1.0" } ] } ], "name" : "testCache" } ], "name" : "test" } ]... }Impaginazione dei risultati
Negli ambienti di produzione, alcune richieste all'API Apigee Analytics restituiscono set di dati molto grandi. Per semplificare la visualizzazione di set di dati di grandi dimensioni nel contesto di un'applicazione basata su UI, l'API supporta in modo nativo la paginazione.
Per paginare i risultati, utilizza i parametri di query
offsetelimit, insieme al parametro di ordinamentosortbyper garantire un ordinamento coerente degli elementi.Ad esempio, è probabile che la seguente richiesta restituisca un set di dati di grandi dimensioni, poiché recupera le metriche relative a tutti gli errori relativi a tutte le API nell'ambiente del prodotto per l'ultima settimana.
curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=week&sortby=sum(is_error)" \ -H "Authorization: Bearer $TOKEN"
dove
$TOKENè impostato sul tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzionicurlutilizzate in questo esempio, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.Se la tua applicazione basata su UI può visualizzare ragionevolmente 50 risultati per pagina, puoi impostare il limite a 50. Poiché 0 viene conteggiato come primo elemento, la chiamata seguente restituisce gli elementi 0-49 in ordine discendente (
sort=DESCè il valore predefinito).curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=week&sortby=sum(is_error)&limit=50&offset=0" \ -H "Authorization: Bearer $TOKEN"
Per la seconda "pagina" dei risultati, utilizza il parametro di query offset, come segue. Tieni presente che limite e offset sono identici. Questo perché 0 viene conteggiato come primo elemento. Con un limite di 50 e e un offset pari a 0, vengono restituiti gli elementi da 0 a 49. Con un offset di 50, vengono restituiti gli elementi 50-99.
curl https://apigee.googleapis.com/v1/organizations/$ORG/environments/$ENV/stats/apiproxy?"select=sum(is_error)&timeRange=05/08/2018%2000:00~05/15/2018%2000:00&timeUnit=week&sortby=sum(is_error)&limit=50&offset=50" \ -H "Authorization: Bearer $TOKEN"