Panoramica dell'analisi delle API Apigee

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Questo argomento introduce l'analisi delle API Apigee.

Nota: l'analisi dell'API Apigee non è supportata in Apigee organizzazioni ibride in cui è abilitata la residente dei dati.

Video: guarda un breve video per una panoramica dei servizi di Apigee API Analytics.

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 con le API Apigee.

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

• Quali sono le tendenze del mio traffico API nel tempo?
• Quali metodi API sono più utilizzati?
• Chi sono i miei sviluppatori principali?
• Qual è il tempo di risposta più rapido dell'API? Il più lento?
• A livello geografico, dove riscontro il maggior traffico API?
• Quante entrate hanno generato le tue transazioni?

Puoi analizzare i dati relativi a un nome host specifico o a un intero ambiente.

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, Apigee 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 API vuole sapere come sta andando il programma API nel complesso, come stanno andando le singole API e come migliorare le API.
• Sviluppatori di app: condividendo informazioni di analisi con gli sviluppatori di app, per offrirti app migliori. Questi sviluppatori stanno innovando con la tua API e creando app creative che ti aiutano a generare per aumentare le entrate della tua azienda. Analytics aiuta gli sviluppatori di app a conoscere il rendimento delle loro app e il loro contributo al profitto della tua azienda. Gli sviluppatori di app vogliono sapere come migliorare le loro app.
• Team operativo: il team operativo vuole comprendere i modelli di traffico e anticipare quando aggiungere risorse di backend o apportare altri aggiustamenti critici.
• Proprietario dell'attività: il proprietario dell'attività vuole scoprire in che modo Gli investimenti nelle API stanno dando i loro frutti e dove investire dollari in queste API 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 se utilizzi un'organizzazione Apigee con abbonamento o con pagamento a consumo, contatta l'amministratore dell'organizzazione Apigee.

Nota: l'analisi dell'API Apigee non è supportata nelle organizzazioni ibride Apigee con la residenza dei dati abilitata.

Usa l'analisi delle API Apigee con un'organizzazione in abbonamento

Se sei un cliente in abbonamento Apigee, l'accesso ad analisi delle API Apigee inclusi nei tuoi diritti di abbonamento e abilitati automaticamente per ciascuno dei tuoi ambienti Apigee.

Puoi accedere ai dati di analisi per la tua organizzazione di abbonamento utilizzando l'interfaccia utente di Apigee, l'interfaccia utente di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere? i miei dati di analisi.

Usa l'analisi delle API Apigee con un'organizzazione con pagamento a consumo

Se sei un cliente Pay-as-you-go, devi attivare l'API Apigee Analytics 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 le tue applicazioni Apigee intermedie o complete ambienti, consulta Gestire il componente aggiuntivo di analisi delle API Apigee.

Una volta abilitato il componente aggiuntivo di analisi dell'API Apigee nei tuoi ambienti, potrai accedere i tuoi dati di analisi e gestire il componente aggiuntivo di analisi delle API Apigee utilizzando la UI di Apigee nella console Cloud o l'API Apigee. Per maggiori dettagli, vedi Come faccio ad accedere? i miei dati di analisi. La gestione dei dati e dei componenti aggiuntivi di analisi non è disponibile nella UI classica di Apigee per le organizzazioni con pagamento a consumo.

Quali tipi di dati vengono raccolti e analizzati?

Apigee API Analytics raccoglie e analizza un ampio spettro di dati che vengono trasmessi tramite i proxy API, ad esempio:

• Data/ora della risposta
• Latenza di richiesta
• Dimensioni richiesta
• Errori del target
• Nome del prodotto API
• Indirizzo email dello sviluppatore o ID AppGroup
• Nome app
• Entrate da transazioni

Per un elenco completo dei dati raccolti dall'API Analytics, consulta la sezione Riferimento per metriche, dimensioni e filtri di analisi.

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 specifici per i proxy API, le app, i prodotti o gli 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 di analisi personalizzati con il criterio DataCapture, quindi utilizzare l'API o l'interfaccia utente di Analytics 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 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.
• Disponibilità di Analytics: il periodo di tempo in cui 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.

Nota: i limiti per il periodo di tempo durante il quale vengono resi disponibili i dati di analisi non sono in modo forzato su alcune versioni di Apigee. Tuttavia, Apigee si riserva il diritto di applicare questi limiti in qualsiasi momento. contatta l'assistenza o il tuo rappresentante se hai bisogno di una riduzione della durata della disponibilità dell'analisi.

Mantenimento di Analytics quando si utilizza il componente aggiuntivo Apigee API Analytics

Se hai un'organizzazione con pagamento a consumo, puoi attivare il componente aggiuntivo Apigee API Analytics a livello di ambiente. Una volta attivato 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, a condizione che il componente aggiuntivo sia abilitato.

Se disattivi il componente aggiuntivo Apigee API Analytics 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 entro 30 giorni dalla disattivazione, puoi recuperare l'accesso ai dati di analisi per l'ambiente durante il periodo di conservazione di 14 mesi. Nessun dato viene ripristinato se il componente aggiuntivo viene riattivato per l'ambiente dopo 30 giorni.

Se vuoi conservare i dati di analisi per qualsiasi ambiente in 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 inoltre di esportare i dati di Analytics prima di disattivare componente aggiuntivo di analisi delle API Apigee o entro la finestra di 30 giorni dopo la disabilitazione. Per ulteriori informazioni, vedi Esportazione dei 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 analisi che hai specificato durante l'installazione di Apigee:

• Se sei un cliente con abbonamento e hai installato Apigee utilizzando la procedura guidata di provisioning di Apigee, hai specificato la regione di analisi nel passaggio 1 di Crea 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 terzo passaggio di Crea un'organizzazione, quando hai impostato la regione di hosting di Analytics.
• Se hai installato Apigee dalla riga di comando come cliente con abbonamento 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 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 Analytics.
• Per le regioni di analisi negli Stati Uniti o nell'UE, i dati vengono archiviati rispettivamente nelle regioni con più regioni degli Stati Uniti o dell'UE per una maggiore disponibilità.

Come faccio ad accedere ai miei dati di analisi?

Apigee API Analytics fornisce strumenti di visualizzazione dei dati integrati nell'interfaccia utente di Apigee. 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).

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

Dashboard di analisi

L'interfaccia utente di Apigee fornisce un insieme di dashboard predefinite che puoi utilizzare per visualizzare i dati di analisi.

Nota: è disponibile una nuova versione della UI di Apigee, integrata con la console Google Cloud. La nuova UI è chiamata Apigee nella console Cloud. La le istruzioni nelle prime due schede spiegano come utilizzare Apigee nella console Cloud o nella versione classica di Apigee.

Apigee nella console Cloud

Per aprire le dashboard di Analytics (per le organizzazioni con pagamento a consumo o con abbonamento):

1. Apri l'UI di Apigee nella console Cloud in un browser.
2. Seleziona Analytics > Metriche API.

L'immagine seguente mostra la dashboard Rendimento dei proxy API:

Seleziona una delle seguenti schede per visualizzare le dashboard:

• Prestazioni dei proxy API
• Analisi dei codici di errore
• Analisi della latenza
• Prestazioni della cache
• Rendimento target

Per ulteriori informazioni, vedi Utilizzare le dashboard di Dati.

Versione classica di Apigee

Per aprire le dashboard di Analytics (solo per le organizzazioni che richiedono un abbonamento):

1. Apri l'UI di Apigee in un browser.
2. Seleziona Analizza > Metriche delle API.
3. Seleziona una delle seguenti dashboard:
• Prestazioni del proxy
• Prestazioni della cache
• Analisi dei codici di errore
• Analisi della latenza
• Rendimento target

Oltre a queste, puoi utilizzare anche le seguenti dashboard:

• In Analizza > Sviluppatori:
  • Coinvolgimento degli sviluppatori
  • Composizione del traffico
• In Analisi > Utenti finali:
  • Utilizzo del dispositivo
  • GeoMap

Per ulteriori informazioni, vedi Utilizzare le dashboard di Dati.

Report personalizzati

I report personalizzati ti consentono di visualizzare in dettaglio metriche API specifiche e di 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, 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 Creazione e gestione dei report personalizzati.

API Analytics

Utilizzare l'API Apigee 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://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

Nota il %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 saperne di più, consulta Utilizzare l'API delle metriche.

Esportare i dati di analisi nella piattaforma Google Cloud

Puoi utilizzare l'API Apigee per esportare tutti i dati di analisi per un'intera giornata da Apigee 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ù, consulta Esportare i 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 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. 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 sue app. Questa pagina fornisce agli sviluppatori informazioni su:

• Errori. Quali errori relativi all'API vengono rilevati dalla mia app?
• Prestazioni: l'API è lenta? Quali metodi API sono in genere lenti o lento adesso?
• Disponibilità: l'API è attiva o meno?
• Quota: la tua API prevede una quota? E come sviluppatore di app, come sto rispetto alla quota?

Per ulteriori informazioni, vedi Monitora le app nella documentazione di Drupal 8.

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

• Creare report personalizzati e condividerli con gli sviluppatori di app. Per saperne di più, consulta Creazione e gestione dei report personalizzati.
• Utilizzo delle API di misurazione per acquisire i dati su un periodo di tempo più ampio da condividere con gli sviluppatori di app offline. Per saperne di più, consulta Utilizzare l'API delle metriche.

Come faccio a generare dati di analisi completi?

Che cosa si intende per analisi completa? Ad esempio, puoi creare un proxy API e Apigee raccogliere dati di analisi su quel proxy. E 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 per chiamare i proxy API. Di seguito è riportato un elenco di questi passaggi con link a informazioni più dettagliate:

1. Crea uno o più prodotti API, ovvero un raggruppamento di proxy API insieme a un piano di servizio. Consulta Gestire i prodotti API.
2. Registrazione degli sviluppatori di app con Apigee. Consulta la sezione Registrazione degli sviluppatori di app.
3. Registrazione delle app e gestione delle chiavi API per i tuoi sviluppatori. Consulta l'articolo Registrare app e gestire le chiavi API.
4. Aggiungi criteri di sicurezza ai proxy API per verificare le chiavi API e/o i token di sicurezza. Consulta i seguenti argomenti: Norme relative a VerifyAPIKey, Norme relative a OAuthV2 e Norme relative a VerifyJWT.

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

Ulteriori informazioni

• Utilizzare le dashboard di analisi
• Creare e gestire report personalizzati
• Utilizzare l'API delle metriche