Gestire il componente aggiuntivo di analisi delle API Apigee

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

Visualizza 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 nella UI di Apigee oppure puoi scaricare i dati non elaborati per l'analisi offline con le API Apigee. Per ulteriori informazioni sui tipi di dati che puoi raccogliere e analizzare con l'analisi delle API Apigee, consulta la panoramica di Apigee Analytics.

Se sei un cliente Apigee con pagamento a consumo, l'analisi delle API Apigee è disponibile come un come componente aggiuntivo. 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à

L'analisi delle API Apigee è disponibile come funzionalità aggiuntiva a pagamento gestita per ogni ambiente Apigee nella tua implementazione Apigee. Il componente aggiuntivo può essere Abilitati in qualsiasi ambiente Apigee intermedio o completo. Non puoi abilitare e utilizzare Analisi delle API Apigee in ambienti Base. Per maggiori dettagli sulle funzionalità dell'ambiente Apigee, consulta la sezione Confronto dei tipi di ambiente.

Ruoli e autorizzazioni richiesti

Per ottenere le autorizzazioni necessarie per gestire il componente aggiuntivo di analisi dell'API Apigee, chiedi all'amministratore di concederti Amministratore ambienti Apigee (apigee.environment.admin) ruolo IAM 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 vedere le autorizzazioni esatte obbligatorie, espandi la sezione Autorizzazioni obbligatorie:

Autorizzazioni obbligatorie

Per gestire il componente aggiuntivo di analisi dell'API Apigee sono necessarie le seguenti autorizzazioni:

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

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

Abilita il componente aggiuntivo Analisi delle API Apigee

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 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 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 di analisi dell'API Apigee, seleziona la casella di controllo l'ambiente (o gli ambienti) in cui vuoi abilitare il componente aggiuntivo.
  5. Fai clic su Attiva selezionate.
  6. Una volta completata l'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 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 con pagamento a consumo in 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 nella UI o siano disponibili tramite una chiamata API.

Il processo di abilitazione del componente aggiuntivo di analisi delle API Apigee può richiedere fino a 15 minuti. Una volta attivata la funzionalità, e i dati di analisi per l'ambiente vengono conservati 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 disabilitare il 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.

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 Advanced API Security il componente aggiuntivo non è disabilitato, qualsiasi richiesta di disabilitazione dell'analisi delle API Apigee nell'ambiente avrà esito negativo. Se nel tuo ambiente è abilitato il componente aggiuntivo Advanced API Security, verrà visualizzato Colonna Altri componenti aggiuntivi abilitati del riquadro Gestisci il componente aggiuntivo di analisi dell'API Apigee.

Per disattivare il componente aggiuntivo, vedi Disattiva 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 di analisi dell'API Apigee, seleziona la casella di controllo l'ambiente (o gli ambienti) in cui vuoi disabilitare il componente aggiuntivo.
  5. Fai clic su Disattiva selezionate.
  6. Al termine della disattivazione, verrà visualizzato lo Stato Disabilitato per ogni ambiente.

API Apigee

Per disabilitare il componente aggiuntivo Analytics 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":false}'

Dove:

  • ORG_NAME è il nome dell'organizzazione Apigee con pagamento a consumo in 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 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 di analisi dell'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 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 di analisi dell'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 per ogni ambiente intermedio o completo. Gli ambienti di base non mostrano nessuno stato.

API Apigee

Per visualizzare lo stato del componente aggiuntivo di analisi dell'API Apigee in un ambiente utilizzando l'API Apigee, inserisci 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.

Gestisci i tuoi dati di analisi dell'API Apigee

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 dalle Metriche API nella console, purché il componente aggiuntivo sia abilitato.

Se disabiliti il componente aggiuntivo di analisi dell'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 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.