Journalisation structurée

Ce document traite du concept de journalisation structurée et des méthodes d'ajout d'une structure aux champs de charge utile des entrée de journal. Lorsque la charge utile du journal est au format d'objet JSON et que cet objet est stocké dans le champ jsonPayload, l'entrée de journal est appelée journal structuré. Pour ces journaux, vous pouvez créer des requêtes qui recherchent des chemins JSON spécifiques et vous pouvez indexer des champs spécifiques dans la charge utile du journal. En revanche, lorsque la charge utile du journal est au format de chaîne et stockée dans le champ textPayload, l'entrée de journal est non structurée. Vous pouvez effectuer une recherche dans le champ de texte, mais vous ne pouvez pas indexer son contenu.

Pour créer des entrées de journal structurées, procédez de l'une des manières suivantes :

  • Appelez la méthode d'API entries.write et fournissez un LogEntry entièrement mis en forme.
  • Utilisez la commande gcloud logging write.
  • Utilisez une bibliothèque cliente Cloud Logging qui écrit des journaux structurés.

Pour en savoir plus sur ces approches, consultez les sections suivantes.

Écrire des journaux à l'aide de bibliothèques clientes ou de l'API

Vous pouvez écrire des données de journal à l'aide des bibliothèques clientes Cloud Logging, qui appellent l'API Cloud Logging, ou en appelant directement l'API Cloud Logging. Les bibliothèques clientes peuvent simplifier la population des champs JSON spéciaux en capturant automatiquement certaines informations et en fournissant des interfaces pour remplir les champs de manière appropriée. Toutefois, pour contrôler entièrement la structure de vos charges utiles, appelez directement l'API Cloud Logging et transmettez la structure LogEntry complète à l'API Cloud Logging.

Pour en savoir plus, consultez la entries.write référence.

Pour obtenir des exemples de code, consultez la section Écrire des journaux structurés.

Écrire des journaux à l'aide de gcloud CLI

Vous pouvez écrire des données de journal à l'aide de gcloud CLI. L'interface est compatible avec les journaux non structurés et les journaux structurés. Lorsque vous souhaitez écrire un journal structuré, fournissez à la commande un objet JSON sérialisé.

Pour un guide de démarrage rapide, consultez la section Écrire et interroger des entrées de journal avec Google Cloud CLI.

Pour obtenir des exemples de code, consultez la gcloud logging write référence.

Étape suivante