Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Questo argomento introduce l'analisi delle API Apigee.
Video: guarda un breve video per una panoramica dei servizi di analisi delle API Apigee.
Migliora l'API con l'analisi
L'analisi delle API Apigee raccoglie e calcola un'ampia gamma di informazioni che passano attraverso i proxy API. Puoi visualizzare questi dati con grafici e diagrammi nell'interfaccia utente di Apigee oppure puoi scaricare i dati non elaborati per l'analisi offline utilizzando le API Apigee.
Analytics consente di rispondere a domande comuni, ad esempio:
- Qual è l'andamento del traffico API nel tempo?
- Quali sono i metodi dell'API più popolari?
- Chi sono i miei migliori sviluppatori?
- Quando è più veloce il tempo di risposta dell'API? Più lenta?
- Geograficamente, dove vedo la maggior parte del traffico API?
- Quante entrate hanno generato le tue transazioni?
Puoi analizzare i dati per un nome host specifico o per un intero ambiente.
Le risposte a domande come queste consentono di migliorare le API, risolvere problemi e prendere decisioni aziendali migliori relative al tuo programma API.
L'analisi delle API aiuta tutti a migliorare
Attraverso un processo continuo di raccolta, analisi e visualizzazione dei dati, Apigee API Analytics aiuta il tuo team API a migliorare le proprie API e gli sviluppatori di app a migliorare le loro app:
- Team API: il team API sta attingendo ai sistemi interni per creare API interessanti. Il team API vuole sapere come sta andando complessivamente il programma API, come stanno andando le singole API e come migliorarne.
- Sviluppatori di app. Condividendo le informazioni di analisi con gli sviluppatori di app, ottieni app migliori. Questi sviluppatori stanno innovando con la tua API e creando app creative che aiutano a generare entrate per la tua azienda. L'analisi aiuta gli sviluppatori di app a sapere come stanno andando le loro app e quanto contribuiscono ai profitti della tua azienda. Gli sviluppatori vogliono sapere come migliorare le proprie app.
- Team operativo: il team operativo vuole comprendere i pattern di traffico e prevedere quando aggiungere risorse di backend o apportare altre modifiche fondamentali.
- Proprietario dell'attività: il proprietario dell'attività vuole sapere come sta generando il suo investimento nelle API e dove investire in futuro per le API.
Come posso iniziare a utilizzare l'analisi delle API Apigee?
Il tipo di organizzazione Apigee che utilizzi determinerà i passaggi necessari per iniziare a utilizzare l'analisi delle API Apigee. Se non hai la certezza che stai utilizzando un'organizzazione Apigee con abbonamento o pagamento a consumo, contatta l'amministratore della tua organizzazione Apigee.
Usa l'analisi delle API Apigee con un'organizzazione Subscription
Se sei un cliente Apigee Subscription, l'accesso all'analisi delle API Apigee è incluso nei diritti di abbonamento e abilitato automaticamente per ciascuno dei tuoi ambienti Apigee.
Puoi accedere ai dati di analisi per la tua organizzazione di abbonamento utilizzando l'UI di Apigee, l'UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, consulta Come faccio ad accedere ai miei dati di analisi.
Utilizza l'analisi delle API Apigee con un'organizzazione con pagamento a consumo
Se sei un cliente con Pay-as-you-go, devi abilitare l'analisi delle API Apigee come componente aggiuntivo a pagamento per iniziare a utilizzare i dati di analisi. Per ulteriori informazioni sull'abilitazione del componente aggiuntivo per l'analisi delle API Apigee per gli ambienti Apigee intermedi o completi, consulta Gestire il componente aggiuntivo per l'analisi delle API Apigee.
Dopo aver abilitato il componente aggiuntivo per l'analisi delle API Apigee nei tuoi ambienti, puoi accedere ai dati di analisi e gestire il componente aggiuntivo per l'analisi delle API Apigee utilizzando la UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, consulta Come faccio ad accedere ai miei dati di analisi. La gestione dei componenti aggiuntivi e dei dati di analisi non è disponibile nella UI classica di Apigee per le organizzazioni con pagamento a consumo.
Che tipo di dati vengono raccolti e analizzati?
L'analisi delle API Apigee raccoglie e analizza un ampio spettro di dati che passano attraverso i proxy API, ad esempio:
- Data/ora della risposta
- Latenza di richiesta
- Dimensioni richiesta
- Errori target
- Nome del prodotto API
- Indirizzo email dello sviluppatore
- Nome dell'app
- Entrate da transazioni
Per un elenco completo dei dati raccolti da Analisi dell'API, consulta l'articolo Riferimento per metriche, dimensioni e filtri di Analytics.
Come si raccolgono i dati di analisi personalizzati?
Apigee raccoglie in modo nativo un'ampia gamma di dati, Potresti anche voler raccogliere dati analitici personalizzati specifici per proxy API, app, prodotti o sviluppatori. Ad esempio, potresti voler raccogliere i dati di analisi da parametri di ricerca, intestazioni delle richieste, corpi di richieste e risposte o variabili da te definite nelle API.
Puoi raccogliere dati di analisi personalizzati con il criterio DataCapture e poi utilizzare l'API o la UI di analisi per esaminare i dati raccolti.
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 dati di analisi:
- Intervallo di ritardo dei dati: dopo che viene effettuata una chiamata a un proxy API, potrebbero essere necessari fino a 10 minuti prima che i dati siano accessibili per la visualizzazione o tramite chiamate API.
- Disponibilità di Analytics: il periodo di tempo in cui i dati di analisi (che includono i dati di monetizzazione e Sense, se applicabile) vengono resi disponibili da Apigee varia in base al piano. A seconda del piano sottoscritto, i dati di analisi potrebbero essere disponibili per gli ultimi 30 giorni, 90 giorni o 14 mesi.
Conservazione dei dati quando utilizzi il componente aggiuntivo di analisi delle API Apigee
Se hai un'organizzazione con pagamento a consumo, puoi abilitare il componente aggiuntivo di analisi delle API Apigee a livello di ambiente. Una volta abilitato il componente aggiuntivo per un ambiente, i dati di analisi per l'ambiente vengono conservati per 14 mesi. Puoi accedere ai dati di analisi cronologici dell'ambiente dalla pagina Metriche API della console purché il componente aggiuntivo sia abilitato.
Se disabiliti il componente aggiuntivo di analisi delle API Apigee per un ambiente in un'organizzazione con pagamento a consumo, i dati di analisi per l'ambiente vengono eliminati dopo 30 giorni. Se riattivi il componente aggiuntivo nello stesso ambiente entro 30 giorni dalla disattivazione, puoi riottenere l'accesso ai dati di analisi per l'ambiente per il periodo di conservazione di 14 mesi. I dati non vengono ripristinati se il componente aggiuntivo viene riattivato per l'ambiente dopo 30 giorni.
Se vuoi conservare i dati di analisi per qualsiasi ambiente di un'organizzazione con pagamento a consumo oltre il periodo di conservazione di 14 mesi, ti consigliamo di esportare e salvare i dati in un'altra posizione. Ti consigliamo di esportare i dati di Analytics anche prima di disabilitare il componente aggiuntivo di analisi dell'API Apigee o entro i 30 giorni successivi alla disattivazione. Per saperne di più, consulta Esportare i dati da Analytics.
Dove vengono archiviati ed elaborati i miei dati di analisi?
La posizione in cui vengono archiviati ed elaborati i dati di analisi è determinata dalla regione di Analytics, specificata al momento dell'installazione di Apigee:
- Se sei un cliente Subscription e hai installato Apigee utilizzando la procedura guidata di provisioning di Apigee, hai specificato la regione di analisi nel passaggio 1 Crea un'organizzazione, quando imposti la regione di hosting di Analytics.
- Se sei un cliente con pagamento a consumo e hai installato Apigee utilizzando la console Google Cloud, hai specificato la regione di analisi nel passaggio 3 Crea un'organizzazione, quando imposti la regione di hosting di Analytics.
- Se hai installato Apigee dalla riga di comando come cliente Subscription o con pagamento a consumo, hai specificato la regione di analisi quando hai definito la variabile di ambiente
ANALYTICS_REGION.
I dati di Analytics vengono archiviati ed elaborati come segue:
- Per le regioni di Analytics non negli Stati Uniti o nell'UE, i dati di analisi vengono archiviati ed elaborati nella regione di Analytics.
- Per le regioni di analisi negli Stati Uniti o nell'UE, i dati vengono archiviati rispettivamente in più regioni degli Stati Uniti o dell'UE, per una maggiore disponibilità.
Come si accede ai dati di analisi?
L'analisi delle API Apigee fornisce strumenti di visualizzazione dei dati integrati nell'interfaccia utente di Apigee. Questi strumenti includono dashboard di analisi predefinite e report personalizzati che visualizzano i dati in grafici e diagrammi e ti consentono di visualizzare i dati raggruppati in dimensioni diverse (ad esempio per proxy API, indirizzo IP o codice di stato HTTP).
Puoi anche scaricare i dati di analisi utilizzando l'API Apigee. Una volta scaricati, puoi importare i dati nei tuoi strumenti di visualizzazione dei dati o nel tuo sistema di analisi.
Dashboard di analisi
La UI di Apigee fornisce un insieme di dashboard predefinite che puoi utilizzare per visualizzare i dati di analisi.
Apigee nella console Cloud
Per aprire le dashboard di Analytics (per le organizzazioni con pagamento a consumo o con abbonamento):
- Apri l'UI di Apigee nella console Cloud in un browser.
- Seleziona Analytics > Metriche API.
Seleziona una delle seguenti schede per visualizzare le dashboard:
- Prestazioni del proxy API
- Analisi del codice di errore
- Analisi della latenza
- Prestazioni della cache
- Rendimento target
Per ulteriori informazioni, consulta Utilizzo delle dashboard di analisi.
Versione classica di Apigee
Per aprire le dashboard di Analytics (solo per organizzazioni con abbonamento):
- Apri l'UI di Apigee in un browser.
- Seleziona Analizza > Metriche API.
- Seleziona una delle seguenti dashboard:
Oltre a queste, puoi utilizzare anche le seguenti dashboard:
- In Analizza > Sviluppatori:
- In Analizza > Utenti finali:
Per ulteriori informazioni, consulta Utilizzo delle dashboard di analisi.
Report personalizzati
I report personalizzati ti consentono di visualizzare in dettaglio metriche API specifiche e di vedere solo i dati che ti interessano. Puoi creare un report personalizzato utilizzando uno qualsiasi dei dati di analisi integrati in Apigee.
Quando crei un report personalizzato, devi selezionare i dati da visualizzare (metriche), raggruppare i dati in modi significativi (dimensioni) e, facoltativamente, limitare 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 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 Creazione e gestione dei report personalizzati.
API Analytics
Utilizza l'API Apigee per scaricare i dati di analisi. Ad esempio, puoi usare l'API per creare strumenti di visualizzazione personalizzati 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://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \ -H "Authorization: Bearer $TOKEN"
La chiamata restituisce:
- La somma delle richieste (conteggio di 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 il %20 prima di HH:MM. Il parametro timeRange richiede uno spazio con codifica URL prima di HH:MM o un carattere +, come in: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.
Per saperne di più, consulta Utilizzare l'API Metrics.
Esporta i dati di analisi nella Google Cloud Platform
Puoi utilizzare l'API Apigee per esportare tutti i dati di analisi per un'intera giornata da Apigee al tuo repository di dati, ad esempio Google Cloud Storage o BigQuery. Potrai quindi sfruttare le potenti funzionalità di query e machine learning offerte da Google Cloud BigQuery e TensorFlow per eseguire l'analisi dei tuoi dati.
Per saperne di più, consulta Esportazione dei dati da Analytics.
Come faccio a condividere i dati con gli sviluppatori di app?
Quando pensi agli sviluppatori di app come tuoi clienti, dovrai assicurarti che abbiano a disposizione gli strumenti e le informazioni per utilizzare al meglio l'API.
Gli sviluppatori di app non sono solo preoccupati per la qualità delle loro app, ma sono anche molto interessati alle tue API. Il portale per gli sviluppatori basato su Drupal include una pagina facoltativa Prestazioni app progettata per consentire agli sviluppatori di app di accedere a metriche importanti per le loro app. Questa pagina fornisce agli sviluppatori informazioni su:
- Errori:quali errori dell'API vengono rilevati dalla mia app?
- Prestazioni:l'API è lenta? Quali metodi dell'API sono generalmente lenti o lenti al momento?
- Disponibilità:l'API è attiva o non disponibile?
- Quota:la tua API ha una quota? In qualità di sviluppatore di app, qual è il mio rendimento rispetto alla quota?
Per maggiori informazioni, consulta la sezione relativa al monitoraggio delle app nella documentazione di Drupal 8.
Inoltre, puoi condividere dati e analisi con i tuoi sviluppatori nei seguenti modi:
- Creazione di report personalizzati e condivisione con gli sviluppatori di app. Per saperne di più, consulta Creazione e gestione dei report personalizzati.
- Usare le API delle metriche per acquisire dati in un periodo di tempo più ampio da condividere con gli sviluppatori di app offline. Per saperne di più, consulta Utilizzare l'API Metrics.
Come posso generare dati di analisi completi?
Che cosa intendiamo per analisi completa? Ad esempio, puoi creare un proxy API e Apigee raccoglierà i dati di analisi relativi a questo proxy. E per quanto riguarda le metriche per lo sviluppatore o l'app che ha chiamato proxy API? Se Apigee non sa chi ha effettuato una chiamata API, non può raccogliere questi dati.
Sono necessari alcuni passaggi per consentire ad Apigee di capire quali sviluppatori e quali app per sviluppatori chiamano i tuoi 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 basati su API.
- Registrazione degli sviluppatori di app con Apigee. Vedi Registrazione degli sviluppatori di app.
- Registrazione di app e gestione delle chiavi API per gli sviluppatori. Vedi Registrare le app e gestire le chiavi API.
- Aggiungi criteri di sicurezza ai proxy API che verificano le chiavi API e/o i token di sicurezza. Consulta i seguenti argomenti: criterio VerificationAPIKey, Criterio OAuthV2 e Criterio VerificationJWT.
I seguenti tutorial illustrano i passaggi necessari per visualizzare dati e analisi per sviluppatori e app: Proteggere un'API richiedendo chiavi API e Proteggere un'API con OAuth.
Ulteriori informazioni
- Utilizzo delle dashboard di analisi
- Creazione e gestione di report personalizzati
- Utilizzo dell'API Metrics