Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
Questa sezione mette a confronto il monitoraggio delle API con Edge Analytics. Sebbene sia API Monitoring sia Edge Analytics ti consentano di raccogliere e visualizzare i dati delle API, hanno obiettivi diversi:
- Lo scopo del monitoraggio delle API è garantire che le API siano attive e funzionanti come previsto. A questo scopo, è necessario visualizzare i dati più recenti disponibili. Il monitoraggio delle API fornisce dati molto vicini al tempo reale e ti consente di creare avvisi che ti inviano una notifica in caso di problemi.
- L'obiettivo di Edge Analytics è comprendere il comportamento a lungo termine delle API, in modo da assicurarti che supportino i requisiti della tua attività o apportare modifiche, se necessario. A questo scopo, è meno importante visualizzare i dati in tempo reale. Di conseguenza, i dati di Analytics presentano un leggero ritardo, anche se in genere non supera i 10 minuti.
Tieni presente che i dati del monitoraggio dell'API, che riguardano principalmente codici di errore e latenza, sono un piccolo sottoinsieme dei dati di Analytics.
Differenze tra i dati del monitoraggio dell'API e i dati di Analytics
Questa sezione descrive alcune differenze minori tra i dati raccolti da Edge Analytics e quelli raccolti da API Monitoring. Poiché le API Monitoring e Analytics utilizzano pipeline di dati diverse, potresti notare piccole differenze tra i report personalizzati generati da Monitoring e quelli generati da Analytics. Ad esempio, potresti notare delle discrepanze nei risultati segnalati per gli errori di timeout, sia per i timeout del backend (codice di stato HTTP 504 nella richiesta) sia per i timeout del client (codice di stato HTTP 499). Questi errori potrebbero essere visualizzati con il codice di stato 200 nei report personalizzati di Analytics, ma con il codice di stato 504 o 499 nei report personalizzati di monitoraggio.Monitoraggio delle API
Monitoraggio delle API fornisce informazioni in tempo reale sulle prestazioni delle API e ti aiuta a diagnosticare e risolvere rapidamente i problemi per mantenere le API in funzione come previsto.
Il monitoraggio delle API ti consente di:
- Aumenta la disponibilità delle API e riduci il tempo medio di diagnosi (MTTD).
- Intervieni in modo appropriato in base agli avvisi contestuali prima che i consumatori siano interessati.
- Utilizza i codici di errore Apigee per velocizzare la diagnosi.
- Isola rapidamente le aree problematiche per diagnosticare i problemi di errori, prestazioni e latenza e la relativa origine.
Edge API Analytics
Edge API Analytics raccoglie e analizza le informazioni che passano attraverso le API. L'API Analytics acquisisce informazioni quali:
- Le tendenze del traffico API nel tempo
- Quali sono le tue app principali
- Chi sono i tuoi sviluppatori principali
- Quali metodi API sono più utilizzati
- Quando il tempo di risposta dell'API è più rapido/più lento
- Dove geograficamente registri il maggior traffico API
Dati raccolti dall'API Analytics
API Analytics raccoglie e analizza un ampio spettro di dati che vengono trasferiti tra le API. Ad esempio, durante il deployment dell'API, Analytics registra costantemente il numero di messaggi ricevuti, il numero di sviluppatori, i tempi di risposta, gli errori, il numero di app in uso, le dimensioni delle richieste e molti altri dati.
Per una buona introduzione alle metriche e a come utilizzarle, consulta Utilizzare le API di misurazione per misurare il rendimento del programma API. Per un elenco completo delle metriche, consulta la sezione Riferimento per metriche, dimensioni e filtri di analisi.
Raccogliere metriche personalizzate
Puoi anche raccogliere metriche personalizzate utilizzando il criterio StatisticsCollector. Il criterio StatisticsCollector può scrivere informazioni provenienti da intestazioni di richiesta, payload XML/JSON, parametri di query, URI e altre posizioni in Analytics Server per l'analisi e la generazione di report.
Accedere ai dati di Analytics
Una volta generate, puoi accedere alle metriche predefinite e personalizzate utilizzando gli strumenti di visualizzazione dell'API Analytics, tra cui la dashboard, i report personalizzati e GeoMap. Per saperne di più sugli strumenti di visualizzazione forniti dall'API Analytics, consulta Dashboard di Analytics. Per ulteriori informazioni sui report personalizzati, consulta Creare report personalizzati.
Confronta il monitoraggio delle API e l'analisi delle API
Gli sviluppatori di API utilizzano sia API Monitoring che API Analytics. Una delle principali differenze tra i due è il meccanismo di avviso integrato nel monitoraggio API. Gli avvisi consentono al team operativo di rispondere in tempo reale ai problemi relativi alle API per garantire che siano disponibili e funzionino come previsto.
Le condizioni di avviso definiscono codici di stato (2xx/4xx/5xx), latenza e soglie di codici di errore specifici che, se superati, attivano avvisi visivi nell'interfaccia utente e inviano notifiche tramite una serie di canali, come email, Slack, PagerDuty o webhook. Puoi configurare gli avvisi a livello di ambiente, proxy API, servizio target o regione.
Dopo l'attivazione di un avviso, il team operativo può utilizzare l'interfaccia utente di monitoraggio dell'API per esaminare il problema e risalire alla causa principale. Puoi quindi generare un report personalizzato che include informazioni predefinite sull'avviso, ad esempio:
- Tempo di risposta totale
- Tempo di risposta target
- Errori proxy
- Errori target
- UUID richiesta
- e molti altri
Le API Analytics sono progettate per acquisire una vasta gamma di dati da utilizzare da più team. Ad esempio:
- Il team operativo può utilizzare i dati di Analytics per identificare periodi di traffico elevato o ridotto, in modo da aumentare o diminuire la scalabilità dei servizi per soddisfare le esigenze in evoluzione.
- Il team di marketing può utilizzare i dati di Analytics per determinare i pattern di utilizzo dei clienti identificati da singole API, app, clienti o altri dati.
- Tutti i team possono accedere ai dati personalizzati raccolti da una richiesta per monitorare informazioni specifiche come valori dell'intestazione, parametri di query o payload della richiesta.