Generare log di accesso di Apigee

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

Visualizza la documentazione di Apigee Edge.

I clienti con abbonamento Apigee e con pagamento a consumo possono attivare i log di accesso in entrata di Cloud Logging per ogni istanza Apigee nella loro organizzazione. Una volta attivata, questa funzionalità ti consente di visualizzare i log generati dai gateway in entrata nella tua infrastruttura Apigee, ad esempio un bilanciatore del carico delle applicazioni esterno o un gateway Anthos, per facilitare la risoluzione dei problemi relativi alle chiamate API Apigee.

È importante notare che se questa funzionalità è abilitata per una o più istanze Apigee, ti verranno addebitati i costi per i log inviati al tuo progetto. Per saperne di più sui Google Cloud costi per la registrazione, consulta Prezzi di Cloud Logging.

Questo argomento descrive come i clienti Apigee possono attivare e utilizzare i log di accesso in entrata di Cloud Logging per le istanze Apigee nella loro organizzazione.

Prima di iniziare

Per attivare la funzionalità, devi disporre del seguente ruolo e delle seguenti autorizzazioni:

  • Ruoli: amministratore organizzazione Apigee (roles/apigee.admin)
  • Autorizzazioni:
    • apigee.instances.create
    • apigee.instances.update

Controlla i ruoli

  1. Nella console Google Cloud , vai alla pagina IAM.

    Vai a IAM
  2. Seleziona il progetto.
  3. Nella colonna Entità, trova la riga contenente il tuo indirizzo email.

    Se il tuo indirizzo email non è presente in questa colonna, non hai ruoli.

  4. Nella colonna Ruolo della riga con il tuo indirizzo email, controlla se l'elenco dei ruoli include quelli richiesti.

Concedere i ruoli

  1. Nella console Google Cloud , vai alla pagina IAM.

    Vai a IAM
  2. Seleziona il progetto.
  3. Fai clic su Concedi l'accesso.
  4. Nel campo Nuove entità, inserisci il tuo indirizzo email.
  5. Nell'elenco Seleziona un ruolo, seleziona un ruolo.
  6. Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni ruolo aggiuntivo.
  7. Fai clic su Salva.

Abilita il logging degli accessi in entrata per le tue istanze Apigee

Puoi abilitare la registrazione dell'accesso in entrata di Cloud Logging quando crei o modifichi un'istanza Apigee utilizzando la UI Apigee in Google Cloud Console o l'API.

Per attivare la funzionalità durante la creazione o l'aggiornamento di un'istanza Apigee, segui le istruzioni riportate in Gestione delle istanze per iniziare a creare o modificare un'istanza.

Apigee nella console Cloud

Nella sezione Logging della pagina Crea un'istanza o Modifica istanza:

  1. Fai clic sul pulsante di attivazione/disattivazione Abilita il logging per attivare la funzionalità.
  2. (Facoltativo) Seleziona un codice di risposta HTTP dalla casella Codice di risposta per fungere da filtro per i log di accesso.

    Se vuoi includere tutti i log, indipendentemente dal codice di risposta HTTP, seleziona None (all HTTP responses).

    Per creare un filtro personalizzato, seleziona Custom e inserisci il filtro nel seguente formato:

    status_code > XX && status code <= YY

    Ad esempio:

    status_code >= 500 && status_code < 504

  3. Dopo aver fornito tutte le informazioni necessarie per creare o modificare l'istanza, fai clic su Salva.

API Apigee

Per aggiornare un'istanza esistente utilizzando l'API Apigee, utilizza il seguente comando:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
          "enabled": "true",
          "filter": "status_code >= 0 && status_code < 600 "
        }
      }'

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • INSTANCE_NAME è il nome dell'istanza Apigee che vuoi modificare.

Tieni presente che in questo comando, il valore specificato per la proprietà filter restituirà tutti i log. Se vuoi filtrare i log in base a HTTP o ad altri codici di stato, puoi modificare il valore di filter.

Una volta creata o aggiornata correttamente l'istanza, i log di accesso in entrata per l'istanza dovrebbero essere disponibili nel progetto in pochi minuti.

Visualizza i log di accesso in entrata

Una volta attivata la funzionalità, puoi visualizzare i log di accesso in entrata per le istanze del tuo progetto in pochi minuti utilizzando Esplora log nella console Google Cloud .

Per visualizzare le voci di log in Esplora log:

  1. Nella console Google Cloud , seleziona Logging > Esplora log.

    Vai a Esplora log

  2. Assicurati che il tuo progetto Google Cloud sia selezionato.
  3. Nella scheda Query, inserisci il nome del log nel campo dell'editor Query utilizzando uno dei seguenti metodi:
    • Per utilizzare la casella di selezione Nome log:
      1. Fai clic sulla casella di selezione Nome log per aprire il riquadro Nome log.
      2. Inserisci ingress_instance nella casella Seleziona nomi log.
      3. Fai clic su Applica.
      4. Il nome del log viene visualizzato nel campo dell'editor Query.
    • Nel campo dell'editor Query, inserisci direttamente il nome del log:

      logName="projects/ORG_NAME/logs/apigee.googleapis.com/ingress_instance"

  4. Crea il resto della query nel campo dell'editor Query. I log verranno visualizzati nell'elenco Risultati query.
  5. Fai clic su una voce di log per visualizzare ulteriori dettagli.

Risoluzione dei problemi con i log degli accessi in entrata

Una volta attivata la funzionalità e resi disponibili i log in Esplora log, puoi sfruttare una serie di funzionalità di Cloud Logging per facilitare la risoluzione dei problemi, tra cui:

  • Creazione di query utilizzando il linguaggio di query di Cloud Logging

    Puoi recuperare e analizzare i log quando utilizzi Esplora log scrivendo query nel campo dell'editor di query e selezionando le opzioni dei menu dei filtri incluse nelle voci di log. Per saperne di più sulla creazione di query e sull'analisi dei dati in Esplora log, vedi Creare e salvare query utilizzando il linguaggio di query di Cloud Logging.

  • Abilitazione di metriche e avvisi basati su log

    Puoi definire una metrica basata su log personalizzata per acquisire informazioni specifiche per le tue istanze Apigee. Per ulteriori informazioni, consulta la panoramica delle metriche basate su log.

    Puoi creare un criterio di avviso basato su log da Esplora log. Per ulteriori informazioni e passaggi dettagliati, vedi Creazione di un criterio di avviso basato su log utilizzando Esplora log.

  • Filtrare per codici di stato HTTP

    Puoi perfezionare le query in Esplora log per filtrare in base ai codici di stato HTTP, anche se non hai scelto di filtrare i log di accesso in entrata in base al codice di stato HTTP quando hai attivato la funzionalità. Per aggiungere questo filtro alla query, utilizza il seguente formato:

    status_code > XX && status code <= YY

    Ad esempio:

    status_code >= 500 && status_code < 504

  • Filtrare in base ai codici di stato di ingresso

    Oltre a filtrare in base ai codici di stato HTTP, puoi creare una query per filtrare in base a ingress status_code 0. Questo codice indica spesso un problema di rete o di connettività che impedisce al client di ricevere una risposta dal server.

Per una spiegazione dettagliata di tutte le funzionalità disponibili in Esplora log, vedi Visualizzare i log utilizzando Esplora log.

Disattiva la funzionalità

Una volta completata la risoluzione dei problemi dell'istanza Apigee, puoi modificarla per disattivare la funzionalità. Se disattivi la funzionalità, l'accesso ai log ingress_instance nel tuo progetto verrà disattivato e la fatturazione interrotta.

Puoi modificare l'istanza per disattivare la funzionalità utilizzando la UI Apigee nella console Google Cloud o l'API.

Apigee nella console Cloud

Per disattivare la funzionalità utilizzando Apigee nella console Cloud:

  1. Nella console Google Cloud , vai alla pagina Gestione > Istanze.

    Vai a Istanze

  2. Fai clic sull'istanza che vuoi modificare.
  3. Nella pagina Dettagli istanza, fai clic su Modifica.
  4. Nella pagina Modifica istanza, fai clic sul pulsante di attivazione/disattivazione Abilita logging per disattivare la funzionalità.
  5. Fai clic su Salva.

API Apigee

Utilizza il seguente comando per disattivare la funzionalità nella tua istanza:

curl "https://apigee.googleapis.com/v1/organizations/ORG_NAME/instances/INSTANCE_NAME?updateMask=access_logging_config.enabled,access_logging_config.filter" \
    -X PATCH -H "Authorization: Bearer $TOKEN" \
    -H 'Accept: application/json' -H 'Content-Type: application/json' \
    -d '{
      "name": "INSTANCE_NAME",
      "accessLoggingConfig":
        {
            "enabled": "false"
        }
        }'

Dove:

  • ORG_NAME è il nome della tua organizzazione Apigee.
  • INSTANCE_NAME è il nome dell'istanza Apigee che vuoi modificare.