Logging dei log di accesso ad Apigee

Questa pagina riguarda Apigee, ma non Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

I clienti con abbonamento Apigee e pagamento a consumo possono abilitare i log di accesso in entrata di Cloud Logging per ogni istanza Apigee della propria organizzazione. Una volta abilitata, questa funzionalità 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 delle chiamate API Apigee.

È importante notare che se questa funzionalità è abilitata per una o più istanze Apigee, ti verranno addebitati i log inviati al tuo progetto. Per saperne di più sugli addebiti di Google Cloud per il logging, consulta i prezzi di Cloud Logging.

Questo argomento descrive in che modo i clienti Apigee possono abilitare e utilizzare i log di accesso in entrata di Cloud Logging per le istanze Apigee della loro organizzazione.

Prima di iniziare

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

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

Verificare i ruoli

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

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

    Se il tuo indirizzo email non è presente in questa colonna, significa che non disponi di alcun ruolo.

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

Concedi 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 ciascun ruolo aggiuntivo.
  7. Fai clic su Salva.

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

Puoi abilitare il logging degli accessi in entrata di Cloud Logging quando crei o modifichi un'istanza Apigee utilizzando la UI di Apigee nella console Cloud o l'API.

Per abilitare la funzionalità durante la creazione o l'aggiornamento di un'istanza Apigee, segui le istruzioni 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 abilitare la funzionalità.
  2. Facoltativamente, seleziona un codice di risposta HTTP dalla casella Codice di risposta per agire 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, usa 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 altri codici di stato, puoi modificare il valore filter.

Dopo aver creato o aggiornato l'istanza, i relativi log di accesso in entrata dovrebbero essere disponibili nel progetto in pochi minuti.

Visualizza i log di accesso in entrata

Una volta abilitata la funzionalità, puoi visualizzare i log di accesso in entrata per le istanze nel 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 delle query.
  5. Fai clic su una voce di log per maggiori dettagli.

Risoluzione dei problemi relativi ai log di accesso in entrata

Dopo aver abilitato la funzionalità e aver reso disponibili i log in Esplora log, puoi utilizzare 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

    Per recuperare e analizzare i log quando utilizzi Esplora log, scrivi query nel campo dell'editor query e seleziona le opzioni del menu di filtro incluse nelle voci di log. Per scoprire di più sulla creazione di query e sull'analisi dei dati in Esplora log, consulta Creare e salvare query utilizzando il linguaggio di query di Cloud Logging.

  • Attivazione delle metriche e degli avvisi basati su log

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

    Puoi creare un criterio di avviso basato su log da Esplora log. Per ulteriori informazioni e i passaggi dettagliati, consulta 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 in modo da filtrare in base ai codici di stato HTTP, anche se hai scelto di non filtrare i log di accesso in entrata in base al codice di stato HTTP quando hai abilitato la funzionalità. Per aggiungere questo filtro alla query, utilizza il formato seguente:

    status_code > XX && status code <= YY

    Ad esempio:

    status_code >= 500 && status_code < 504

  • Filtrare per codici di stato in entrata

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

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

Disattiva la funzionalità

Al termine della risoluzione dei problemi relativi all'istanza Apigee, puoi modificare l'istanza per disabilitare la funzionalità. La disabilitazione della funzionalità disattiverà l'accesso ai log di ingress_instance nel tuo progetto e interromperà la fatturazione.

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

Apigee nella console Cloud

Per disabilitare la funzionalità utilizzando Apigee nella console Cloud:

  • Apri l'UI di Apigee nella console Cloud nel tuo browser.
  • Seleziona Gestione > Istanze.
  • Fai clic sull'istanza che vuoi modificare.
  • Nella pagina Dettagli istanza, fai clic su Modifica.
  • Nella pagina Modifica istanza, fai clic sul pulsante di attivazione/disattivazione Abilita il logging per disattivare la funzionalità.
  • Fai clic su Salva.
  • API Apigee

    Utilizza il comando seguente per disabilitare la funzionalità nell'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.