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 do registro é formatado
como um objeto JSON e esse objeto é armazenado no campo jsonPayload
, a entrada
de registro é chamada de registro estruturado. Para esses registros, você pode criar consultas
que pesquisam caminhos JSON específicos e pode 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 umLogEntry
totalmente formatado. - Use o comando
gcloud logging write
.
- Use uma biblioteca de cliente do Cloud Logging que grava registros estruturados.
Para mais informações sobre essas abordagens, consulte as seções a seguir.
Gravar registros usando bibliotecas de cliente ou a API
É possível gravar dados de registro usando as
bibliotecas de 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 adequadamente os campos. No entanto, para ter controle total sobre a
estrutura dos payloads, chame diretamente a API Cloud Logging e transmita a
estrutura completa de LogEntry
para a API Cloud Logging.
Para mais informações, consulte a referência de entries.write
.
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 oferece suporte a registros estruturados e não estruturados. Quando você 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 registro com a CLI do Google Cloud.
Para exemplos de código, consulte a
referência gcloud logging write
.
A seguir
Para consultar e visualizar entradas de registro, consulte Conferir registros usando o Explorador de registros.
Para ler entradas de registro usando a CLI do Google Cloud, consulte Como ler entradas de registro.
Para ler entradas de registro por meio da API Logging, consulte o método
entries.list
.