Questa pagina è stata tradotta dall'API Cloud Translation.

Panoramica sull'analisi delle API

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Questo argomento introduce l'analisi API Edge.

Video: guarda un breve video per una panoramica dei servizi di analisi delle API Edge.

Migliorare l'API tramite l'analisi

Edge API Analytics raccoglie e calcola una vasta gamma di informazioni che passano attraverso i proxy API. Puoi visualizzare questi dati con grafici e diagrammi nella UI di Edge oppure puoi scaricare i dati non elaborati per l'analisi offline con le API di gestione perimetrale.

Analytics ti aiuta a rispondere a domande comuni, ad esempio:

Qual è l'andamento del mio traffico API nel tempo?
Quali sono i metodi API più popolari?
Chi sono i miei sviluppatori principali?
Quando è più rapido il tempo di risposta dell'API? Più lento?
A livello geografico, dove riscontro il maggior traffico API?

Le risposte a domande come queste ti aiutano a migliorare le API, risolvere problemi e decisioni aziendali relative al programma API.

L'analisi delle API aiuta tutti a migliorare

Attraverso un processo continuo di raccolta, analisi e visualizzazione dei dati, Edge API Analytics aiuta il team dedicato all'API migliora le API e aiuta gli sviluppatori di app a migliorare le proprie app:

Team API - Il team API sta sfruttando i sistemi interni per creare API interessanti. Il team dedicato alle API vuole conoscere l'andamento complessivo del programma API, delle singole API e su come migliorare le API.
Sviluppatori di app: condividendo le informazioni di analisi con gli sviluppatori di app, puoi ottenere app migliori. Questi sviluppatori innovano con la tua API e creano app creative che contribuiscono ad aumentare le entrate della tua azienda. Analytics aiuta gli sviluppatori di app a sapere qual è il rendimento delle loro app e quanto sono che contribuiscono ai profitti della tua azienda. Gli sviluppatori di app vogliono sapere come possono migliorare le loro app.
Team operativo: il team operativo vuole comprendere i modelli di traffico e prevedere quando aggiungere risorse di backend o apportare altre modifiche critiche.
Proprietario dell'attività: il proprietario dell'attività vuole capire se il suo investimento in API sta dando i risultati sperati e dove investire in API in futuro.

Che tipo di dati vengono raccolti e analizzati?

L'analisi delle API Edge raccoglie e analizza un ampio spettro di dati che passa attraverso proxy API come:

Data/ora della risposta
Latenza di richiesta
Dimensioni richiesta
Errori di targeting
Nome del prodotto API
Indirizzo email dello sviluppatore
Nome dell'app
Molti altri

Per un elenco completo dei dati raccolti da API Analytics, consulta Riferimento a metriche, dimensioni e filtri di Analytics.

Come si raccolgono i dati di analisi personalizzati?

Edge raccoglie in modo nativo una vasta gamma di dati. Puoi anche raccogliere dati di analisi personalizzati specifici ai proxy API, alle app, ai prodotti o agli sviluppatori. Ad esempio, potresti voler raccogliere dati di analisi da parametri di ricerca, intestazioni delle richieste, corpi di richieste e risposte o variabili definite nelle API.

Puoi raccogliere dati analitici personalizzati utilizzando il criterio StatisticsCollector. Una volta estratti i dati personalizzati, puoi esaminare i dati utilizzando la UI o l'API di Analytics. Consulta Analizzare i contenuti dei messaggi dell'API utilizzando l'analisi personalizzata per un esempio completo che mostra come raccogliere i dati di analisi personalizzati.

Differenze tra i dati di Analytics e i dati di API Monitoring

Questa sezione descrive alcune differenze minime tra i dati raccolti Analisi perimetrale e monitoraggio delle API. Poiché il monitoraggio delle API e Analytics utilizzano pipeline di dati, potresti notare lievi differenze tra i report personalizzati generati da Monitoring e i report generati Analisi. Ad esempio, potresti vedere discrepanze nei risultati segnalati per errori di timeout (entrambi i timeout del backend) (codice di stato HTTP 504 nella richiesta) e timeout del client (codice di stato HTTP 499). Questi possono essere visualizzati con il codice di stato 200 nei report personalizzati di Analytics, ma verrà visualizzata con il codice di stato 504 o 499 nei report personalizzati di Monitoring.

Quando e per quanto tempo saranno disponibili i miei dati di analisi?

Esistono due intervalli di tempo che controllano quando e per quanto tempo puoi visualizzare i tuoi dati di analisi:

Intervallo di ritardo dei dati: dopo una chiamata a un proxy API, possono essere necessarie fino a 10 minuti affinché i dati siano accessibili per la visualizzazione o tramite chiamate API di gestione.
Conservazione dei dati: il periodo di tempo in cui i dati di analisi vengono conservati da Edge varia in base al piano. A seconda del piano sottoscritto, i dati di analisi potrebbero essere disponibili per gli ultimi 30, 60, 90 o 365 giorni.

Come faccio ad accedere ai miei dati di analisi?

L'analisi delle API Edge fornisce strumenti di visualizzazione dei dati integrati nell'interfaccia utente di Edge. Questi strumenti includono dashboard di analisi predefinite e report personalizzati che mostrano i dati in grafici e tabelle visualizzare in dettaglio i dati raggruppati in diverse dimensioni (ad esempio per proxy API, indirizzo IP o codice di stato HTTP).

Inoltre, puoi scaricare i dati di analisi utilizzando l'API Edge Management. Al termine del download, puoi importare questi dati nel tuo sistema di analisi o nei tuoi strumenti di visualizzazione dei dati.

Dashboard di analisi

La UI Edge fornisce un insieme di dashboard predefinite che puoi utilizzare per visualizzare i dati di analisi. Ad esempio, le seguenti immagini mostrano la dashboard Proxy Performance (Prestazioni proxy):

Questa dashboard include grafici per:

Traffico totale: il numero totale di richieste API ricevute da Edge per un ambiente API in un'organizzazione.
Risultato traffico: il numero totale di richieste che hanno generato una risposta positiva. Le risposte di errore non vengono conteggiate.
Errori di traffico: il numero totale di tutte le richieste API non riuscite. cioè la richiesta non restituisce una risposta. Il numero include entrambi gli errori proxy (lato Apigee) ed errori di destinazione (i servizi di backend).
TPS medio: il numero medio di richieste API e risposte risultanti al secondo.

Altre dashboard predefinite includono:

Per saperne di più su queste dashboard predefinite, consulta Utilizzo delle dashboard di analisi.

Report personalizzati

I report personalizzati ti consentono di visualizzare in dettaglio metriche API specifiche e visualizzare i dati esatti che ti interessano. Puoi creare un report personalizzato utilizzando uno qualsiasi dei dati di analisi integrati in Edge o un'analisi personalizzata Dati raccolti dal criterio StatisticsCollector.

Quando crei un report personalizzato, selezioni i dati che vuoi visualizzare (metriche), raggruppi i dati in modi significativi (dimensioni) e, facoltativamente, limiti i dati restituiti in base a caratteristiche specifiche dei dati (filtri).

Puoi anche impostare il tipo di grafico visualizzato nel report personalizzato come grafico a colonne o a linee. Le seguenti immagini mostrano esempi di grafici per le transazioni al secondo raggruppate per proxy API:

Colonna: ogni proxy API è rappresentato da una colonna diversa:
Riga: ogni proxy API è rappresentato da una riga diversa:

Per saperne di più, consulta Creare e gestire i report personalizzati.

API Analytics

Usa l'API di gestione perimetrale per scaricare i dati di analisi. Ad esempio, puoi utilizzare l'API per creare i tuoi strumenti di visualizzazione da incorporare in portali o app personalizzate.

Ecco un esempio di chiamata API per recuperare i dati di analisi per i proxy API:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

Questa chiamata restituisce:

La somma delle richieste (conteggio dei messaggi) per proxy API
Per un periodo di 24 ore.
Raggruppati per ora

Il parametro di query timeRange specifica il periodo di tempo nel formato:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Osserva %20 prima di HH:MM. Il parametro timeRange richiede un carattere dello spazio codificato nell'URL prima di HH:MM o un carattere +, ad esempio: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Per ulteriori informazioni, vedi Utilizza le API delle metriche per misurare le prestazioni del programma API.

Esportare i dati di analisi in Google Cloud

Puoi utilizzare l'API di gestione di Edge per esportare tutti i dati di analisi di un'intera giornata da Edge nel tuo repository di dati, ad esempio Google Cloud Storage o BigQuery. Puoi quindi sfruttare le potenti funzionalità di query e machine learning offerte da Google Cloud BigQuery e TensorFlow per eseguire la tua analisi dei dati.

Per saperne di più, vedi Esportare i dati da Dati e analisi.

Quando pensi agli sviluppatori di app come ai tuoi clienti, è opportuno assicurarsi che dispongano degli strumenti e le informazioni a loro disposizione per sfruttare al meglio l'API.

Gli sviluppatori di app non sono solo preoccupati della qualità delle loro app, ma sono molto interessati alle tue API. I portali per gli sviluppatori basati su Drupal include una pagina facoltativa Prestazioni app progettata per consentire agli sviluppatori di app di accedere a: metriche importanti per le sue app. Questa pagina fornisce agli sviluppatori informazioni su:

Errori. Quali errori relativi all'API vengono rilevati dalla mia app?
Prestazioni: l'API è lenta in questo momento? Quali metodi API sono in genere lenti o lento al momento?
Disponibilità: l'API funziona o non funziona al momento?
Quota: la tua API prevede una quota? In qualità di sviluppatore di app, come sto andando rispetto alla quota?

Per ulteriori informazioni, vedi:

Drupal 7: Visualizzazione di dati e analisi per l'utilizzo dell'app
Drupal 8: Monitorare le app
Portale integrato: non disponibile

Inoltre, puoi condividere i dati e le analisi con i tuoi sviluppatori:

Creare report personalizzati e condividerli con gli sviluppatori di app. Per ulteriori informazioni, consulta Creare report personalizzati.
Utilizzo dell'API Edge Management per acquisire dati in un periodo di tempo più ampio da condividere con l'app gli sviluppatori offline. Per ulteriori informazioni, vedi Utilizza le API delle metriche per misurare le prestazioni del programma API.

Come faccio a generare dati analitici completi?

Che cosa intendiamo per analisi complete? Ad esempio, puoi creare un proxy API e Edge raccogliere dati di analisi su quel proxy. E le metriche per lo sviluppatore o l'app che ha chiamato il proxy API? Se Edge non sa chi ha effettuato una chiamata API, non può raccogliere questi dati.

Sono necessari alcuni passaggi per permettere a Edge di individuare gli sviluppatori e le app degli sviluppatori per chiamare i proxy API. Di seguito è riportato un elenco di questi passaggi con link a informazioni più dettagliate:

Crea uno o più prodotti API, ovvero un raggruppamento di proxy API insieme a un piano di servizio. Consulta Gestire i prodotti API.
Registra gli sviluppatori di app su Edge. Vedi Registra gli sviluppatori di app.
Registra app e genera chiavi API per i tuoi sviluppatori. Consulta Registra le app e gestisci le chiavi API.
Aggiungi criteri di sicurezza ai proxy API per verificare le chiavi API e/o i token di sicurezza. Consulta i seguenti argomenti:Verifica del criterio chiave API, Criterio OAuthV2 e Verifica del criterio JWT.
Se utilizzi Edge Microgateway, assicurati di aver attivato il plug-in di analisi (che è attivo per impostazione predefinita). Se il plug-in di analisi è disattivato, Edge Microgateway non invierà i dati di analisi a Edge Analytics.

I tutorial seguenti ti guidano attraverso i passaggi necessari che ti consentono di visualizzare dati e analisi per sviluppatori e app: proteggere un'API richiedendo chiavi API e Proteggere un'API con OAuth.

Confronta l'analisi delle API con il monitoraggio delle API

Puoi sfruttare i vantaggi offerti dal monitoraggio delle API di Edge e analisi delle API. Il monitoraggio delle API esamina i dati di analisi per fornire approfondimenti contestuali in tempo reale sul rendimento delle API, consentendoti di diagnosticare rapidamente i problemi e facilitare le azioni correttive per la continuità aziendale. Il monitoraggio delle API è progettato per trovare rapidamente i punti critici nelle API e nei backend. L'API Analytics è progettata per acquisire una vasta gamma di dati di analisi per l'utilizzo da parte di diversi team ma i dati vengono generalmente utilizzati per l'analisi in scenari non in tempo reale.

Una delle principali differenze tra il monitoraggio delle API e l'analisi delle API è il meccanismo di avviso integrato nel monitoraggio delle API. Con gli avvisi, puoi specificare un codice di stato HTTP (2xx/4xx/5xx), una latenza o una soglia per i codici di errore che, se superata, attiva una notifica di avviso per il tuo team operativo. Le notifiche di avviso possono Essere inviate tramite diversi canali, come email, Slack, cercapersone o webhook, consentendoti di rispondere immediatamente ai problemi.

Consulta Confronta il monitoraggio delle API con Edge API Analytics per un confronto più dettagliato tra questi servizi.