En este documento se explica el concepto de registro estructurado y los métodos para añadir estructura a los campos de carga útil de las entradas de registro. Cuando la carga útil del registro tiene el formato de un objeto JSON y ese objeto se almacena en el campo jsonPayload
, la entrada de registro se denomina registro estructurado. En estos registros, puede crear consultas que busquen rutas JSON específicas e indexar campos concretos en la carga útil del registro. Por el contrario, si la carga útil del registro tiene el formato de una cadena y se almacena en el campo textPayload
, la entrada de registro no está estructurada.
Puedes buscar en el campo de texto, pero no puedes indexar su contenido.
Para crear entradas de registro estructuradas, haz lo siguiente:
- Llama al método de API
entries.write
y proporciona unLogEntry
con el formato completo. - Usa el comando
gcloud logging write
.
- Usa una biblioteca de cliente de Cloud Logging que escriba registros estructurados.
Para obtener más información sobre estos enfoques, consulta las siguientes secciones.
Escribir registros mediante bibliotecas de cliente o la API
Puedes escribir datos de registro mediante las bibliotecas de cliente de Cloud Logging, que llaman a la API de Cloud Logging, o llamando directamente a la API de Cloud Logging.
Las bibliotecas de cliente pueden simplificar el proceso de rellenar los campos JSON especiales. Para ello, capturan automáticamente cierta información y proporcionan interfaces para rellenar los campos de forma adecuada. Sin embargo, para tener un control total sobre la estructura de tus cargas útiles, llama directamente a la API Cloud Logging y transfiere la estructura LogEntry
completa a la API Cloud Logging.
Para obtener más información, consulta la referencia de entries.write
.
Para ver ejemplos de código, consulta Escribir registros estructurados.
Escribir registros con gcloud CLI
Puedes escribir datos de registro con gcloud CLI. La interfaz admite registros estructurados y no estructurados. Si quieres escribir un registro estructurado, proporciona al comando un objeto JSON serializado.
Para ver una guía de inicio rápido, consulta Escribir y consultar entradas de registro con la CLI de Google Cloud.
Para ver ejemplos de código, consulta la referencia de gcloud logging write
.
Siguientes pasos
Para consultar y ver entradas de registro, consulta Ver registros con el Explorador de registros.
Para leer entradas de registro con Google Cloud CLI, consulta el artículo sobre cómo leer entradas de registro.
Para leer entradas de registro mediante la API Logging, consulta el método
entries.list
.