Voci di log di live tailing e di streaming

Questo documento descrive come visualizzare le voci di log in tempo reale tramite streaming e tailing in tempo reale. I log dei flussi di dati consentono di visualizzare le voci di log in tempo reale e sono disponibili in Esplora log. Il tailing in tempo reale consente di visualizzare le voci di log in tempo reale ed è disponibile come comando gcloud CLI gcloud alpha logging tail e come metodo dell'API Cloud Logging entries.tail.

Quando visualizzi e analizzi i log utilizzando Esplora log, gcloud logging read o il metodo API entries.list, vengono visualizzate le voci di log archiviate da Cloud Logging. Quando esegui il flusso di dati o voci di log in tempo reale, visualizzi le voci di log mentre le tue applicazioni le scrivono nell'API Cloud Logging.

Nota: se i tuoi dati vengono gestiti tramite un ambiente Assured Workloads, questa funzionalità potrebbe essere interessata o limitata. Per informazioni, consulta Restrizioni e limitazioni in Assured Workloads.

Trasmetti il flusso dei log in Esplora log

In Esplora log puoi visualizzare i dati dei log in tempo reale utilizzando Stream log. Quando utilizzi Avvia flusso di log, puoi aggiungere una query per trasmettere in flussi solo i log che corrispondono alla query. Per trasmettere i flussi di log:

1. Nel pannello di navigazione della console Google Cloud, seleziona Logging, quindi Esplora log:

   Vai a Esplora log

2. Nella casella di testo Query, inserisci una query e fai clic su Avvia flusso di log.

   Quando Logging scrive i dati dei log, nel riquadro Risultati delle query vengono mostrati solo i log che corrispondono alla query. Se non viene fornita una query, Logging mostra le voci di log archiviate di recente. I flussi di log continuano a essere trasmessi finché non selezioni la barra di scorrimento nel riquadro dei log. Quando lo streaming si interrompe, viene visualizzato il pulsante Riavvia streaming.

   Per informazioni sulle query, consulta Creare query in Esplora log.

Utilizza il tailing in tempo reale in Google Cloud CLI

Anteprima

Questo prodotto o funzionalità è soggetto ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici del servizio. I prodotti e 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.

Il tailing in tempo reale consente di visualizzare le voci di log in tempo reale mentre Cloud Logging le scrive, utilizzando Google Cloud CLI o l'API Cloud Logging.

Il tailing in tempo reale non è supportato per i bucket di log con controlli dell'accesso a livello di campo, tuttavia puoi trasmettere i flussi di log per questi bucket in Esplora log.

Per informazioni sul metodo API per il tailing in tempo reale, consulta il metodo entries.tail.

Installazione di gcloud alpha logging tail in corso...

Per utilizzare gcloud alpha logging tail, devi avere installato Python 3 e il pacchetto Python grpcio.

Per istruzioni su come installare Python, consulta la pagina di Python. Per istruzioni su come installare il gestore di pacchetti Python, pip, necessario per installare il pacchetto grpcio, consulta la pagina del programma di installazione dei pacchetti Python.

Completa i seguenti passaggi per installare gcloud alpha logging tail:

1. Verifica di aver installato Google Cloud CLI. Per istruzioni su come installare Google Cloud CLI, consulta Installazione di Google Cloud CLI.

2. Verifica di utilizzare la versione 302.0.0 o successiva di gcloud CLI.

   gcloud version
   

   Per istruzioni sull'aggiornamento di gcloud CLI, consulta gcloud components update.

3. Installa i componenti alpha gcloud CLI:

   gcloud components install alpha
   

4. Per gli utenti di MacOS, Linux e Cloud Shell:

   1. Installa le librerie client gRPC:

       sudo pip3 install grpcio
      

   2. Imposta la variabile di ambiente CLOUDSDK_PYTHON_SITEPACKAGES su qualsiasi valore:

       export CLOUDSDK_PYTHON_SITEPACKAGES=1
      

      Nota: per impostazione predefinita, Google Cloud CLI ignora le librerie Python installate sul tuo sistema locale. Per consentire a Google Cloud CLI di utilizzare la libreria grpcio, devi abilitare i pacchetti di siti. Per abilitare i pacchetti di siti, imposta la variabile di ambiente CLOUDSDK_PYTHON_SITEPACKAGES su 1. Con i pacchetti di siti abilitati, l'gcloud CLI può utilizzare librerie aggiuntive al di fuori della directory google-cloud-sdk/lib.

5. Utilizza i seguenti comandi per impostare l'ID progetto Google Cloud e per eseguire l'autenticazione:

   gcloud config set project PROJECT_ID
   gcloud auth login
   

   Per ottenere l'ID progetto, consulta Creazione e gestione dei progetti.

6. Verifica che gcloud alpha logging tail sia installato eseguendo questo comando:

   gcloud alpha logging tail
   

   Il comando visualizza il seguente messaggio:

   Initializing tail session.

   Stai visualizzando le voci di log per il tuo progetto Google Cloud mentre Logging le scrive.

   

Per ulteriori informazioni sull'utilizzo del tailing in tempo reale, consulta la guida di riferimento di gcloud alpha logging tail.

Buffering e ordinazione

Poiché Logging può ricevere voci di log in ordine cronologico, il live tailing fornisce un'impostazione della finestra di buffer in modo da poter bilanciare il compromesso tra la visualizzazione delle voci di log durante la loro scrittura e quella in ordine crescente. Puoi impostare la finestra di buffer tra 0 e 60 secondi.

Tieni presente le seguenti caratteristiche della finestra di buffer:

• La finestra di buffer predefinita è di due secondi.

• Il logging ritarda la scrittura delle voci di log nei bucket di log per la durata della finestra del buffer.

• Se una voce di log viene scritta al di fuori della finestra del buffer, Logging restituisce le voci di log non appena vengono ricevute.

Quando configuri la finestra del buffer, devi fare un compromesso tra la visualizzazione dei log così come sono scritti e la visualizzazione delle voci nell'ordine sbagliato.

Finestra del buffer	Compromesso
0 secondi	Sono state restituite le voci di log più recenti, ma con maggiore probabilità che non siano nell'ordine corretto.
60 secondi	Un ritardo di 60 secondi prima di visualizzare le voci restituite, ma la maggior parte dei log viene restituita in ordine crescente.

Limiti e quote

Nella tabella seguente sono elencati i limiti e le quote per il tailing in tempo reale:

Limiti e quote	Valore
Voci restituite al minuto	60.000 Se più di 60.000 voci corrispondono a un filtro, Logging restituisce il conteggio delle voci nella risposta.
Sessioni di live-tailing aperte per progetto Google Cloud	10

Limitazioni client

Per un progetto Google Cloud che scrive molte voci rapidamente, il client potrebbe non essere in grado di utilizzarle con la stessa velocità con cui vengono scritte. In questo caso, Logging limita il numero totale di voci inviate, dando la priorità a quelle più recenti. Al termine della sessione tail, Logging restituisce il numero di voci che non sono state visualizzate a causa dei limiti del client.

Utilizzare il tailing in tempo reale con le librerie client

Anteprima

Questo prodotto o funzionalità è soggetto ai "Termini delle Offerte pre-GA" nella sezione Termini generali del servizio dei Termini specifici del servizio. I prodotti e 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.

Il tailing in tempo reale consente di visualizzare le voci di log in tempo reale mentre Cloud Logging le scrive. Per informazioni sul metodo API per il tailing in tempo reale, consulta il metodo entries.tail.

Il tailing in tempo reale non è supportato per i bucket di log con controlli dell'accesso a livello di campo, tuttavia puoi trasmettere i flussi di log per questi bucket in Esplora log.

Questo esempio illustra le voci di log del tailing live di un determinato logger.

Go

Per scoprire come installare e utilizzare la libreria client per Logging, vedi Librerie client di Logging.

Per eseguire l'autenticazione in Logging, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.

import (
	"context"
	"fmt"
	"io"

	logging "cloud.google.com/go/logging/apiv2"
	loggingpb "google.golang.org/genproto/googleapis/logging/v2"
)

// tailLogs creates a channel to stream log entries that were recently ingested for a project
func tailLogs(projectID string) error {
	// projectID := "your_project_id"

	ctx := context.Background()
	client, err := logging.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient error: %w", err)
	}
	defer client.Close()

	stream, err := client.TailLogEntries(ctx)
	if err != nil {
		return fmt.Errorf("TailLogEntries error: %w", err)
	}
	defer stream.CloseSend()

	req := &loggingpb.TailLogEntriesRequest{
		ResourceNames: []string{
			"projects/" + projectID,
		},
	}
	if err := stream.Send(req); err != nil {
		return fmt.Errorf("stream.Send error: %w", err)
	}

	// read and print two or more streamed log entries
	for counter := 0; counter < 2; {
		resp, err := stream.Recv()
		if err == io.EOF {
			break
		}
		if err != nil {
			return fmt.Errorf("stream.Recv error: %w", err)
		}
		fmt.Printf("received:\n%v\n", resp)
		if resp.Entries != nil {
			counter += len(resp.Entries)
		}
	}
	return nil
}

Java

Per scoprire come installare e utilizzare la libreria client per Logging, vedi Librerie client di Logging.

Per eseguire l'autenticazione in Logging, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.

import com.google.cloud.logging.LogEntry;
import com.google.cloud.logging.LogEntryServerStream;
import com.google.cloud.logging.Logging;
import com.google.cloud.logging.Logging.TailOption;
import com.google.cloud.logging.LoggingOptions;

public class TailLogEntries {

  public static void main(String[] args) throws Exception {
    // TODO(developer): Optionally provide the logname as an argument.
    String logName = args.length > 0 ? args[0] : "";

    LoggingOptions options = LoggingOptions.getDefaultInstance();
    try (Logging logging = options.getService()) {

      // Optionally compose a filter to tail log entries only from specific log
      LogEntryServerStream stream;

      if (logName != "") {
        stream =
            logging.tailLogEntries(
                TailOption.filter(
                    "logName=projects/" + options.getProjectId() + "/logs/" + logName));
      } else {
        stream = logging.tailLogEntries();
      }
      System.out.println("start streaming..");
      for (LogEntry log : stream) {
        System.out.println(log);
        // cancel infinite streaming after receiving first entry
        stream.cancel();
      }
    }
  }
}

Node.js

Per scoprire come installare e utilizzare la libreria client per Logging, vedi Librerie client di Logging.

Per eseguire l'autenticazione in Logging, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per un ambiente di sviluppo locale.

const {Logging} = require('@google-cloud/logging');
const logging = new Logging();

/**
 * TODO(developer): Replace logName with the name of your log.
 */
const log = logging.log(logName);
console.log('running tail log entries test');

const stream = log
  .tailEntries({
    filter: 'timestamp > "2021-01-01T23:00:00Z"',
  })
  .on('error', console.error)
  .on('data', resp => {
    console.log(resp.entries);
    console.log(resp.suppressionInfo);
    // If you anticipate many results, you can end a stream early to prevent
    // unnecessary processing and API requests.
    stream.end();
  })
  .on('end', () => {
    console.log('log entry stream has ended');
  });

// Note: to get all project logs, invoke logging.tailEntries