Gestisci il componente aggiuntivo di analisi delle API Apigee

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

Visualizza la documentazione di Apigee Edge.

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. Per ulteriori informazioni sui tipi di dati che puoi raccogliere e analizzare con l'analisi delle API Apigee, consulta la panoramica sull'analisi di Apigee.

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

Disponibilità

L'analisi delle API Apigee è disponibile come funzionalità aggiuntiva a pagamento che viene gestita per ogni ambiente Apigee nell'implementazione Apigee. Il componente aggiuntivo può essere abilitato in qualsiasi ambiente Apigee intermedio o completo. Non puoi abilitare e utilizzare l'analisi delle API Apigee in ambienti di base. Per maggiori dettagli sulle funzionalità dell'ambiente Apigee, consulta il confronto dei tipi di ambiente.

Autorizzazioni e ruoli richiesti

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

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

Autorizzazioni obbligatorie

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

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

Potresti anche essere in grado di ottenere queste autorizzazioni con i ruoli personalizzati o altri ruoli predefiniti.

Abilita il componente aggiuntivo di analisi delle API Apigee

Puoi abilitare il componente aggiuntivo per l'analisi delle API Apigee per un ambiente Apigee intermedio o completo utilizzando l'interfaccia utente di Apigee nella console Google Cloud o utilizzando l'API, come descritto nelle sezioni seguenti.

Apigee nella console Google Cloud

Per abilitare 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 con pagamento a consumo e gli ambienti che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina Componenti aggiuntivi di Analytics.
  4. Nel riquadro Gestisci componente aggiuntivo di analisi delle API Apigee, seleziona la casella di controllo per l'ambiente (o gli ambienti) in cui vuoi abilitare il componente aggiuntivo.
  5. Fai clic su Attiva selezione.
  6. Al termine dell'abilitazione per gli ambienti selezionati, lo Stato dell'ambiente mostrerà Abilitato.
  7. Per visualizzare i dati di analisi dell'API Apigee, seleziona Analytics > Metriche API per visualizzare i dati di analisi. La visualizzazione dei dati di analisi potrebbe richiedere fino a 10 minuti.

API Apigee

Per abilitare il componente aggiuntivo di analisi delle API Apigee 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":true}'

Dove:

  • ORG_NAME è il nome dell'organizzazione di pagamento a consumo Apigee a cui vuoi aggiungere Analytics agli ambienti idonei.
  • ENV_NAME è il nome dell'ambiente Apigee in cui vuoi abilitare il componente aggiuntivo di analisi delle API Apigee.

Una volta completata l'abilitazione, seleziona Analytics > Metriche API per visualizzare i dati di analisi 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.

Il processo di abilitazione del componente aggiuntivo per l'analisi delle API Apigee può richiedere fino a 15 minuti. Una volta abilitati, i dati di analisi per l'ambiente vengono conservati per 14 mesi. Puoi accedere ai dati storici dell'ambiente dalla pagina Metriche API della console purché il componente aggiuntivo sia abilitato.

La fatturazione per l'utilizzo del componente aggiuntivo di analisi delle API Apigee inizia una volta avviata l'abilitazione del componente aggiuntivo.

Disabilita il componente aggiuntivo Analisi delle API Apigee

Puoi disabilitare il componente aggiuntivo per l'analisi delle API Apigee per un ambiente Apigee intermedio o completo utilizzando l'interfaccia utente di Apigee nella console Google Cloud o utilizzando l'API, come descritto nelle sezioni seguenti.

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

Per disabilitare il componente aggiuntivo, vedi Disabilitare 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 con pagamento a consumo e gli ambienti che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina Componenti aggiuntivi di Analytics.
  4. Nel riquadro Gestisci componente aggiuntivo di analisi delle API Apigee, seleziona la casella di controllo per l'ambiente (o gli ambienti) in cui vuoi disabilitare il componente aggiuntivo.
  5. Fai clic su Disattiva elementi selezionati.
  6. Al termine della disattivazione, lo stato mostrerà Disabilitato per ogni ambiente.

API Apigee

Per disabilitare il componente aggiuntivo di analisi dell'API Apigee 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 di pagamento a consumo Apigee a cui vuoi aggiungere Analytics agli ambienti idonei.
  • ENV_NAME è il nome dell'ambiente Apigee in cui vuoi abilitare il componente aggiuntivo di analisi delle API Apigee.

Visualizza lo stato del componente aggiuntivo di analisi delle API Apigee in un ambiente

Puoi verificare lo stato del componente aggiuntivo per l'analisi delle API Apigee per un ambiente Apigee intermedio o completo utilizzando l'interfaccia utente di Apigee nella console Google Cloud o utilizzando l'API, come descritto nelle sezioni seguenti.

Apigee nella console Google Cloud

Per visualizzare lo stato del componente aggiuntivo di analisi delle API Apigee 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 con pagamento a consumo e gli ambienti che vuoi gestire.
  3. Seleziona Componenti aggiuntivi > Analytics per aprire la pagina Componenti aggiuntivi di Analytics.
  4. Nel riquadro Gestisci componente aggiuntivo di analisi delle API Apigee, viene visualizzato un elenco di ambienti.
  5. Nella colonna dello stato puoi vedere se il componente aggiuntivo è impostato su 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 di Apigee API Analytics in un ambiente utilizzando l'API Apigee, inserisci questo 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 analisi delle API Apigee

Una volta abilitato il componente aggiuntivo di analisi delle API Apigee 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 in un ambiente, 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 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.