Gestire il componente aggiuntivo Apigee API Analytics

Questa pagina si applica a Apigee, ma non a Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

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 nell'interfaccia utente di Apigee oppure scaricare i dati non elaborati per l'analisi offline utilizzando le API Apigee. Per saperne di più sui tipi di dati che puoi raccogliere e analizzare con Apigee API Analytics, consulta la panoramica di Apigee Analytics.

Se sei un cliente Apigee con pagamento a consumo, Apigee API Analytics è disponibile come componente aggiuntivo pagato. Questo argomento descrive come abilitare e gestire l'analisi dell'API Apigee per gli ambienti idonei con pagamento a consumo. Per ulteriori informazioni sull'utilizzo dell'analisi dell'API Apigee dopo l'abilitazione del componente aggiuntivo nei tuoi ambienti Apigee, vedi Utilizzo delle dashboard di analisi.

Disponibilità

Apigee API Analytics è disponibile come funzionalità aggiuntiva a pagamento gestita per ogni ambiente Apigee nell'implementazione di Apigee. Il componente aggiuntivo può essere attivato in qualsiasi ambiente Apigee Intermedio o Completo. Non puoi abilitare e utilizzare Analisi delle API Apigee in ambienti Base. Per maggiori dettagli sulle funzionalità degli ambienti Apigee, consulta Confronto dei tipi di ambiente.

Ruoli e autorizzazioni richiesti

Per ottenere le autorizzazioni necessarie per gestire il componente aggiuntivo Apigee API Analytics, chiedi all'amministratore di concederti il ruolo IAM Amministratore dell'ambiente Apigee (apigee.environment.admin) nel progetto. Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

Questo ruolo predefinito contiene le autorizzazioni necessarie per gestire il componente aggiuntivo di analisi dell'API Apigee. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:

Autorizzazioni obbligatorie

Per gestire il componente aggiuntivo Apigee API Analytics sono necessarie le seguenti autorizzazioni:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

Potresti anche riuscire a ottenere queste autorizzazioni con ruoli personalizzati altri ruoli predefiniti.

Attiva il componente aggiuntivo Apigee API Analytics

Puoi abilitare il componente aggiuntivo Analisi delle API Apigee per il livello Intermedio o Completo tramite la UI di Apigee nella console Google Cloud o l'API, come descritto nelle sezioni seguenti.

Apigee nella console Google Cloud

Per attivare il componente aggiuntivo Analytics dell'API Apigee nella console Google Cloud:

  1. Apri la pagina Apigee nella console.

    Vai ad Apigee

  2. Seleziona il progetto con l'organizzazione e gli ambienti con pagamento a consumo che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina Componente aggiuntivo Analytics.
  4. Nel riquadro Gestisci il componente aggiuntivo Apigee API Analytics, seleziona la casella di controllo per l'ambiente o gli ambienti in cui vuoi attivare il componente aggiuntivo.
  5. Fai clic su Attiva elementi selezionati.
  6. Al termine dell'attivazione per gli ambienti selezionati, lo stato dell'ambiente mostrerà Attivato.
  7. Per visualizzare i dati di analisi dell'API Apigee, seleziona Analytics > Metriche API per visualizzare i tuoi dati di analisi. La visualizzazione dei dati di analisi potrebbe richiedere fino a 10 minuti.

API Apigee

Per abilitare il componente aggiuntivo di analisi dell'API Apigee utilizzando l'API Apigee, inserisci seguente comando:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

Dove:

  • ORG_NAME è il nome dell'organizzazione Apigee Pay-as-you-go in cui vuoi aggiungere Analytics agli ambienti idonei.
  • ENV_NAME è il nome dell'ambiente Apigee in cui vuoi attivare il componente aggiuntivo Apigee API Analytics.

Al termine dell'attivazione, seleziona Analytics > Metriche API per visualizzare i dati di Analytics dell'API Apigee. Potrebbero essere necessari fino a 10 minuti prima che i dati di analisi vengano visualizzati nell'interfaccia utente o siano disponibili tramite una chiamata API.

La procedura di abilitazione del componente aggiuntivo Apigee API Analytics può richiedere fino a 15 minuti. Una volta attivata, la conservazione dei dati di analisi per l'ambiente viene applicata per 14 mesi. Puoi accedere ai dati storici dell'ambiente dal Metriche API nella console purché il componente aggiuntivo sia abilitato.

La fatturazione per l'utilizzo del componente aggiuntivo Analytics dell'API Apigee inizia una volta avviata l'abilitazione del componente aggiuntivo.

Disabilita il componente aggiuntivo Analytics API Apigee

Puoi disattivare il componente aggiuntivo Apigee API Analytics per un ambiente Apigee Intermedio o Completo utilizzando la UI di Apigee nella console Google Cloud o l'API, come descritto nelle sezioni seguenti.

Se il componente aggiuntivo Advanced API Security è abilitato nell'ambiente, devi disabilitare il componente aggiuntivo il componente aggiuntivo Advanced API Security prima di poter disabilitare il componente aggiuntivo Apigee API Analytics. Se il componente aggiuntivo Advanced API Security non è disattivato, qualsiasi richiesta di disattivazione di Apigee API Analytics nell'ambiente non andrà a buon fine. Se il componente aggiuntivo Advanced API Security è abilitato nel tuo ambiente, viene visualizzato nella colonna Altri componenti aggiuntivi abilitati del riquadro Gestisci il componente aggiuntivo Apigee API Analytics.

Per disattivare il componente aggiuntivo, vedi Disattivare il componente aggiuntivo Advanced API Security.

Apigee nella console Cloud

Per disabilitare il componente aggiuntivo di analisi delle API Apigee nella console Google Cloud:

  1. Apri la pagina Apigee nella console.

    Vai ad Apigee

  2. Seleziona il progetto con l'organizzazione e gli ambienti con pagamento a consumo che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina Componente aggiuntivo Analytics.
  4. Nel riquadro Gestisci il componente aggiuntivo Apigee API Analytics, seleziona la casella di controllo per l'ambiente o gli ambienti in cui vuoi disattivare il componente aggiuntivo.
  5. Fai clic su Disattiva selezionati.
  6. Al termine della disattivazione, in Stato viene visualizzato Disattivato per ogni ambiente.

API Apigee

Per disattivare il componente aggiuntivo Apigee API Analytics utilizzando l'API Apigee, inserisci il seguente comando:

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

Dove:

  • ORG_NAME è il nome dell'organizzazione Apigee Pay-as-you-go in cui vuoi aggiungere Analytics agli ambienti idonei.
  • ENV_NAME è il nome dell'ambiente Apigee in cui vuoi attivare il componente aggiuntivo Apigee API Analytics.

Visualizzare lo stato del componente aggiuntivo Apigee API Analytics in un ambiente

Puoi controllare lo stato del componente aggiuntivo Apigee API Analytics per una piattaforma Apigee intermedia o completa utilizzando la UI di Apigee nella console Google Cloud o l'API, come descritto nelle sezioni seguenti.

Apigee nella console Google Cloud

Per visualizzare lo stato del componente aggiuntivo Apigee API Analytics in un ambiente utilizzando la console Google Cloud:

  1. Apri la pagina Apigee nella console.

    Vai ad Apigee

  2. Seleziona il progetto con l'organizzazione e gli ambienti Pay-as-you-go che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina del componente aggiuntivo Analytics.
  4. Nel riquadro Gestisci il componente aggiuntivo di analisi dell'API Apigee, viene visualizzato un elenco di ambienti.
  5. Nella colonna Stato, puoi vedere se il componente aggiuntivo è Attivato o Disattivato in ogni ambiente Intermedio o Completo. Gli ambienti di base non mostrano nessuno stato.

API Apigee

Per visualizzare lo stato del componente aggiuntivo Apigee API Analytics in un ambiente che utilizza l'API Apigee, inserisci il seguente comando:

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" 

Dove:

  • ORG_NAME è il nome dell'organizzazione Apigee con pagamento a consumo.
  • ENV_NAME è il nome dell'ambiente Apigee.

La risposta restituisce un oggetto analyticsConfig che rappresenta lo stato attuale del componente aggiuntivo.

Gestire i dati di Apigee API Analytics

Una volta abilitato il componente aggiuntivo di analisi dell'API Apigee per un ambiente, i dati di analisi per viene conservato 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 disabiliti il componente aggiuntivo di analisi delle API Apigee in un ambiente, 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. 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 oltre il periodo di conservazione di 14 mesi, ti consigliamo di: esportando e salvando i dati in un'altra posizione. Ti consigliamo inoltre di esportare i dati di Analytics prima di disattivare il componente aggiuntivo Apigee API Analytics o entro il periodo di 30 giorni successivo alla disattivazione. Per ulteriori informazioni, consulta Esportare i dati da Analytics.