Visualizza i log del parco risorse

Questa pagina descrive come abilitare e visualizzare i log per i parchi risorse. Con il logging del parco risorse, più log vengono aggregati e limitati insieme, in modo da analizzare l'integrità delle applicazioni in un'unica visualizzazione consolidata. Questa pagina è destinata a:

  • Amministratori di piattaforma che vogliono abilitare il logging del parco risorse e visualizzare i log in tutti gli spazi dei nomi.
  • Operatori di servizio che vogliono visualizzare i log negli spazi dei nomi specifici a cui hanno accesso.

Panoramica

I log del parco risorse consentono di visualizzare i log a livello di intero parco risorse o per ambiti dei team specifici. Gli ambiti sono una funzionalità di gestione dei team che consente di definire sottoinsiemi di log del parco risorse e altre risorse in base al team, con ogni ambito associato a uno o più cluster membro del parco risorse. Per saperne di più sugli ambiti, vedi Gestire i team per il parco risorse.

Puoi visualizzare due tipi di log del parco risorse:

  • Log predefiniti: tutti i log Kubernetes (tranne gli Audit log) che non appartengono a un ambito specifico del parco risorse con i seguenti tipi di risorse:

    • k8s_container
    • k8s_pod
    • k8s_node
    • k8s_cluster
    • k8s_control_plane_components
  • Log nell'ambito del parco risorse: log di container e pod per le applicazioni di proprietà di un team di cui è stato eseguito il deployment in un ambito del parco risorse specifico con più spazi dei nomi a livello di parco risorse.

La visualizzazione dei log dell'ambito del parco risorse è facoltativa. Se non vuoi configurare la gestione del team, puoi comunque utilizzare il logging del parco risorse per visualizzare i log predefiniti.

I log possono essere instradati a bucket di log diversi nel progetto host del parco risorse con viste diverse per controllo dell'accesso. Il periodo di conservazione predefinito di un bucket di log è di 30 giorni. Se necessario, puoi configurare questo periodo.

Sono supportate due modalità per il routing dei log in cui i parchi risorse contengono cluster di più progetti (registrazione tra progetti):

  • MOVE: tutti i log vengono spostati nel progetto host del parco risorse. Se un cluster nel parco risorse appartiene a un progetto diverso, i relativi log non vengono conservati nel progetto Google Cloud originale.

  • COPY: tutti i log vengono inviati al progetto host del parco risorse. Se un cluster nel parco risorse appartiene a un progetto diverso, i relativi log vengono conservati anche nel progetto Google Cloud originale.

Prima di iniziare

  1. Se hai già creato manualmente bucket e sink di Cloud Logging e impostato filtri di esclusione, assicurati che i nomi assegnati a questi oggetti non siano in conflitto con le restrizioni di denominazione dei log del parco risorse. In caso di conflitto di denominazione, contatta l'assistenza prima di procedere.

  2. Assicurati che i cluster di cui vuoi visualizzare i log siano stati registrati nel parco risorse scelto.

  3. Se non l'hai già installata, installa Google Cloud CLI seguendo le istruzioni di installazione. Devi avere la versione 424.0.0 o successiva per visualizzare i log del parco risorse.

  4. Assicurati che nel progetto host del parco risorse siano abilitate tutte le API richieste, inclusa l'API Anthos:

    gcloud services enable --project=FLEET_HOST_PROJECT_ID  \
    gkehub.googleapis.com \
    container.googleapis.com \
    connectgateway.googleapis.com \
    cloudresourcemanager.googleapis.com \
    iam.googleapis.com \
    anthos.googleapis.com
    

    dove:

Prepara ambiti, spazi dei nomi e carichi di lavoro

Per visualizzare i log degli ambiti del parco risorse, dovrai creare un ambito e uno spazio dei nomi del parco risorse, oltre a preparare i carichi di lavoro per la raccolta dei log.

Prima di continuare, imposta il progetto predefinito per Google Cloud CLI eseguendo questo comando:

gcloud config set project FLEET_HOST_PROJECT_ID

Crea ambiti e spazi dei nomi

Se vuoi visualizzare i log a livello di ambito e non hai già configurato gli ambiti, segui le istruzioni in Gestire i team per il parco risorse per creare ambiti, aggiungere cluster agli ambiti e configurare gli spazi dei nomi del parco risorse.

Prepara i carichi di lavoro

Per visualizzare i dati di log delle applicazioni, devi eseguire il deployment dei carichi di lavoro in un cluster nello spazio dei nomi del parco risorse configurato nel passaggio precedente. Questo passaggio è applicabile indipendentemente dal fatto che tu scelga di visualizzare i log predefiniti, i log dell'ambito del parco risorse o entrambi. Ecco un esempio per configurare il carico di lavoro:

  apiVersion: v1
  kind: Pod
  metadata:
    name: fleet-example-pod
    namespace: NAMESPACE_NAME
  spec:
    containers:
    - name: count
      image: ubuntu:14.04
      args: [bash, -c,
           'for ((i = 0; ; i++)); do echo "$i: $(date)"; sleep 1; done']

Dopo aver eseguito il deployment della risorsa, potresti visualizzare un errore se la creazione dello spazio dei nomi del parco risorse non è riuscita per qualche motivo. In questo caso, esegui questo comando per creare di nuovo lo spazio dei nomi ed esegui nuovamente il comando Workload deployment:

  kubectl create namespace NAMESPACE_NAME
  

Abilita il logging del parco risorse

Questa sezione descrive come abilitare la funzionalità di logging del parco risorse e concedere al team l'accesso per visualizzare i log.

gcloud

  • Puoi abilitare il logging del parco risorse utilizzando Google Cloud CLI specificando i campi di configurazione della funzionalità in un file JSON o YAML. Ecco un esempio di configurazione per il logging del parco risorse in formato JSON:

    {
      "loggingConfig": {
          "defaultConfig": {
              "mode": "COPY"
          },
          "fleetScopeLogsConfig": {
              "mode": "MOVE"
          }
      }
    }
    

Per visualizzare tutti i campi configurabili per questa funzionalità, consulta la documentazione di riferimento API.

Quando i campi defaultConfig o fleetScopeLogsConfig sono abilitati con le modalità COPY o MOVE, come mostrato nell'esempio precedente, viene creato un sink di log con il prefisso fleet-o11y-. Questo sink di log viene creato nell'ambito del progetto Google Cloud per instradare i log di destinazione dal progetto del cluster al progetto host del parco risorse.

Quando fleetScopeLogsConfig è abilitato, viene creato anche un bucket di log con nome fleet-o11y-scope-$SCOPE_NAME nella regione global all'interno del progetto host del parco risorse, se non esiste già. Tieni presente che non puoi modificare la regione del bucket.

In questo esempio, i log predefiniti verranno inviati al progetto host del parco risorse e conservati nel progetto Google Cloud originale, mentre i log dell'ambito del parco risorse verranno inviati al progetto host del parco risorse e non verranno conservati nel progetto Google Cloud.

  • Aggiungi la configurazione scelta a un file JSON e aggiorna il parco risorse:

    gcloud container fleet fleetobservability update \
            --logging-config=JSON_FILE
    

Sostituisci JSON_FILE con il nome del tuo nome file.

Terraform

  • La funzionalità di osservabilità del parco risorse è abilitata per impostazione predefinita. Se è la prima volta che utilizzi Terraform per gestire la funzionalità di osservabilità del parco risorse, importala in Terraform eseguendo questo comando:
terraform import google_gke_hub_feature.feature projects/FLEET_HOST_PROJECT_ID/locations/global/features/fleetobservability
  • Puoi abilitare il logging del parco risorse con Terraform utilizzando un modulo Terraform.

Ad esempio, puoi aggiungere il blocco seguente alla tua configurazione Terraform:

  resource "google_gke_hub_feature" "feature" {
    name = "fleetobservability"
    location = "global"
    spec {
      fleetobservability {
        logging_config {
          default_config {
            mode = "COPY"
          }
          fleet_scope_logs_config {
            mode = "MOVE"
          }
        }
      }
    }
  }

Quando i campi default_config o fleet_scope_logs_config sono abilitati con le modalità COPY o MOVE, come mostrato nell'esempio precedente, viene creato un sink di log con il prefisso fleet-o11y-. Questo sink di log viene creato nell'ambito del progetto Google Cloud per instradare i log di destinazione dal progetto del cluster al progetto host del parco risorse.

Quando fleet_scope_logs_config è abilitato, viene creato anche un bucket di log con nome fleet-o11y-scope-$SCOPE_NAME nel progetto host del parco risorse, se non esiste già.

In questo esempio, i log predefiniti verranno inviati al progetto host del parco risorse e conservati nel progetto Google Cloud originale, mentre i log dell'ambito del parco risorse verranno inviati al progetto host del parco risorse e non verranno conservati nel progetto Google Cloud.

Verifica che le specifiche della funzionalità siano aggiornate:

   gcloud container fleet fleetobservability describe
  

L'output mostra la specifica fleetobservability aggiornata con la configurazione, come nell'esempio seguente:

createTime: '2022-09-30T16:05:02.222568564Z'
membershipStates:
  projects/123456/locations/us-central1/memberships/cluster-1:
    state:
      code: OK
      description: Fleet monitoring enabled.
      updateTime: '2023-04-03T20:22:51.436047872Z'
name:
projects/123456/locations/global/features/fleetobservability
resourceState:
  state: ACTIVE
spec:
  fleetobservability:
    loggingConfig:
      defaultConfig:
        mode: COPY
      fleetScopeLogsConfig:
        mode: MOVE
state:
  state: {}
updateTime: '2023-04-03T20:38:17.719596966Z'

L'applicazione di qualsiasi modifica apportata alla specifica fleetobservability potrebbe richiedere alcuni minuti.

Configura le autorizzazioni di logging tra progetti

Questa sezione è obbligatoria solo se stai registrando un cluster in un parco risorse in un progetto diverso (nota anche come registrazione tra progetti). Per eseguire il routing dei log dai progetti del cluster al progetto host del parco risorse, devi concedere il ruolo roles/logging.bucketWriter all'account di servizio di logging da ogni progetto del cluster.

  1. Per ottenere le credenziali dell'account di servizio dai sink nei progetti di cluster, esegui questo comando:

    FLEET_HOST_PROJECT_ID=FLEET_HOST_PROJECT_ID
    FLEET_HOST_PROJECT_NUMBER=$(gcloud projects describe "${FLEET_HOST_PROJECT_ID}" --format "value(projectNumber)")
    gcloud logging sinks --project=GKE_PROJECT_ID describe fleet-o11y-${FLEET_HOST_PROJECT_NUMBER}-default
    

    Se il comando restituisce un errore che indica che non è stato possibile trovare il sink di log, prova a eseguire di nuovo il comando dopo uno o due minuti. Puoi visualizzare l'account di servizio nel campo writerIdentity della descrizione del sink, come mostrato nell'esempio seguente:

    createTime: '2023-04-06T02:26:54.716195307Z'
    destination:
    logging.googleapis.com/projects/123456/locations/global/buckets/_Default
    filter: xxx
    name: fleet-o11y-default
    updateTime: '2023-04-06T19:03:51.598668462Z'
    writerIdentity:
    serviceAccount:service-123456@gcp-sa-logging.iam.gserviceaccount.com
    
  2. Concedi il ruolo di roles/logging.bucketWriter all'account di servizio recuperato:

    gcloud projects add-iam-policy-binding FLEET_HOST_PROJECT_ID \
        --member "SERVICE_ACCOUNT" \
        --role "roles/logging.bucketWriter"
    

    dove:

    • SERVICE_ACCOUNT è il nome dell'account di servizio recuperato dal passaggio precedente. Ad esempio:
    gcloud projects add-iam-policy-binding FLEET_HOST_PROJECT_ID \
        --member "serviceAccount:service-123456@gcp-sa-logging.iam.gserviceaccount.com" \
        --role "roles/logging.bucketWriter"
    

Concedi al team l'accesso ai log

La sezione descrive come concedere agli utenti l'accesso per visualizzare i log dei container e dei pod.

  1. Ottieni il criterio IAM per il progetto del parco risorse e scrivilo in un file locale in formato JSON:

    gcloud projects get-iam-policy FLEET_HOST_PROJECT_ID --format json > output.json
    
  2. Aggiungi una condizione IAM che consenta all'account utente di visualizzare i dati del bucket di log che hai creato. Ecco un esempio per visualizzare i log dei container e dei pod:

    {
      "bindings": [
        {
          "members": [
            "user:USER_ACCOUNT_EMAIL"
          ],
          "role": "roles/logging.viewAccessor",
          "condition": {
              "title": "Bucket reader condition example",
              "description": "Grants logging.viewAccessor role to user USER_ACCOUNT_EMAIL for the fleet-o11y-scope-SCOPE_NAME-k8s_container and fleet-o11y-scope-SCOPE_NAME-k8s_pod log view.",
              "expression":
                "resource.name == \"projects/FLEET_HOST_PROJECT_ID/locations/global/buckets/fleet-o11y-scope-SCOPE_NAME/views/fleet-o11y-scope-SCOPE_NAME-k8s_container\" || resource.name == \"projects/FLEET_HOST_PROJECT_ID/locations/global/buckets/fleet-o11y-scope-SCOPE_NAME/views/fleet-o11y-scope-SCOPE_NAME-k8s_pod\""
          }
        }
      ],
    }
    
  3. Aggiorna il criterio IAM:

    gcloud projects set-iam-policy FLEET_HOST_PROJECT_ID output.json
    

Per ulteriori opzioni sulla concessione dell'accesso, consulta Controllare l'accesso a una visualizzazione del log.

Visualizza i log del parco risorse

Gli amministratori della piattaforma hanno accesso per visualizzare tutti i log in tutti gli spazi dei nomi.

Log predefiniti

Per visualizzare tutti i log predefiniti nel bucket _Default nel progetto host del parco risorse, compila le variabili nel seguente URL, copialo e incollalo nel browser:

https://console.cloud.google.com/logs/query;query=;storageScope=storage,projects%2FFLEET_HOST_PROJECT_ID%2Flocations%2Fglobal%2Fbuckets%2F_Default%2Fviews%2F_Default?jsmode=O&mods=pan_ng2&project=FLEET_HOST_PROJECT_ID

Log dei container e log dei pod nell'ambito del parco risorse

Gli operatori di servizio possono visualizzare i log negli spazi dei nomi a cui hanno accesso. Per visualizzare i log per tutti gli spazi dei nomi in un ambito specifico del parco risorse, completa i seguenti passaggi:

  1. Dopo aver selezionato il progetto host del parco risorse, vai alla sezione Team nella console Google Cloud.

    Vai a Teams

  2. Fai clic sull'ambito del team di cui vuoi visualizzare i log e fai clic sulla scheda Log.

  3. Seleziona Log del container o Log dei pod per filtrare la visualizzazione dei log.

Per visualizzare i log per uno spazio dei nomi specifico nel tuo ambito:

  1. Nella pagina Team, dopo aver selezionato l'ambito del team, fai clic sulla scheda Spazi dei nomi.
  2. Fai clic sullo spazio dei nomi di cui vuoi visualizzare i log e fai clic sulla scheda Log.
  3. Seleziona Log dei container o Log dei pod per filtrare la visualizzazione dei log.

In alternativa, per visualizzare i log dei container, compila le variabili nel seguente URL, copialo e incollalo nel browser:

https://console.cloud.google.com/logs/query;query=;storageScope=storage,projects%2FFLEET_HOST_PROJECT_ID%2Flocations%2Fglobal%2Fbuckets%2Ffleet-o11y-scope-SCOPE_NAME%2Fviews%2Ffleet-o11y-scope-SCOPE_NAME-k8s_container?jsmode=O&mods=pan_ng2&project=FLEET_HOST_PROJECT_ID

Per visualizzare i log dei pod in un ambito specifico del parco risorse, compila le variabili nel seguente URL, copialo e incollalo nel browser:

https://console.cloud.google.com/logs/query;query=;storageScope=storage,projects%2FFLEET_HOST_PROJECT_ID%2Flocations%2Fglobal%2Fbuckets%2Ffleet-o11y-scope-SCOPE_NAME%2Fviews%2Ffleet-o11y-scope-SCOPE_NAME-k8s_pod?jsmode=O&mods=pan_ng2&project=FLEET_HOST_PROJECT_ID

Per ulteriori informazioni su come analizzare i dati dei log, consulta Interfaccia di Esplora log.

Disabilita il logging del parco risorse

Per disattivare la funzionalità di logging del parco risorse, completa i seguenti passaggi:

gcloud

  1. Salva la seguente configurazione in un file denominato disable_logging_config.json:

    {
      "loggingConfig": {}
    }
    
  2. Aggiorna la specifica della funzionalità fleetobservability:

    gcloud container fleet fleetobservability update \
            --logging-config=disable_logging_config.json
    

Terraform

Nella configurazione di Terraform, aggiorna tutte le modalità per il routing dei log a MODE_UNSPECIFIED. Ecco un esempio:

  resource "google_gke_hub_feature" "feature" {
    name = "fleetobservability"
    location = "global"
    spec {
      fleetobservability {
        logging_config {
          default_config {
            mode = "MODE_UNSPECIFIED"
          }
          fleet_scope_logs_config {
            mode = "MODE_UNSPECIFIED"
          }
        }
      }
    }
  }

Verifica che le specifiche della funzionalità siano aggiornate:

   gcloud container fleet fleetobservability describe
  

L'output mostra la specifica fleetobservability aggiornata con la tua configurazione:

  createTime: '2022-09-30T16:05:02.222568564Z'
  membershipStates:
    projects/123456/locations/global/memberships/cluster-1:
      state:
        code: OK
        description: Fleet monitoring enabled.
        updateTime: '2023-04-03T20:22:51.436047872Z'
  name:
  projects/123456/locations/global/features/fleetobservability
  resourceState:
    state: ACTIVE
  spec:
    fleetobservability:
      loggingConfig: {}
  state:
    state: {}
  updateTime: '2023-04-03T20:38:17.719596966Z'
  

L'applicazione di qualsiasi modifica apportata alla specifica fleetobservability potrebbe richiedere alcuni minuti.

Dopo aver disabilitato il logging del parco risorse, i sink di log e i filtri di esclusione verranno rimossi dai progetti. Tuttavia, tutti i bucket di log creati per l'ambito e le visualizzazioni dei log create nel bucket di log verranno conservati. Per eliminare il bucket di log nel progetto host del parco risorse, consulta Eliminare un bucket.

Aggiorna il periodo di conservazione per i bucket di log

Il periodo di conservazione predefinito di un bucket di log è di 30 giorni. Per aggiornare questo periodo, esegui questo comando:

gcloud logging buckets update fleet-o11y-scope-SCOPE_NAME --location=global --retention-days=RETENTION_DAYS

dove:

  • SCOPE_NAME è il nome dell'ambito del parco risorse.

  • RETENTION_DAYS è il numero di giorni del nuovo periodo di conservazione. Per ulteriori opzioni sulla configurazione dei bucket di log, consulta Gestire i bucket.

Se estendi il periodo di conservazione di un bucket, le regole di conservazione verranno applicate per il futuro e non in modo retroattivo. I log non possono essere recuperati al termine del periodo di conservazione applicabile.

Riferimento API

Questa sezione fornisce informazioni sui possibili campi che puoi aggiungere all'oggetto fleetobservability.

osservabilità flotta

fleetobservability definisce la configurazione dell'osservabilità del parco risorse.

Campo Descrizione Schema Facoltativo
loggingConfig

Specificato se la funzionalità di logging del parco risorse è abilitata per l'intero parco risorse.

Se non specificato, la funzionalità di logging del parco risorse viene disabilitata per l'intero parco risorse.

loggingConfig True

loggingConfig

loggingConfig definisce la configurazione delle funzionalità di logging del parco risorse nell'osservabilità del parco risorse.

Campo Descrizione Schema Facoltativo
defaultConfig Imposta il comportamento di routing dei log per i log predefiniti nel parco risorse. routingConfig True
fleetScopeLogsConfig Imposta il comportamento del routing dei log per i log dell'ambito del parco risorse. routingConfig True

routingConfig

routingConfig definisce la configurazione della modalità di routing dei log nella funzionalità di logging del parco risorse.

Campo Descrizione Schema Facoltativo
modalità

Specificato per abilitare il routing dei log e non specificato o MODE_UNSPECIFIED per disabilitare il routing dei log.

Se impostato su COPY, i log verranno copiati nel progetto di destinazione.

Se impostato su MOVE, i log verranno spostati nel progetto di destinazione.

Stringa; una tra: MOVE, COPY e MODE_UNSPECIFIED True

Restrizioni di denominazione

Quando l'osservabilità del parco risorse è abilitata, il controller di osservabilità del parco risorse riserva i seguenti nomi per gli oggetti dei log che crea. Per evitare comportamenti indesiderati o imprevisti, devi evitare di utilizzare questi nomi quando crei bucket di log, sink e imposta filtri di esclusione personalizzati.

Funzionalità attivata Oggetto creato Nome utilizzato dall'osservabilità del parco risorse
defaultConfig Sink fleet-o11y-FLEET_PROJECT_NUMBER-default
Filtro di esclusione. fleet-o11y-FLEET_PROJECT_NUMBER-default-exclusion. Questo nome è riservato nel sink _Default del progetto cluster.
fleetScopeLogsConfig Bucket di log fleet-o11y-scope-SCOPE_NAME
  • Visualizzazione dei log per i log dei container nel bucket
  • fleet-o11y-scope-SCOPE_NAME-k8s_container
  • Visualizzazione dei log per i log dei pod nel bucket
  • fleet-o11y-scope-SCOPE_NAME-k8s_pod
    Sink fleet-o11y-FLEET_PROJECT_NUMBER-scope-SCOPE_NAME
    Filtro di esclusione fleet-o11y-FLEET_PROJECT_NUMBER-scope-exclusion

    Risoluzione dei problemi

    Questa sezione descrive come risolvere i problemi relativi al logging del parco risorse.

    Notifica email sull'errore di configurazione del sink

    Se hai ricevuto un'email dal titolo [ACTION REQUIRED] Cloud Logging sink configuration error in <Your GCP Project>, significa che l'account di servizio del sink di log non dispone dell'autorizzazione per scrivere i log nella destinazione del sink. Per risolvere il problema, segui i passaggi descritti in Autorizzazioni di logging tra progetti.

    Messaggio di errore sconosciuto dalla UI di Cloud Logging

    Se visualizzi il seguente errore nell'interfaccia utente di Cloud Logging, verifica che le variabili project_id e scope inserite nell'URL siano corrette.

    Error: There is an unknown error while executing this operation.
    

    Errore di Iscrizione non trovata

    Potrebbe essere visualizzato il seguente errore:

    ERROR: (gcloud.alpha.container.fleet.memberships.bindings.create) NOT_FOUND: Resource 'parent resource not found for projects/...' was not found
    

    Assicurati di aver registrato il cluster in un parco risorse.