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ées de journal. Lorsque la charge utile du journal est mise en forme en tant qu'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 indexer des champs spécifiques dans la charge utile du journal. En revanche, lorsque la charge utile du journal est mise en forme en tant que chaîne et stockée dans le champ textPayload, l'entrée de journal est non structurée. Vous pouvez effectuer des recherches 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 comme suit :

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

  • Utilisez un agent pour écrire des journaux :

    .
    • Certains services Google Cloud contiennent un agent de journalisation intégré qui envoie les données écrites dans stdout ou stderr en tant que journaux à Cloud Logging. Vous pouvez utiliser cette approche pour les services Google Cloud tels que Google Kubernetes Engine, l'environnement flexible App Engine et Cloud Run Functions.
    • Pour les machines virtuelles (VM) Compute Engine, nous vous recommandons d'installer et de configurer l'agent Ops pour envoyer des journaux structurés à Cloud Logging. Si vos VM existantes utilisent l'ancien agent Logging, notez que cet agent n'est plus compatible. Pour en savoir plus sur les alternatives de migration depuis l'ancien agent Logging, consultez le guide de migration ou Journalisation structurée avec l'ancien agent Logging pour en savoir plus sur l'utilisation de l'ancien agent Logging pour écrire des journaux structurés.

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

Écrire des journaux à l'aide de la gcloud CLI

Vous pouvez écrire des données de journaux à l'aide de gcloud CLI. L'interface est compatible avec les journaux non structurés et 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 Écrire et interroger des entrées de journal avec Google Cloud CLI.

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

Écrire des journaux à l'aide de BindPlane

Vous pouvez utiliser le service BindPlane pour envoyer des journaux à Logging. Pour ces journaux, les charges utiles sont au format JSON et sont structurées en fonction du système source. Pour savoir comment trouver et afficher les journaux ingérés à l'aide de BindPlane, consultez le guide de démarrage rapide de BindPlane.

Écrire des journaux à l'aide de l'agent Ops

Pour obtenir les journaux de vos instances Compute Engine, vous pouvez utiliser l'agent Ops. L'agent Ops combine la journalisation et les métriques dans un seul agent, fournit une configuration basée sur YAML et dispose d'une journalisation à haut débit.

Pour savoir comment configurer l'agent Ops afin qu'il prenne en charge la journalisation structurée ou pour personnaliser la forme d'un journal structuré, consultez Configurer l'agent Ops.

Résoudre les problèmes

Pour résoudre les problèmes courants rencontrés lors de l'installation ou de l'interaction avec l'agent Ops, consultez Résoudre les problèmes liés à l'agent.

Étapes suivantes