Questa pagina si applica a Apigee e Apigee ibrido.
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 la tua API con l'analisi
L'analisi delle API Apigee raccoglie e calcola un'infinità di informazioni che fluiscono attraverso i proxy API. Puoi visualizzare questi dati con grafici e diagrammi nella UI di Apigee oppure puoi scaricare i dati non elaborati per l'analisi offline utilizzando le API Apigee.
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?
- Qual è il tempo di risposta più rapido dell'API? Più lento?
- A livello geografico, 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 ti aiutano a 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, l'analisi delle API Apigee aiuta il tuo team API a migliorare le API e 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 sapere come sta andando il programma API nel suo complesso, come vanno le singole API e come migliorarle.
- Sviluppatori di app. Se condividi informazioni di analisi con gli sviluppatori di app, ricevi app migliori. Questi sviluppatori stanno innovando con la tua API e creando app per le creatività che ti aiuteranno ad aumentare le entrate della tua azienda. Analytics aiuta gli sviluppatori di app a sapere come stanno andando le loro app e in che misura 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 pattern di traffico e prevedere quando aggiungere risorse di backend o apportare altre modifiche critiche.
- Proprietario dell'attività: il proprietario dell'attività vuole sapere come sta rendendo l'investimento nell'API e sapere dove investire in questo ambito in futuro.
Come faccio a 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 dell'API Apigee. Se non sai con certezza se 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 in abbonamento
Se sei un cliente con abbonamento Apigee, l'accesso alle 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 in abbonamento utilizzando la UI di Apigee, la UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, consulta Come faccio ad accedere ai miei dati di analisi.
Usa l'analisi delle API Apigee con un'organizzazione con pagamento a consumo
Se sei un cliente con Pay-as-you-go, devi abilitare 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 Apigee API Analytics per i tuoi ambienti Apigee intermedi o completi, consulta Gestire il componente aggiuntivo di analisi delle API Apigee.
Una volta abilitato il componente aggiuntivo di analisi delle API Apigee nei tuoi ambienti, puoi accedere ai dati di analisi e gestire il componente aggiuntivo di analisi dell'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 fluisce attraverso proxy API come:
- Data/ora della risposta
- Latenza di richiesta
- Dimensioni richiesta
- Errori di targeting
- Nome del prodotto API
- Indirizzo email dello sviluppatore o ID AppGroup
- Nome dell'app
- Entrate da transazioni
Per un elenco completo dei dati raccolti da API Analytics, consulta Riferimento alle metriche, alle dimensioni e ai filtri di Analytics.
Come si raccolgono i dati di analisi personalizzati?
Apigee raccoglie in modo nativo una vasta gamma di dati. Potresti anche voler raccogliere dati di analisi personalizzati per proxy API, app, prodotti o sviluppatori. Ad esempio, potresti voler raccogliere dati di analisi da parametri di ricerca, intestazioni delle richieste, corpi di richieste e risposte o variabili che definisci nelle tue API.
Puoi raccogliere dati di analisi personalizzati con il criterio DataCapture e poi utilizzare la UI o l'API 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 dati: dopo aver effettuato 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à delle analisi: il periodo di tempo durante il quale i dati di analisi (inclusi i dati di monetizzazione e Sense, se applicabili) 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 durante l'utilizzo del componente aggiuntivo di analisi dell'API Apigee
Se hai un'organizzazione con pagamento a consumo, puoi abilitare il componente aggiuntivo di analisi dell'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 storici dell'ambiente dalla pagina Metriche API nella console purché il componente aggiuntivo sia abilitato.
Se disabiliti il componente aggiuntivo di analisi dell'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 recuperare l'accesso ai dati di analisi per l'ambiente fino al periodo di conservazione di 14 mesi. Se il componente aggiuntivo viene riattivato per l'ambiente dopo 30 giorni, i dati non vengono ripristinati.
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 anche di esportare i dati di Analytics prima di disabilitare il componente aggiuntivo di analisi dell'API Apigee o entro la finestra di 30 giorni dopo la disattivazione. Per ulteriori informazioni, consulta Esportazione dei dati da Analytics.
Dove vengono archiviati ed elaborati i miei dati di analisi?
La posizione in cui vengono archiviati ed elaborati i tuoi dati di analisi è determinato dalla regione di analisi, che hai specificato al momento dell'installazione di Apigee:
- Se sei un cliente in abbonamento e hai installato Apigee utilizzando la procedura guidata di provisioning di Apigee, hai specificato la regione di analisi nel passaggio 1 Creare un'organizzazione, quando hai impostato 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 Creare un'organizzazione, quando imposti la regione di hosting di Analytics.
- Se hai installato Apigee dalla riga di comando come cliente in abbonamento o 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 nel seguente modo:
- Per le regioni di analisi al di fuori degli Stati Uniti o dell'UE, i dati di analisi vengono archiviati ed elaborati nella regione di analisi.
- 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 faccio ad accedere ai miei dati di analisi?
L'analisi delle API Apigee fornisce strumenti di visualizzazione dei dati integrati nella UI di Apigee. Questi strumenti includono dashboard di analisi predefinite e report personalizzati che mostrano i dati in grafici e diagrammi e consentono di visualizzare i dati raggruppati in diverse dimensioni (ad esempio per proxy API, indirizzo IP o codice di stato HTTP).
Puoi anche scaricare i dati di analisi utilizzando l'API Apigee. Dopo averli 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 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 dei target
Per saperne di più, consulta Utilizzare le dashboard di analisi.
Versione classica di Apigee
Per aprire le dashboard di Analytics (solo per le organizzazioni che richiedono un abbonamento):
- Apri l'UI di Apigee in un browser.
- Seleziona Analizza > Metriche API.
- Seleziona una delle seguenti dashboard:
Oltre a questi, puoi utilizzare anche le seguenti dashboard:
- In Analizza > Sviluppatori:
- In Analizza > Utenti finali:
Per saperne di più, consulta Utilizzare le 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 qualsiasi dato di analisi integrato in Apigee.
Quando crei un report personalizzato, puoi selezionare i dati da visualizzare (metriche), raggrupparli in modo significativo (dimensioni) e, facoltativamente, limitare i dati restituiti in base a caratteristiche specifiche dei dati (applicazione di 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 Creazione e gestione dei report personalizzati.
API Analytics
Utilizzare 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.
Di seguito è riportato 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"
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 spazio con codifica URL prima di HH:MM o un carattere +, ad esempio:
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. 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 ulteriori informazioni, consulta Esportazione di dati da Analytics.
Come faccio a condividere i dati con gli sviluppatori di app?
Quando pensi agli sviluppatori di app come ai tuoi clienti, devi assicurarti che abbiano a disposizione gli strumenti e le informazioni per sfruttare al meglio la tua API.
Gli sviluppatori di app non sono solo preoccupati della qualità delle loro app, ma sono 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 offre agli sviluppatori informazioni su:
- Errori. Quali errori relativi all'API vengono rilevati dalla mia app?
- Prestazioni: l'API è lenta? Quali metodi dell'API sono in genere lenti o lenti al momento?
- Disponibilità: l'API è attiva o non attiva?
- Quota: la tua API prevede una quota? In qualità di sviluppatore di app, qual è il mio rendimento rispetto alla quota?
Per maggiori informazioni, vedi Monitorare le app nella documentazione di Drupal 8.
Inoltre, puoi condividere dati e analisi con i tuoi sviluppatori nei seguenti modi:
- Creare report personalizzati e condividerli con gli sviluppatori di app. Per saperne di più, consulta Creazione e gestione dei report personalizzati.
- Utilizzo delle API delle metriche per acquisire dati per un periodo di tempo più ampio da condividere offline con gli sviluppatori di app. Per ulteriori informazioni, consulta Utilizzare l'API Metrics.
Come faccio a generare dati analitici completi?
Che cosa si intende per analisi completa? Puoi, ad esempio, creare un proxy API e Apigee raccoglierà dati di analisi su quel proxy. E per quanto riguarda le metriche per lo sviluppatore o l'app che ha chiamato il 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 individuare gli sviluppatori e le app degli sviluppatori che 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. Consulta la sezione Registrazione degli sviluppatori di app.
- Registrazione di app e gestione delle chiavi API per gli sviluppatori. Consulta Registrare app e gestire 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: criterioVerifyAPIKey, criterio OAuthV2 e criterioVerifyJWT.
I seguenti tutorial ti guidano nei passaggi necessari che ti consentono di visualizzare le analisi per sviluppatori e app: Proteggi un'API richiedendo chiavi API e Proteggi un'API con OAuth.
Ulteriori informazioni
- Utilizzare le dashboard di analisi
- Creazione e gestione di report personalizzati
- Utilizzare l'API Metrics