Confrontare il monitoraggio delle API con Edge Analytics

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Questa sezione mette a confronto il monitoraggio delle API con Edge Analytics. Sebbene il monitoraggio delle API e l'analisi perimetrale ti 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 in esecuzione come previsto. A questo scopo, vuoi vedere i dati più recenti disponibili. API Monitoring fornisce dati molto vicini a quelli in tempo reale e consente di creare avvisi per ricevere 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 tuoi requisiti aziendali o apportare modifiche, se necessario. Per questi scopi, è meno importante visualizzare i dati in tempo reale. Di conseguenza, i dati di Analytics presentano un leggero ritardo, anche se di solito di massimo 10 minuti.

Tieni presente che i dati di monitoraggio delle API, correlati principalmente ai codici di errore e alla latenza, sono un piccolo sottoinsieme di 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 da API Monitoring. Poiché API Monitoring e Analytics utilizzano pipeline di dati diverse, potresti notare lievi differenze tra i report personalizzati generati da Monitoring e quelli generati da Analytics. Ad esempio, potresti notare delle discrepanze nei risultati segnalati relativi agli 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). Possono 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 Monitoring.

Monitoraggio delle API

Il monitoraggio delle API fornisce insight in tempo reale sulle prestazioni delle API e consente di diagnosticare e risolvere rapidamente i problemi affinché le API continuino a funzionare come previsto.

Il monitoraggio delle API ti consente di:

  • Aumenta la disponibilità delle API e riduci il tempo medio per la diagnosi (MTTD).
  • Adotta le azioni appropriate in base ad avvisi contestuali prima che i consumatori siano interessati.
  • Sfrutta i codici di errore di Apigee per velocizzare la diagnosi.
  • Isola rapidamente le aree problematiche per diagnosticare i problemi di errore, prestazioni e latenza e la relativa origine.

Analisi delle API Edge

Edge API Analytics raccoglie e analizza le informazioni che passano attraverso le API. L'analisi delle API acquisisce informazioni quali:

  • Tendenze del traffico API nel tempo
  • Quali sono le tue app principali
  • Chi sono i tuoi principali sviluppatori
  • Quali sono i metodi API più popolari
  • Qual è il tempo di risposta dell'API più veloce/più lento
  • Dove vedi più traffico API sul tuo sito geografico

Dati raccolti da API Analytics

L'analisi delle API raccoglie e analizza un ampio spettro di dati che passano attraverso 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 l'articolo Utilizzare le API delle metriche per misurare le prestazioni dei programmi API. Per un elenco completo delle metriche, consulta il riferimento su metriche, dimensioni e filtri di Analytics.

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 al server di Analytics per l'analisi e la generazione dei report.

Accedere ai dati di Analytics

Dopo la generazione, puoi accedere a metriche predefinite e personalizzate utilizzando gli strumenti di visualizzazione di analisi delle API, tra cui la dashboard, i report personalizzati e la mappa geografica. Per ulteriori informazioni sugli strumenti di visualizzazione forniti da API Analytics, consulta le 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 il monitoraggio delle API che l'analisi delle API. Una delle principali differenze tra i due è il meccanismo di avviso integrato in API Monitoring. Gli avvisi consentono al tuo team operativo di rispondere ai problemi con le API in tempo reale per garantire che le API siano disponibili e funzionino come previsto.

Le condizioni di avviso definiscono soglie specifiche per i codici di stato (2xx/4xx/5xx), la latenza e il codice di errore che, quando vengono superati, attivano avvisi visivi nell'interfaccia utente e inviano notifiche tramite una serie di canali, ad esempio email, slack, pagerduty o webhook. Puoi configurare avvisi a livello di ambiente, proxy API, servizio di destinazione 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 visualizzarne la causa principale. Puoi quindi generare un report personalizzato che include informazioni predefinite sull'avviso, ad esempio:

  • Tempo totale di risposta
  • Tempo di risposta target
  • Errori del proxy
  • Errori di targeting
  • Richiedi UUID
  • molti altri

L'analisi delle API è progettata per acquisire una vasta gamma di dati per l'utilizzo da parte di diversi team. Ad esempio:

  • Il team operativo può utilizzare i dati di Analytics per identificare i periodi di traffico elevato o ridotto in modo da poter fare lo scale up o lo scale down dei servizi per soddisfare la domanda in continuo cambiamento.
  • Il team di marketing può utilizzare i dati di Analytics per determinare i modelli 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 delle richieste.