Este documento aborda o conceito de registo estruturado e os métodos para adicionar estrutura aos campos de payload das entradas de registo. Quando o payload do registo é formatado como um objeto JSON e esse objeto é armazenado no campo jsonPayload
, a entrada do registo é denominada registo estruturado. Para estes registos, pode criar consultas que pesquisem caminhos JSON específicos e pode indexar campos específicos no payload do registo. Por outro lado, quando o payload do registo é formatado como uma string e armazenado no campo textPayload
, a entrada do registo é não estruturada.
Pode pesquisar o campo de texto, mas não pode indexar o respetivo conteúdo.
Para criar entradas de registo estruturadas, faça qualquer uma das seguintes ações:
- Chame o método da API
entries.write
e forneça umLogEntry
totalmente formatado. - Use o comando
gcloud logging write
.
- Use uma biblioteca cliente do Cloud Logging que escreve registos estruturados.
Para mais informações acerca destas abordagens, consulte as secções seguintes.
Escreva registos através das bibliotecas cliente ou da API
Pode escrever dados de registo através das
bibliotecas cliente do Cloud Logging, que
chamam a API Cloud Logging, ou chamando diretamente a API Cloud Logging.
As bibliotecas de cliente podem simplificar o preenchimento dos campos JSON especiais capturando automaticamente algumas informações e fornecendo interfaces para preencher os campos adequadamente. No entanto, para ter controlo total sobre a estrutura dos seus payloads, chame diretamente a API Cloud Logging e transmita a estrutura LogEntry
completa para a API Cloud Logging.
Para mais informações, consulte a referência entries.write
.
Para ver exemplos de código, consulte o artigo Escrever registos estruturados.
Escreva registos através da CLI gcloud
Pode escrever dados de registo através da CLI gcloud. A interface suporta registos não estruturados e registos estruturados. Quando quiser escrever um registo estruturado, forneça ao comando um objeto JSON serializado.
Para um início rápido, consulte o artigo Escreva e consulte entradas de registo com a CLI do Google Cloud.
Para ver exemplos de código, consulte a referência de
gcloud logging write
.
O que se segue?
Para consultar e ver entradas de registo, consulte o artigo Veja registos através do Explorador de registos.
Para ler entradas de registo através da CLI Google Cloud, consulte o artigo Ler entradas de registo.
Para ler entradas de registo através da API Logging, consulte o método
entries.list
.