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 di ingresso nell'infrastruttura Apigee, ad esempio un bilanciatore del carico delle applicazioni esterno o un gateway Anthos, per aiutarti a risolvere i problemi relativi alle chiamate dell'API Apigee.

È importante notare che se questa funzionalità è attivata per una o più istanze Apigee, ti verrà addebitato il costo dei log inviati al tuo progetto. Per ulteriori informazioni sugli addebiti di Google Cloud per il logging, consulta Prezzi di Cloud Logging.

Questo argomento descrive in che modo 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 ruolo e delle autorizzazioni seguenti:

  • 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 Principale, trova 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 dei ruoli include i ruoli 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 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.

Attiva il logging degli accessi in ingresso per le istanze Apigee

Puoi attivare il logging degli accessi in entrata di Cloud Logging quando crei o modifichi un'istanza Apigee utilizzando l'interfaccia utente di Apigee nella console Cloud 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. Se vuoi, seleziona un codice di risposta HTTP dalla casella codice di risposta per utilizzarlo come 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 filter.

Una volta creata o aggiornata l'istanza, i log di accesso in entrata per l'istanza dovrebbero essere disponibili nel progetto entro 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 progetto Google Cloud sia selezionato.
  3. Dalla scheda Query, inserisci il nome del log nel campo dell'editor di 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 relativi ai log di accesso in entrata

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

  • Creare 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 inclusi nelle voci di log. Per scoprire di più su come creare query e analizzare i dati in Esplora log, consulta 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 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 procedimenti dettagliati, consulta Creare un criterio di avviso basato su log utilizzando Esplora log.

  • Filtro in base ai codici di stato HTTP

    Puoi perfezionare le query in Esplora log per filtrarle 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

  • Filtro 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 connettività che impedisce al client di ricevere una risposta dal server.

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

Disattivare 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 di ingress_instance nel progetto verrà disattivato e la fatturazione verrà interrotta.

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

Apigee nella console Cloud

Per disattivare la funzionalità utilizzando la console Apigee in Cloud:

  • Apri la UI di Apigee nella console Cloud nel browser.
  • Seleziona Gestione > Istanze.
  • Fai clic sull'istanza da 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 disattivare 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.