Generazione e visualizzazione dei log in Cloud Run

Questa pagina descrive i log disponibili quando utilizzi Cloud Run e come visualizzarli e scriverli.

Cloud Run include tre tipi di log, che vengono automaticamente inviate a Cloud Logging:

• Log delle richieste (solo servizi): log delle richieste inviate ai servizi Cloud Run. Questi log vengono creati automaticamente.
• Log dei container (servizi e job): i log emessi dalle istanze, in genere dal tuo codice, vengono scritti nelle posizioni supportate come descritto in Scrivere log dei container.
• Log di sistema (servizi e job): log generati dalla piattaforma contenenti informazioni su dei tuoi servizi e dei tuoi job. Questi log vengono scritti in varlog/system.

Visualizza i log

Puoi visualizzare i log per il tuo servizio o job in diversi modi:

• Utilizzare la pagina Cloud Run nella console Google Cloud
• Utilizzare Google Cloud CLI per visualizzare i log utilizzando gcloud (solo servizi)
• Usa Esplora log di Cloud Logging nella console Google Cloud
• Utilizza Cloud Code

Entrambi i metodi della console per visualizzare i log esaminano gli stessi log archiviati in Cloud Logging, ma Esplora log di Cloud Logging fornisce più dettagli e più funzionalità di filtro.

Visualizza i log in Cloud Run

Puoi visualizzare i log per i servizi e i job nelle pagine corrispondenti.

Visualizza i log per un servizio

Per visualizzare i log del servizio nella pagina Cloud Run:

1. Vai a Cloud Run

2. Fai clic sul servizio che ti interessa nell'elenco visualizzato.

3. Fai clic sulla scheda LOG per visualizzare i log delle richieste e dei contenitori per tutte le revisioni di questo servizio. Puoi filtrare in base al livello di gravità dei log.

Visualizzare i log di un job

Per visualizzare i log dei job nella pagina Cloud Run:

1. Vai a Cloud Run

2. Fai clic sulla scheda JOB.

3. Individua il job nell'elenco dei job e fai clic su di esso.

4. Fai clic sulla scheda LOG per ottenere i log dei container per tutti più esecuzioni di questo job. Puoi filtrare in base al livello di gravità dei log.

5. In alternativa, se vuoi visualizzare i log precedentemente filtrati per un job specifico dell'esecuzione, fai clic sull'esecuzione del job e quindi sulla scheda LOG.

Visualizzare i log di servizio utilizzando Google Cloud CLI

Puoi utilizzare Google Cloud CLI per visualizzare i log di tailing o leggere i log esistenti per un servizio Cloud Run nella riga di comando Per impostazione predefinita, i log sono formattati in un formato a riga singola ottimizzato per la console.

Per monitorare i log, devi installare il componente log-streaming in Google Cloud CLI. Se il componente non è installato, ti verrà chiesto di installarlo quando necessario.

Visualizza i log di tailing nella riga di comando

Anteprima - Command-line log tail for Cloud Run services

Questa funzionalità è soggetta ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici dei servizi. Le funzionalità pre-GA sono disponibili "così come sono" e potrebbero avere un supporto limitato. Per saperne di più, consulta le descrizioni della fase di lancio.

Per un servizio Cloud Run, puoi monitorare i log in tempo reale dal servizio Cloud Run direttamente nella riga di comando:

gcloud beta run services logs tail SERVICE --project PROJECT-ID

Sostituisci

• SERVICE con il nome del servizio Cloud Run
• PROJECT-ID con l'ID progetto Google Cloud. Puoi visualizzare eseguendo il comando gcloud config get-value project.

Leggi i log nella riga di comando

Per un servizio Cloud Run, puoi leggere i log esistenti in uno dei due modi seguenti:

• In un formato ottimizzato per la console:

  gcloud run services logs read SERVICE --limit=10 --project PROJECT-ID

• Direttamente da Cloud Logging:

  gcloud logging read "resource.type=cloud_run_revision AND resource.labels.service_name=SERVICE" --project PROJECT-ID --limit 10

Sostituisci

• SERVICE con il nome del servizio Cloud Run
• PROJECT-ID con l'ID progetto Google Cloud. Puoi visualizzare eseguendo il comando gcloud config get-value project.

Visualizza i log in Cloud Logging

Per visualizzare i log di Cloud Run in Esplora log di Cloud Logging:

1. Vai alla pagina Esplora log nel Console Google Cloud:

   Vai alla pagina Esplora log

2. Seleziona un progetto Google Cloud esistente nella parte superiore della pagina o crea un nuovo progetto.

3. Utilizza i menu a discesa per selezionare la risorsa Revisione Cloud Run. per un servizio o Job Cloud Run per un job.

Per ulteriori informazioni, consulta Utilizzo di Esplora log.

Visualizza i log di servizio in Cloud Code

Per visualizzare i log in Cloud Code: leggi l'articolo IntelliJ e Visual Studio Code guide.

Leggi i log in modo programmatico

Se vuoi leggere i log in modo programmatico, puoi utilizzare uno dei seguenti metodi:

• Usa un sink di log in Pub/Sub e uno script per eseguire il pull da Pub/Sub.
• Chiama l'API Logging tramite le librerie client per il tuo linguaggio di programmazione.
• Chiama gli endpoint REST dell'API Logging .

Informazioni sui log di scalabilità delle istanze

Quando vengono avviate nuove istanze per il tuo servizio, Cloud Logging include voci di log sotto il nome log varlog/system per riflettere il motivo di ogni è stata creata. La voce di log segue questo formato:

Starting new instance. Reason: REASON - DESCRIPTION

La seguente tabella fornisce un'analisi dettagliata delle descrizioni delle istanze:

Motivo	Descrizione
CUSTOMER_MIN_INSTANCE	Istanzia minima configurata dal cliente per il servizio.
SCHEDULED	L'istanza è stata avviata a causa di fattori di scalabilità configurati (ad es. utilizzo della CPU, velocità effettiva delle richieste e così via) e dei relativi target.
OVERFLOW	L'istanza è stata avviata perché non è stata trovata alcuna capacità esistente per il traffico attuale.

Scrivere log dei container

Quando scrivi i log dal tuo servizio o job, vengono rilevati automaticamente da Cloud Logging, a condizione che vengano scritti in una di queste posizioni:

• Stream di output standard (stdout) o di errore standard (stderr)
• Tutti i file nella directory /var/log
• syslog (/dev/log)
• Log scritti utilizzando le librerie client di Cloud Logging. disponibili per molte lingue popolari

La maggior parte degli sviluppatori dovrebbe scrivere i log utilizzando l'output standard e l'errore standard.

I log dei container scritti in queste località supportate vengono automaticamente associati al servizio, alla revisione e alla località di Cloud Run oppure con il job Cloud Run. Le eccezioni contenute in questi log vengono acquisite e segnalate in Error Reporting.

Il logging integrato bilancia l'affidabilità e l'utilizzo delle risorse e dovrebbe funzionare per la maggior parte delle applicazioni. Se la tua applicazione ha requisiti per volumi elevati o all'affidabilità, consigliamo di utilizzare direttamente l'API Cloud Logging, come una libreria all'interno della tua applicazione o come container collaterale separato.

Usa testo semplice o JSON strutturato nei log

Quando scrivi i log, puoi inviare una semplice stringa di testo o una singola riga di JSON serializzato, chiamati anche dati "strutturati". Questo viene rilevato e analizzato da Cloud Logging e inserito in jsonPayload. Invece, il messaggio di testo semplice viene inserito in textPayload.

Scrittura di log strutturati

Il seguente snippet mostra come scrivere voci di log strutturate. Inoltre, mostra come correlare i messaggi di log con il log delle richieste corrispondente.

Node.js

// Uncomment and populate this variable in your code:
// const project = 'The project ID of your function or Cloud Run service';

// Build structured log messages as an object.
const globalLogFields = {};

// Add log correlation to nest all log messages beneath request log in Log Viewer.
// (This only works for HTTP-based invocations where `req` is defined.)
if (typeof req !== 'undefined') {
  const traceHeader = req.header('X-Cloud-Trace-Context');
  if (traceHeader && project) {
    const [trace] = traceHeader.split('/');
    globalLogFields['logging.googleapis.com/trace'] =
      `projects/${project}/traces/${trace}`;
  }
}

// Complete a structured log entry.
const entry = Object.assign(
  {
    severity: 'NOTICE',
    message: 'This is the default display field.',
    // Log viewer accesses 'component' as 'jsonPayload.component'.
    component: 'arbitrary-property',
  },
  globalLogFields
);

// Serialize to a JSON string and output.
console.log(JSON.stringify(entry));

Python

# Uncomment and populate this variable in your code:
# PROJECT = 'The project ID of your Cloud Run service';

# Build structured log messages as an object.
global_log_fields = {}

# Add log correlation to nest all log messages.
# This is only relevant in HTTP-based contexts, and is ignored elsewhere.
# (In particular, non-HTTP-based Cloud Functions.)
request_is_defined = "request" in globals() or "request" in locals()
if request_is_defined and request:
    trace_header = request.headers.get("X-Cloud-Trace-Context")

    if trace_header and PROJECT:
        trace = trace_header.split("/")
        global_log_fields[
            "logging.googleapis.com/trace"
        ] = f"projects/{PROJECT}/traces/{trace[0]}"

# Complete a structured log entry.
entry = dict(
    severity="NOTICE",
    message="This is the default display field.",
    # Log viewer accesses 'component' as jsonPayload.component'.
    component="arbitrary-property",
    **global_log_fields,
)

print(json.dumps(entry))

Vai

La struttura di ogni voce di log è fornita da un tipo Entry:

// Entry defines a log entry.
type Entry struct {
	Message  string `json:"message"`
	Severity string `json:"severity,omitempty"`
	Trace    string `json:"logging.googleapis.com/trace,omitempty"`

	// Logs Explorer allows filtering and display of this as `jsonPayload.component`.
	Component string `json:"component,omitempty"`
}

// String renders an entry structure to the JSON format expected by Cloud Logging.
func (e Entry) String() string {
	if e.Severity == "" {
		e.Severity = "INFO"
	}
	out, err := json.Marshal(e)
	if err != nil {
		log.Printf("json.Marshal: %v", err)
	}
	return string(out)
}

Quando viene registrato uno struct Entry, viene chiamato il metodo String per eseguire il marshal in il formato JSON previsto da Cloud Logging:

func init() {
	// Disable log prefixes such as the default timestamp.
	// Prefix text prevents the message from being parsed as JSON.
	// A timestamp is added when shipping logs to Cloud Logging.
	log.SetFlags(0)
}

func indexHandler(w http.ResponseWriter, r *http.Request) {
	// Uncomment and populate this variable in your code:
	// projectID = "The project ID of your Cloud Run service"

	// Derive the traceID associated with the current request.
	var trace string
	if projectID != "" {
		traceHeader := r.Header.Get("X-Cloud-Trace-Context")
		traceParts := strings.Split(traceHeader, "/")
		if len(traceParts) > 0 && len(traceParts[0]) > 0 {
			trace = fmt.Sprintf("projects/%s/traces/%s", projectID, traceParts[0])
		}
	}

	log.Println(Entry{
		Severity:  "NOTICE",
		Message:   "This is the default display field.",
		Component: "arbitrary-property",
		Trace:     trace,
	})

	fmt.Fprintln(w, "Hello Logger!")
}

Java

Attiva la registrazione JSON con Logback e SLF4J attivando l'codificatore JSON di Logstash nella configurazione di logback.xml.

// Build structured log messages as an object.
Object globalLogFields = null;

// Add log correlation to nest all log messages beneath request log in Log Viewer.
// TODO(developer): delete this code if you're creating a Cloud
//                  Function and it is *NOT* triggered by HTTP.
String traceHeader = req.headers("x-cloud-trace-context");
if (traceHeader != null && project != null) {
  String trace = traceHeader.split("/")[0];
  globalLogFields =
      kv(
          "logging.googleapis.com/trace",
          String.format("projects/%s/traces/%s", project, trace));
}
// -- End log correlation code --

// Create a structured log entry using key value pairs.
// For instantiating the "logger" variable, see
// https://cloud.google.com/run/docs/logging#run_manual_logging-java
logger.error(
    "This is the default display field.",
    kv("component", "arbitrary-property"),
    kv("severity", "NOTICE"),
    globalLogFields);

Personalizza i nomi dei campi standard per escludere l'importazione di contenuti indesiderati nel payload dei log. Per un elenco dei nomi dei campi e dei formati di dati previsti, consulta Utilizzare l'agente Logging.

<configuration>
  <appender name="jsonConsoleAppender" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="net.logstash.logback.encoder.LogstashEncoder">
      <!-- Ignore default logging fields -->
      <fieldNames>
        <timestamp>[ignore]</timestamp>
        <version>[ignore]</version>
        <logger>[ignore]</logger>
        <thread>[ignore]</thread>
        <level>[ignore]</level>
        <levelValue>[ignore]</levelValue>
      </fieldNames>
    </encoder>
  </appender>
  <root level="INFO">
    <appender-ref ref="jsonConsoleAppender"/>
  </root>
</configuration>

Campi JSON speciali nei messaggi

Quando fornisci un log strutturato come dizionario JSON, alcuni campi speciali vengono rimossi da jsonPayload e scritti nel campo corrispondente nel LogEntry generato, come descritto nella documentazione per i campi speciali.

Ad esempio, se il file JSON include una proprietà severity, viene rimossa da jsonPayload e viene visualizzato come severity della voce di log. La proprietà message viene utilizzata come testo visualizzato principale della voce di log, se presente. Per ulteriori informazioni sulle proprietà speciali, leggi la sezione Risorsa di logging. di seguito.

Correlare i log dei contenitori con un log delle richieste (solo servizi)

In Esplora log, i log correlati allo stesso valore trace vengono visibile in "padre-figlio" format: quando fai clic sul triangolo a sinistra della voce di log delle richieste, i log dei container relativi vengono visualizzate nidificate sotto il log delle richieste.

I log dei container non vengono correlati automaticamente ai log delle richieste, a meno che non utilizzi un Libreria client di Cloud Logging. Per correlare i log dei contenitori con i log delle richieste senza utilizzare una libreria client, puoi utilizzare una riga di log JSON strutturata contenente un campo logging.googleapis.com/trace con l'identificatore traccia estratto dall'X-Cloud-Trace-Context intestazione come mostrato nell'esempio precedente per il logging strutturato.

Controllare l'utilizzo delle risorse dei log delle richieste (solo servizi)

I log delle richieste vengono creati automaticamente. Sebbene non sia possibile controllare la quantità dei log delle richieste direttamente da Cloud Run, puoi utilizzare la funzionalità di esclusione dei log da in Cloud Logging.

Una nota sugli agenti di logging

Se hai utilizzato Cloud Logging con determinati prodotti Google Cloud, come Compute Engine, potresti aver utilizzato gli agenti di logging di Cloud Logging. Cloud Run non utilizza gli agenti di logging perché dispone del supporto integrato per la raccolta dei log.

Nomi delle risorse di logging

I nomi delle risorse di logging per Cloud Run sono:

• Revisione Cloud Run (cloud_run_revision).
• Job Cloud Run (cloud_run_job).

Logging delle risorse

Se fai clic su una voce di log in Esplora log, si apre un file JSON di voce di log formattata per consentirti di visualizzare i dettagli desiderati.

Tutti i campi in una voce di log, ad esempio timestamp, gravità e httpRequest sono standard e sono descritti nella documentazione voce di log.

Cloud Run aggiunge metadati aggiuntivi per consentirti di identificare l'origine di un log. Sono incluse le etichette impostate sul servizio Cloud Run e le etichette delle risorse specifiche per Cloud Run.

Campi delle voci di log per un servizio

Di seguito è riportato un elenco dei campi che puoi trovare nella voce del log di un servizio Cloud Run:

Campo	Valori e note
LogEntry.labels.instanceId	L'istanza che ha gestito la richiesta.
LogEntry.labels.mylabel, LogEntry.labels.mysecondlabel	Le etichette impostate da te sul servizio.
LogEntry.logName	Identifica il log, ad esempio log delle richieste, errore standard, output standard e così via.
LogEntry.resource.labels.location	Identifica la località del servizio Google Cloud.
LogEntry.resource.labels.project_id	Il progetto in cui è stato eseguito il deployment del servizio.
LogEntry.resource.labels.revision_name	La revisione che ha soddisfatto la richiesta.
LogEntry.resource.labels.service_name	Il servizio che ha gestito la richiesta.
LogEntry.resource.type	cloud_run_revision. Il tipo di risorsa Cloud Run.

Ecco un esempio di voce di log delle richieste per un servizio Cloud Run:

{
 httpRequest: {…}
 insertId:  "5c82b3d1000ece0000000000"
 labels: {
  instanceId:  "00bf4bf00000fb59c906a00000c9e29c2c4e06dce91500000000056008d2b6460f163c0057b97b2345f2725fb2423ee5f0bafd36df887fdb1122371563cf1ff453717282afe000001"
  mylabel: "mylabelvalue"
  mysecondlabel: "mysecondlabelvalue"
 }
 logName:  "projects/my-project/logs/run.googleapis.com%2Frequests"
 receiveTimestamp:  "2019-03-08T18:26:25.981686167Z"
 resource: {
  labels: {
   configuration_name:  "myservice"
   location:  "us-central1"
   project_id:  "my-project"
   revision_name:  "myservice-00002"
   service_name:  "myservice"
  }
  type:  "cloud_run_revision"
 }
 severity:  "INFO"
 timestamp:  "2019-03-08T18:26:25.970397Z"
}

Campi di immissione dei log per i job

Di seguito è riportato un elenco dei campi che puoi trovare nella voce di log per un job Cloud Run:

Campo	Valori e note
LogEntry.labels.instanceId	L'istanza.
LogEntry.labels.mylabel, LogEntry.labels.mysecondlabel	Le etichette impostate da te nel job.
LogEntry.logName	Identifica il log, ad esempio log delle richieste, errore standard, output standard e così via.
LogEntry.resource.labels.location	Identifica la località del servizio Google Cloud.
LogEntry.resource.labels.project_id	Il progetto in cui è stato eseguito il deployment del servizio.
LogEntry.resource.labels.job_name	Il nome del job.
LogEntry.labels.execution_name	Il nome dell'esecuzione del job.
LogEntry.labels.task_index	L'indice dell'attività.
LogEntry.labels.task_attempt	Quante volte è stata tentata questa attività.
LogEntry.resource.type	cloud_run_job. Il tipo di risorsa Cloud Run.