Logging dei log degli accessi di Apigee

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

Visualizza la documentazione di Apigee Edge.

I clienti Apigee e con pagamento a consumo possono abilitare i log degli accessi in entrata di Cloud Logging per ciascuna istanza Apigee nella 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 aiutarti a risolvere i problemi delle chiamate API Apigee.

È importante notare che se questa funzionalità è abilitata per una o più delle tue istanze Apigee, ti verranno addebitati i costi per i log spediti al tuo progetto. Per ulteriori informazioni 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 degli accessi in entrata di Cloud Logging per le istanze Apigee nella propria organizzazione.

Prima di iniziare

Per abilitare 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 Entità, individua la riga contenente il tuo indirizzo email.

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

  4. Nella colonna Ruolo per la riga con il tuo indirizzo email, controlla se l'elenco di 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 l'accesso.
  4. Nel campo Nuove entità, inserisci il tuo indirizzo email.
  5. Nell'elenco Seleziona un ruolo, scegli un ruolo.
  6. Per concedere altri ruoli, fai clic su Aggiungi un altro ruolo e aggiungi ogni altro ruolo.
  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 del 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 codici di stato HTTP o altri, puoi modificare il valore filter.

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

Visualizza i log degli accessi in entrata

Una volta abilitata la funzionalità, puoi visualizzare i log degli accessi 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 i nomi dei log.
      3. Fai clic su Applica.
      4. Il nome del log viene visualizzato nel campo dell'editor Query.
    • Nel campo Editor query, inserisci direttamente il nome del log:

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

      dove ORG_NAME è il nome della tua organizzazione Apigee.

  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 ulteriori dettagli.

Risoluzione dei problemi relativi ai log degli accessi in entrata

Una volta che la funzionalità è abilitata e i log sono disponibili 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

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

  • Abilitazione di metriche e avvisi basati su log

    Puoi definire la tua metrica basata su log per acquisire informazioni specifiche per le istanze Apigee. Per saperne di più, consulta la panoramica delle metriche basate su log.

    Puoi creare un criterio di avviso basato su log da Esplora log. Per ulteriori informazioni e la procedura dettagliata, consulta la sezione Creare 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 non hai scelto di filtrare i log di accesso in entrata per 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 per codici di stato in entrata

    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 spesso indica 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, consulta Visualizzare i log utilizzando Esplora log.

Disattivare la funzionalità

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

Puoi modificare l'istanza per disabilitare la funzionalità utilizzando l'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 disabilitare la funzionalità.
  • Fai clic su Salva.
  • API Apigee

    Utilizza questo comando 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.