Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Questa sezione confronta il monitoraggio delle API con Edge Analytics. Sebbene sia il monitoraggio delle API sia Edge Analytics consentano di raccogliere e visualizzare i dati delle API, hanno obiettivi diversi:
- L'obiettivo del monitoraggio delle API è garantire che le API siano attive e funzionino come previsto. A questo scopo, devi visualizzare i dati più recenti disponibili. Il monitoraggio delle API fornisce dati molto vicini al tempo reale e consente di creare avvisi che ti informano in caso di problemi.
- L'obiettivo di Edge Analytics è comprendere il comportamento a lungo termine delle API, in modo da poter garantire che supportino i requisiti aziendali o apportare modifiche, se necessario. Per questi scopi, è meno importante visualizzare i dati in tempo reale. Di conseguenza, i dati di Analytics sono leggermente ritardati, anche se in genere al massimo di 10 minuti.
Tieni presente che i dati di monitoraggio delle API, che sono principalmente correlati ai codici di errore e alla latenza, sono un piccolo sottoinsieme dei dati di Analytics.
Differenze tra i dati di monitoraggio delle API e i dati di Analytics
Questa sezione descrive alcune piccole differenze tra i dati raccolti da Edge Analytics e quelli raccolti dal monitoraggio delle API. Poiché il monitoraggio delle API 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 discrepanze nei risultati segnalati per gli errori di timeout, sia i timeout del backend (codice di stato HTTP 504 nella richiesta) sia i timeout del client (codice di stato HTTP 499). Questi potrebbero essere visualizzati con il codice di stato 200 nei report personalizzati di Analytics, ma verranno visualizzati con il codice di stato 504 o 499 nei report personalizzati di Monitoring.Monitoraggio delle API
Il monitoraggio delle API fornisce informazioni in tempo reale sulle prestazioni delle API e ti aiuta a diagnosticare e risolvere rapidamente i problemi per garantire che le API funzionino come previsto.
Il monitoraggio delle API ti consente di:
- Aumentare la disponibilità delle API e ridurre il tempo medio alla diagnosi (MTTD).
- Intraprendere le azioni appropriate in base agli avvisi contestuali prima che i consumatori vengano interessati.
- Sfruttare i codici di errore di Apigee per velocizzare la diagnosi.
- Isolare rapidamente le aree problematiche per diagnosticare gli errori, i problemi di prestazioni e di latenza e la loro origine.
Edge API Analytics
Edge API Analytics raccoglie e analizza le informazioni che transitano attraverso le API. API Analytics acquisisce informazioni come:
- L'andamento del traffico API nel tempo
- Le tue principali app
- I tuoi principali sviluppatori
- I metodi API più utilizzati
- Quando il tempo di risposta dell'API è più veloce/più lento
- Dove si verifica la maggior parte del traffico API a livello geografico
Dati raccolti da API Analytics
API Analytics raccoglie e analizza un'ampia gamma di dati che transitano attraverso le API. Ad esempio, mentre l'API è in fase di deployment, 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 al loro utilizzo, consulta Utilizzare le API delle metriche per misurare il rendimento del programma API. Per un elenco completo delle metriche, consulta 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 da intestazioni delle richieste, payload XML/JSON, parametri di query, URI e altre posizioni nel server Analytics per l'analisi e la generazione di report.
Accedere ai dati di Analytics
Una volta generate, puoi accedere alle metriche predefinite e alle metriche personalizzate utilizzando gli strumenti di visualizzazione di API Analytics, tra cui la dashboard, i report personalizzati e la mappa geografica. Per ulteriori informazioni sugli strumenti di visualizzazione forniti da API Analytics, consulta Dashboard di Analytics. Per ulteriori informazioni sui report personalizzati, consulta Creare report personalizzati.
Confrontare il monitoraggio delle API e API Analytics
Gli sviluppatori di API utilizzano sia il monitoraggio delle API sia API Analytics. Una delle principali differenze tra i due è il meccanismo di avviso integrato nel monitoraggio delle API. Gli avvisi consentono al team operativo di rispondere ai problemi relativi alle API in tempo reale per garantire che le API siano disponibili e funzionino come previsto.
Le condizioni di avviso definiscono soglie specifiche per il codice di stato (2xx/4xx/5xx), la latenza e il codice di errore che, se superate, 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 o servizio di destinazione o regione.
Dopo l'attivazione di un avviso, il team operativo può utilizzare l'interfaccia utente di monitoraggio delle API per esaminare il problema e approfondire la causa principale. Puoi quindi generare un report personalizzato che includa informazioni predefinite sull'avviso, ad esempio:
- Tempo di risposta totale
- Tempo di risposta target
- Errori proxy
- Errori target
- UUID richiesta
- Molti altri
API Analytics è progettato per acquisire un'ampia gamma di dati da utilizzare da diversi team. Ad esempio:
- Il team operativo può utilizzare i dati di Analytics per identificare i periodi di traffico elevato o basso, in modo da poter fare lo scale up o fare lo scale down dei servizi per soddisfare le esigenze in continua 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 di intestazione, parametri di query o payload della richiesta.