Como gerar registros e visualizar registros no Cloud Run

Nesta página, descrevemos os registros disponíveis ao usar o Cloud Run e como visualizá-los e gravá-los.

O Cloud Run tem vários tipos de registros, que são enviados automaticamente para o Cloud Logging:

• Registros de solicitação (somente serviços): registros de solicitações enviadas para os serviços do Cloud Run. Esses registros são criados automaticamente.
• Registros de contêiner (serviços, jobs e pools de workers): registros emitidos pelas instâncias, normalmente do próprio código, gravados em locais compatíveis, conforme descrito em Como gravar registros de contêiner.
• Registros do sistema (serviços, jobs e pools de workers): registros gerados pela plataforma que contêm informações sobre suas cargas de trabalho. Esses registros são gravados em varlog/system.

Como visualizar registros

É possível ver registros do serviço, job ou pool de workers de várias maneiras:

• Usar a página do Cloud Run no Google Cloud console
• Usando a CLI do Google Cloud CL para ver registros pela gcloud (apenas serviços)

• Usar a Análise de registros do Cloud Logging no Google Cloud console
• Usar o Cloud Code (somente serviços)

Os dois métodos de console da visualização de registros examinam os mesmos registros armazenados no Cloud Logging, mas o explorador de registros do Cloud Logging fornece mais detalhes e mais recursos de filtragem.

Ver registros no Cloud Run

É possível conferir os registros na página do Cloud Run para os seguintes recursos:

• Serviços
• Jobs

• Pools de workers

Ver registros de um serviço

1. No console do Google Cloud , acesse a página Serviços do Cloud Run:

   Acessar o Cloud Run

2. Clique no serviço na lista exibida.

3. Clique na guia Registros para receber os registros de solicitação e contêiner para todas as revisões desse serviço. É possível filtrar por nível de gravidade de registro.

Ver registros de um job

Para visualizar os registros na página do Cloud Run, siga estas etapas:

1. No console Google Cloud , acesse a página Jobs do Cloud Run:

   Acessar o Cloud Run

2. Localize o job na lista e clique nele.

3. Clique na guia Registros para acessar os registros do contêiner de todas as execuções desse job. É possível filtrar por nível de gravidade de registro.

4. Como alternativa, se você quiser ver os registros pré-filtrados de uma execução de job específica, clique na execução do job e na guia Registros.

Ver registros de um pool de workers

Para ver os registros do pool de workers na página do Cloud Run:

1. No console Google Cloud , acesse a página Pools de trabalhadores do Cloud Run:

   Acessar o Cloud Run

2. Clique no pool de workers na lista exibida.

3. Clique na guia Registros para receber os registros de solicitação e contêiner para todas as revisões desse pool de trabalhadores. É possível filtrar por nível de gravidade de registro.

Ver registros de serviços usando a Google Cloud CLI

É possível usar a Google Cloud CLI para visualizar os registros de cauda ou ler os registros de um serviço do Cloud Run na linha de comando Por padrão, os registros são formatados em uma linha e otimizados para o console.

Para acompanhar os registros, instale o componente log-streaming na Google Cloud CLI. Se o componente não estiver instalado, você vai receber uma solicitação para instalá-lo quando necessário.

Ver os registros de cauda na linha de comando

Para um serviço do Cloud Run, é possível acompanhar os registros do serviço do Cloud Run em tempo real diretamente na linha de comando:

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

Substitua:

• SERVICE: o nome do serviço do Cloud Run.
• PROJECT-ID: o ID do projeto do Google Cloud . Para ver o ID do projeto, execute o comando gcloud config get-value project.

Ler registros na linha de comando

Para um serviço do Cloud Run, é possível ler os registros de duas maneiras:

• Em um formato otimizado para o console:

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

• Diretamente do Cloud Logging:

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

Substitua:

• SERVICE: o nome do serviço do Cloud Run.
• PROJECT-ID: o ID do projeto do Google Cloud . Para ver o ID do projeto, execute o comando gcloud config get-value project.

Ver registros no Cloud Logging

Para ver os registros do Cloud Run no Explorador de registros do Cloud Logging:

1. Acesse a página do Logs Explorer no console doGoogle Cloud :

   Acessar a página Análise de registros

2. Selecione um projeto Google Cloud na parte de cima da página ou crie um novo.

3. Usando os menus suspensos, selecione o recurso:

   • Revisão do Cloud Run para um serviço
   • Job do Cloud Run para um job
   • Pool de workers do Cloud Run para um pool de workers

Para mais informações, consulte Como usar a Análise de registros.

Ver os registros de serviços no Cloud Code

Para visualizar registros no Cloud Code, leia os guias do IntelliJ e do Visual Studio Code.

Ler registros de maneira programática

Se você quiser ler os registros de maneira programática, use um destes métodos:

• Use um coletor de registros para o Pub/Sub e um script para receber do Pub/Sub.
• Chame a API Logging usando as bibliotecas de cliente da linguagem de programação sendo usada.
• Chame diretamente os endpoints da API REST do Logging.

Formato e conteúdo dos registros de escalonamento de instâncias

Quando novas instâncias são iniciadas para seu serviço do Cloud Run, o Cloud Logging inclui entradas de registro no nome de registro varlog/system explicando por que cada instância foi criada. A entrada de registro segue este formato:

Starting new instance. Reason: REASON - DESCRIPTION

A tabela a seguir mostra um detalhamento das descrições de instâncias:

Gravar registros de contêiner

Quando você grava registros do seu serviço, job ou pool de trabalhadores, eles são coletados automaticamente pelo Cloud Logging, desde que os registros sejam gravados em qualquer um dos seguintes locais:

• Streamings de saída padrão (stdout) ou de erro padrão (stderr)
• Todos os arquivos no diretório /var/log
• syslog (/dev/log)
• Registros gravados usando as bibliotecas de cliente do Cloud Logging, disponíveis para muitas linguagens conhecidas

Espera-se que a maioria dos desenvolvedores grave registros usando a saída e o erro padrão.

Os registros de contêiner gravados nesses locais compatíveis são associados automaticamente ao serviço, à revisão e ao local do Cloud Run, ao pool de trabalhadores, à revisão e ao local do Cloud Run ou ao job do Cloud Run. As exceções contidas nos registros são capturadas e informadas no Error Reporting.

A geração de registros integrada equilibra confiabilidade e uso de recursos e funciona para a maioria dos aplicativos. A gravação de entradas de registro usando o registro integrado não consome a cota do número de solicitações entries.write por minuto da API Cloud Logging.

Se o aplicativo tiver requisitos para maior volume ou confiabilidade, recomendamos usar a API Cloud Logging diretamente, seja como uma biblioteca no aplicativo ou como um contêiner de arquivo secundário separado.

Como usar texto simples ou JSON estruturado nos registros

Ao gravar registros, é possível enviar uma string de texto simples ou uma única linha de JSON serializado, também chamado de dados "estruturados". Ela é selecionada e analisada pelo Cloud Logging e colocada em jsonPayload. Por outro lado, a mensagem de texto simples é colocada em textPayload.

Gravar registros estruturados

O snippet a seguir mostra como gravar entradas de registro estruturadas. Ele também mostra como correlacionar mensagens de registro com o registro de solicitação correspondente.

// 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));

# 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))

// Entry defines a log entry.
type