Geração de registros estruturados

Neste documento, você verá o conceito de geração de registros estruturados e os métodos para adicionar uma estrutura aos campos de payload da entrada de registro. Quando o payload de registro é formatado como um objeto JSON e esse objeto é armazenado no campo jsonPayload, a entrada de registro é chamada de registro estruturado. Para esses registros, é possível criar consultas que pesquisam caminhos JSON específicos e indexar campos específicos no payload do registro. Por outro lado, quando o payload do registro é formatado como uma string e armazenado no campo textPayload, a entrada de registro é não estruturada. É possível pesquisar no campo de texto, mas não indexar o conteúdo dele.

Para criar entradas de registro estruturadas, faça o seguinte:

  • Chame o método de API entries.write e forneça um LogEntry totalmente formatado.
  • Use o comando gcloud logging write.
  • Use uma biblioteca de cliente do Cloud Logging que grava registros estruturados.
  • Use o serviço BindPlane.

  • Use um agente para gravar registros:

    • Alguns serviços do Google Cloud contêm um agente de geração de registros integrado que envia os dados gravados no stdout ou stderr como registros para o Cloud Logging. É possível usar essa abordagem para Google Cloud serviços como o Google Kubernetes Engine, o ambiente flexível do App Engine e o Cloud Run Functions.
    • Para máquinas virtuais (VMs) do Compute Engine, recomendamos que você instale e configure o Agente de operações para enviar registros estruturados ao Cloud Logging. Se as VMs atuais usarem o agente do Logging legado, observe que o suporte a ele foi encerrado. Para informações sobre alternativas de migração do agente legado do Logging, consulte o guia de migração ou consulte Geração de registros estruturada com o agente legado do Logging para informações sobre como usar o agente legado do Logging para gravar registros estruturados.

Para exemplos de código, consulte Como gravar registros estruturados.

Gravar registros usando a CLI gcloud

É possível gravar dados de registro usando a CLI gcloud. A interface aceita registros estruturados e não estruturados. Quando quiser gravar um registro estruturado, forneça ao comando um objeto JSON serializado.

Para um guia de início rápido, consulte Gravar e consultar entradas de registros com a Google Cloud CLI.

Para exemplos de código, consulte a referência gcloud logging write.

Gravar registros usando o BindPlane

É possível usar o serviço BindPlane para enviar registros ao Logging. Para esses registros, os payloads estão no formato JSON e são estruturados de acordo com o sistema de origem. Para informações sobre como encontrar e visualizar registros ingeridos usando o BindPlane, consulte o Guia de início rápido do BindPlane.

Gravar registros usando o Agente de operações

Para receber registros das instâncias do Compute Engine, use o Agente de operações. O Agente de operações combina geração de registros e métricas em um único agente, fornece uma configuração baseada em YAML e apresenta geração de registros de alta capacidade.

Para informações sobre como configurar o Agente de operações para oferecer suporte à geração de registros estruturados ou personalizar a forma de um registro estruturado, consulte Configurar o Agente de operações.

Resolver problemas

Para resolver problemas comuns encontrados durante a instalação ou a interação com o Agente de operações, consulte Solução de problemas do agente.

A seguir