Avvio del flusso e tailing in tempo reale delle voci di log

Questo documento descrive come visualizzare le voci di log in tempo reale tramite lo streaming e il logging in tempo reale. Lo streaming dei log consente di visualizzare le voci di log in tempo reale ed è disponibile in Esplora log . Il logging 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 API Cloud Logging entries.tail.

Quando visualizzi e analizzi i log utilizzando Esplora log, gcloud logging read o il metodo API entries.list, visualizzi le voci di log archiviate da Cloud Logging. Quando esegui lo streaming o il logging in tempo reale delle voci di log, le visualizzi man mano che le applicazioni le scrivono nell'API Cloud Logging.

Eseguire lo streaming dei log in Esplora log

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

1. Nella Google Cloud console, vai alla pagina segmento Esplora log:

   Vai a Esplora log

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

2. Nel campo Query, inserisci una query e fai clic su Avvia flusso di log.

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

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

Utilizzare il logging in tempo reale in Google Cloud CLI

Il logging in tempo reale consente di visualizzare le voci di log in tempo reale man mano che Cloud Logging le scrive, utilizzando Google Cloud CLI o l'API Cloud Logging.

Il logging in tempo reale non è supportato per i bucket di log con controlli di accesso a livello di campo, ma puoi eseguire lo streaming dei log per questi bucket in Esplora log.

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

Installare gcloud alpha logging tail

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

Per istruzioni su come installare Python, consulta la pagina Python. Per istruzioni su come installare il gestore dei pacchetti Python, pip, necessario per installare il grpcio pacchetto, consulta la pagina 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, vedi Installare Google Cloud CLI.

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

   gcloud version
   

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

3. Installa i componenti alpha di 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
      

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

   gcloud config set project PROJECT_ID
   gcloud auth login
   

   Per ottenere l'ID progetto, vedi Creare e gestire i progetti.

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

   gcloud alpha logging tail
   

   Il comando visualizza il seguente messaggio:

   Initializing tail session.

   Ora puoi visualizzare le voci di log per il tuo Google Cloud progetto man mano che Logging le scrive.

   

Per saperne di più sull'utilizzo del logging in tempo reale, consulta la gcloud alpha logging tail guida di riferimento.

Buffer e ordinamento

Poiché Logging può ricevere voci di log in ordine cronologico, il logging in tempo reale fornisce un'impostazione della finestra del buffer per bilanciare il compromesso tra la visualizzazione delle voci di log man mano che vengono scritte e la visualizzazione in ordine crescente. Puoi impostare la finestra del buffer tra 0 e 60 secondi.

Tieni presente le seguenti caratteristiche della finestra del buffer:

• La finestra del buffer predefinita è di due secondi.

• 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 così come vengono ricevute.

Quando configuri la finestra del buffer, devi trovare un compromesso tra la visualizzazione dei log man mano che vengono scritti e la visualizzazione delle voci in ordine non corretto.

Limiti e quote

La tabella seguente elenca i limiti e le quote per il logging in tempo reale:

Limitazioni del client

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

Utilizzare il logging in tempo reale con le librerie client

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

Il logging in tempo reale non è supportato per i bucket di log con controlli di accesso a livello di campo, ma puoi eseguire lo streaming dei log per questi bucket in Esplora log.

Questo esempio mostra le voci di log in tempo reale di un determinato logger.

import (
	"context"
	"fmt"
	"io"

	logging "cloud.google.com/go/logging/apiv2"
	"cloud.google.com/go/logging/apiv2/loggingpb"
)

// 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
}

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();
      }
    }
  }
}

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