Afficher les journaux et les erreurs dans un tableau de bord personnalisé

Ce document décrit les widgets que vous pouvez ajouter à vos tableaux de bord personnalisés afin d'afficher vos données de journal et d'erreur dans le même contexte que vos données de métrique. Le widget du panneau des journaux affiche les entrées de journal. Le widget du panneau de signalement des erreurs affiche les groupes d'erreurs les plus récents. Ces deux widgets fournissent des informations qui peuvent être utiles pour résoudre les problèmes. Le widget de graphique Log Analytics, qui affiche les résultats d'une requête SQL, vous permet d'identifier les tendances dans vos données de journal.

Explorateur de journaux et widget de panneau de journaux

L'explorateur de journaux est la méthode standard pour examiner les journaux. L'ajout d'un widget de panneau de journaux à un tableau de bord ne modifie pas la façon dont vous utilisez l'explorateur de journaux. Étant donné que les widgets de panneau de journaux peuvent être ajoutés aux tableaux de bord personnalisés, ils permettent d'afficher vos entrées de journal dans le même contexte que vos métriques.

L'explorateur de journaux et le widget du panneau des journaux sont compatibles avec le même langage de requête. Ils n'affichent que les entrées de journal que vous êtes autorisé à consulter. Vos rôles IAM (Identity and Access Management) sur les ressources qui stockent les entrées de journal déterminent si vous pouvez afficher les entrées de journal stockées.

L'explorateur de journaux et le widget du panneau des journaux sont tous deux préconfigurés pour rechercher des entrées de journal dans les ressources listées dans le champ d'action des journaux par défaut. Si ce champ d'application n'est pas accessible, ils recherchent les entrées de journal provenant du projet sélectionné. Lorsqu'un projet est sélectionné, les résultats de recherche incluent les entrées de journal qui sont acheminées vers le projet par un récepteur dans un autre projet, puis stockées dans un bucket de journaux. Vous pouvez configurer les ressources pour lesquelles des entrées de journal sont recherchées. Par exemple, vous pouvez rechercher des entrées de journal par vue de journal.

Les widgets du panneau "Journaux" affichent une entrée de journal par ligne, avec des colonnes pour la gravité, le code temporel et un résumé de l'entrée de journal. Pour afficher la représentation au format JSON d'une entrée de journal, cliquez sur le bouton Afficher les détails du journal. La structure de chaque résumé d'entrée varie en fonction du type de journal. Par exemple, l'image suivante montre deux entrées de journal:

Image de deux entrées de journal dans le widget du panneau des journaux.

Dans l'image précédente, la première entrée de journal affiche des informations sur une requête de service. Le récapitulatif affiche des informations sur le service, une adresse e-mail et une version formatée en chaîne de la structure JSON de l'entrée. La deuxième entrée affiche les résultats d'une requête et ne contient qu'une phrase résumant l'action qui s'est produite.

Pour obtenir des informations générales sur Cloud Logging, consultez les ressources suivantes :

Avant de commencer

Pour obtenir les autorisations nécessaires pour ajouter un widget de panneau des journaux à un tableau de bord personnalisé à l'aide de la console Google Cloud, et pour le configurer afin d'afficher les entrées de journal dans des projets ou des vues de journal, demandez à votre administrateur de vous accorder les rôles IAM suivants:

Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Afficher les entrées de journal sur un tableau de bord

Cette section explique comment ajouter et configurer un widget de panneau de journaux à l'aide de la console Google Cloud. Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring, consultez la section Tableau de bord avec un widget LogsPanel.

Un tableau de bord peut contenir jusqu'à 40 widgets simultanément.

Pour ajouter un widget de panneau des journaux au tableau de bord à l'aide de la console, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Tableaux de bord .

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
  3. Dans la barre d'outils, cliquez sur  Ajouter un widget.
  4. Dans la boîte de dialogue Ajouter un widget, sélectionnez  Journaux.
  5. Facultatif: Pour modifier le titre, saisissez le nouveau titre dans le champ Titre du widget.

  6. Configurez les ressources pour lesquelles des entrées de journal sont recherchées:

    • Pour effectuer une recherche par projet, définissez l'entrée Champ d'application sur Projet, puis développez l'entrée Projets et remplissez la boîte de dialogue.

      Le menu Projects (Projets) répertorie tous les projets Google Cloud du champ d'application des métriques actuel. Si une entrée du menu inclut le texte "Vous ne disposez pas des autorisations nécessaires au niveau du projet pour afficher les journaux de ce projet", cela signifie que vous ne disposez pas des autorisations requises pour afficher les entrées de journal disponibles dans ce projet Google Cloud.

      Les entrées de journal affichées incluent celles qui proviennent de votre projet Google Cloud et celles qui y sont acheminées par un récepteur dans un autre projet.

    • Pour rechercher des entrées de journal par vues de journaux sur des buckets de journaux, définissez l'entrée Champ d'application sur Stockage, puis développez l'entrée Vues de stockage et remplissez la boîte de dialogue.

      Le menu Vues de stockage liste les vues de journaux sur les buckets de journaux de votre projet Google Cloud sélectionné.

      Pour sélectionner des vues de journaux sur des buckets de journaux dans d'autres projets Google Cloud, dans le menu, cliquez sur Importer un projet, sélectionnez un projet, puis une ou plusieurs vues de journaux. Vous ne pouvez importer que les projets inclus dans le champ d'application des métriques actuel.

    • Pour rechercher les ressources incluses dans un champ d'application des journaux, qui peut inclure des projets et des vues de journal, définissez l'entrée Champ d'application sur Champ d'application des journaux, puis développez l'entrée Champs d'application des journaux et sélectionnez un champ d'application des journaux.

      Les portées de journalisation sont disponibles en version Preview publique.

  7. Facultatif: Pour limiter les journaux que le widget du panneau des journaux affiche, saisissez une requête dans le champ Éditeur de requête. Si vous avez désactivé l'exécution automatique des requêtes, cliquez sur Exécuter la requête. Pour obtenir une brève présentation des requêtes, consultez la section Exemples de requêtes.

  8. Facultatif: Appliquez des variables au widget du panneau des journaux. Les variables sont des filtres au niveau du tableau de bord qui ne s'appliquent qu'à des widgets spécifiques. Pour en savoir plus, consultez la section Appliquer une variable à un widget.

  9. Pour appliquer vos modifications au tableau de bord, cliquez sur Appliquer dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.

  10. Pour enregistrer le tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

    Le widget du panneau "Journaux" affiche un tableau d'entrées de journal. Vous pouvez également utiliser la barre de filtre du widget pour modifier temporairement les entrées de journal qu'il affiche. Pour en savoir plus, consultez la section Filtrer les entrées de journal.

Exemples de requêtes

Pour renseigner le champ Éditeur de requête, vous pouvez saisir du texte dans le champ ou effectuer des sélections dans les menus. Le champ Éditeur de requête utilise le même langage de requête que l'explorateur de journaux. Pour obtenir des informations de dépannage, consultez la section Problèmes de syntaxe.

Les menus Gravité et Nom du journal vous permettent de sélectionner plusieurs options. Voici un exemple d'instruction de requête correspondant à plusieurs niveaux de gravité :

severity=(WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY)

Le menu Ressource vous permet de filtrer par ressource. Vous pouvez sélectionner un type de ressource, comme Ressource auditée, ou parcourir les fenêtres pour sélectionner une méthode spécifique.

Par exemple, pour ajouter une requête pour Ressource auditée, procédez comme suit:

  1. Développez le menu Ressource.
  2. Recherchez et sélectionnez Ressource auditée.

  3. Cliquez sur Appliquer.

    Cette procédure permet d'ajouter la clause suivante au champ Éditeur de requête:

    resource.type="audited_resource"

De même, pour ajouter une requête pour les journaux d'audit des fonctions Cloud Run, procédez comme suit:

  1. Développez le menu Ressource.
  2. Recherchez et sélectionnez Ressource auditée.
  3. Dans le menu des services, sélectionnez Cloud Functions.

  4. Cliquez sur Appliquer.

    Cette procédure permet d'ajouter la clause suivante au champ Éditeur de requête:

    resource.type="audited_resource" resource.labels.service="cloudfunctions.googleapis.com"

Filtrer les entrées de journal

Vous pouvez modifier les entrées de journal affichées par un widget de panneau de journaux en modifiant les valeurs des champs ou des menus suivants:

  • Sélecteur de temps du tableau de bord: le widget du panneau des journaux ne récupère que les entrées de journal écrites dans l'intervalle spécifié par ce champ.

  • Champ Filtre du widget du panneau des journaux : le filtre que vous spécifiez est appliqué une fois la requête terminée. La valeur de ce champ n'est conservée que pour la session en cours.

  • Menu Gravité du widget du panneau des journaux: le filtre par niveau de gravité est appliqué une fois la requête terminée. La valeur de ce champ n'est conservée que pour la session en cours.

  • Requête dans le widget du panneau des journaux: le widget du panneau des journaux n'affiche que les entrées de journal correspondant à la requête. Si vous ne spécifiez pas de requête, tous les journaux de l'intervalle de temps sélectionné s'affichent. Si vous spécifiez une requête, le widget du panneau des journaux affiche une icône Afficher la requête, qui affiche la requête actuelle sous forme d'info-bulle.

    Pour modifier la requête, modifiez le widget du panneau des journaux.

  • Projet Google Cloud dans le widget du panneau des journaux: pour modifier ce paramètre, modifiez le widget du panneau des journaux.

  • Filtres du tableau de bord: lorsque des filtres de tableau de bord existent, le paramètre de filtre est appliqué à la requête du widget du panneau des journaux. Par exemple, si vous ajoutez le filtre de tableau de bord cluster_name: mycluster, la requête est mise à jour pour inclure resource.labels."cluster_name"="mycluster". Pour en savoir plus sur les filtres de tableau de bord, consultez les sections Ajouter des filtres temporaires et Ajouter des filtres permanents.

Le reste de cette section fournit des informations supplémentaires sur le filtrage de vos entrées de journal.

Exemple: Filtrer les entrées de journal par date

Pour afficher les journaux les plus récents dans un widget de panneau de journaux, utilisez les champs temporels dans la barre d'outils du tableau de bord. Par exemple, sélectionnez 1H. Si vous ne sélectionnez pas de période personnalisée, le widget affiche toujours les journaux les plus récents, même s'ils sont plus anciens que la période sélectionnée.

Lorsque vous enquêtez sur un incident, vous pouvez limiter les entrées de journal aux entrées situées dans un intervalle de temps spécifique. Pour configurer les entrées de journal de façon à afficher les journaux dans un intervalle de temps fixe, effectuez l'une des opérations suivantes, ou les deux :

  • Sélectionnez une période à l'aide du sélecteur de période.
  • Saisissez une clause timestamp dans le champ Éditeur de requête du volet de configuration, puis sélectionnez Appliquer le filtre.

Lorsque vous spécifiez un intervalle de temps, le widget du panneau des journaux n'est pas automatiquement actualisé.

Exemple: Filtrer les entrées de journal par gravité

Lorsque vous surveillez le débogage d'un cas de défaillance, vous souhaiterez peut-être afficher uniquement les messages d'erreur et masquer toutes les autres entrées de journal. Pour configurer un widget de panneau de journaux de façon à n'afficher que les entrées de journal répondant à des niveaux de gravité spécifiques, effectuez l'une des opérations suivantes, ou les deux:

  • Pour appliquer un filtre temporaire, sélectionnez une valeur pour le menu Gravité dans le widget du panneau des journaux. Ce menu spécifie un niveau de gravité minimal. Par exemple, la valeur "Warning" (Avertissement) entraîne la récupération des entrées de journal dont le niveau de gravité est "Error" (Erreur), mais les entrées de journal dont le niveau de gravité est "Notice" (Remarque) ne sont pas récupérées. Par défaut, la valeur de ce champ est définie sur Default, ce qui inclut toutes les entrées de journal.

    Le paramètre du menu Gravité est supprimé lorsque vous quittez le tableau de bord.

  • Pour appliquer un filtre permanent, saisissez une clause severity dans le champ Éditeur de requête du volet de configuration, puis sélectionnez Appliquer le filtre.

Exemple: Filtrer les entrées de journal par chaîne ou expression

Le filtrage des entrées de journal par chaîne ou expression spécifique vous permet d'exclure les entrées de journal qui ne présentent pas d'intérêt. Par exemple, pour afficher les entrées de journal comprenant une adresse e-mail spécifique, vous pouvez appliquer un filtre basé sur cette adresse.

  • Pour appliquer un filtre temporaire et n'afficher que les entrées de journal contenant un mot ou une expression spécifique, utilisez le champ Filtre . Le test "contient" n'est pas sensible à la casse.

    Si vous ajoutez plusieurs filtres, seuls les journaux correspondant à tous les filtres sont affichés, car un AND implicite est inséré entre les filtres adjacents. Toutefois, vous pouvez insérer explicitement un opérateur OR:

    • Par exemple, lorsque vous ajoutez les filtres Get et Compute, les entrées de journal contenant les deux mots sont affichées.

    • Par exemple, lorsque vous ajoutez les filtres Get, OR et Compute, les entrées de journal contenant Get ou Compute sont affichées.

    La valeur du champ Filtre n'est pas persistante.

  • Pour appliquer un filtre permanent, modifiez la requête stockée dans le champ Éditeur de requête, puis sélectionnez Appliquer le filtre. Pour en savoir plus sur la syntaxe des requêtes, consultez la page Langage de requête Logging.

    Par exemple, pour n'afficher que les entrées de journal avec un champ MESSAGE dont la valeur contient la chaîne "lamp", ajoutez la clause jsonPayload.MESSAGE:"lamp" au champ éditeur de requête.

Afficher les entrées de journal dans l'explorateur de journaux

Les widgets du panneau "Journaux" affichent les principaux champs des entrées de journal, mais pas l'entrée de journal complète. Pour examiner tous les champs d'une entrée de journal, procédez comme suit :

  1. Dans le widget du panneau des journaux, sélectionnez Afficher dans l'explorateur de journaux.

  2. Dans la boîte de dialogue, sélectionnez le projet Google Cloud dans lequel ouvrir l'explorateur de journaux.

    L'explorateur de journaux s'ouvre dans un nouvel onglet du navigateur et les filtres que vous avez sélectionnés dans le widget du panneau des journaux sont automatiquement appliqués.

  3. Sélectionnez l'entrée de journal que vous souhaitez afficher.

Afficher les graphiques générés à partir d'une requête Log Analytics

Cette section explique comment configurer et enregistrer un graphique généré à partir d'une requête Log Analytics dans un tableau de bord personnalisé. L'Analyse de journaux vous permet de rechercher et d'agréger des journaux pour générer des insights utiles à l'aide de requêtes SQL.

En plus d'utiliser la page Log Analytics pour configurer et enregistrer des graphiques dans un tableau de bord, vous pouvez enregistrer un graphique Log Analytics directement dans Monitoring en procédant comme suit:

  1. Dans la console Google Cloud, accédez à la page Tableaux de bord .

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
  3. Dans la barre d'outils, cliquez sur  Ajouter un widget.
  4. Dans la boîte de dialogue Ajouter un widget, accédez à la section Données, puis sélectionnez Log Analytics.

  5. Dans le panneau Configurer le widget, configurez les données à afficher, puis cliquez sur Exécuter la requête.

    Pour sélectionner les données à afficher, vous pouvez créer une requête SQL ou sélectionner une requête enregistrée ou récente.

  6. Facultatif: Dans l'onglet Résultats, personnalisez la configuration du graphique à l'aide du panneau Affichage.

    Dans le panneau Affichage, vous pouvez modifier le type de graphique et personnaliser les lignes et les colonnes à inclure dans le graphique en modifiant la dimension, la mesure et la répartition:

    • Dimension : la dimension doit être une colonne de code temporel, numérique ou de chaîne. Par défaut, la dimension est définie sur la première colonne basée sur un code temporel du schéma. Si aucun code temporel n'est présent dans la requête, la première colonne de chaîne est sélectionnée comme dimension. Vous pouvez également personnaliser la dimension dans le panneau Affichage du graphique. Lorsqu'une colonne d'horodatage est sélectionnée comme dimension, le graphique montre l'évolution des données au fil du temps.

    • Mesure : vous pouvez sélectionner plusieurs mesures dans le panneau Affichage du graphique. Lorsque vous sélectionnez une mesure, vous devez également sélectionner la fonction d'agrégation à effectuer sur ses valeurs groupées, telles que count, sum, average et percentile-99. Par exemple, count-distinct renvoie le nombre de valeurs uniques dans une colonne donnée.

    • Détail : pour diviser une série de données en plusieurs séries en fonction d'une autre colonne, ajoutez un détail.

    Pour en savoir plus sur la personnalisation de la configuration du graphique, consultez la section Personnaliser la configuration du graphique.

  7. Pour enregistrer le tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Les graphiques Log Analytics peuvent également être modifiés après avoir été enregistrés dans un tableau de bord. Pour en savoir plus, consultez la section Modifier la configuration d'un widget.

Afficher les erreurs dans un tableau de bord

Cette section explique comment ajouter et configurer un panneau de signalement d'erreurs à l'aide de la console Google Cloud. Pour en savoir plus sur l'ajout d'un panneau de signalement d'erreurs à un tableau de bord à l'aide de l'API Cloud Monitoring, consultez la section Tableau de bord avec un widget ErrorReportingPanel.

Pour ajouter un panneau de signalement d'erreurs au tableau de bord à l'aide de la console, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Tableaux de bord .

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
  3. Dans la barre d'outils, cliquez sur  Ajouter un widget.
  4. Dans la boîte de dialogue Ajouter un widget, accédez à la section Visualisation, puis sélectionnez Panneau Error Reporting.
  5. Sélectionnez le projet dont les groupes d'erreurs sont affichés, développez Projects (Projets), puis effectuez une sélection.
  6. Facultatif: Modifiez le titre.

  7. Facultatif: Pour limiter les ressources pour lesquelles des erreurs s'affichent, procédez comme suit:

    1. Développez Toutes les ressources, puis sélectionnez une ressource.

    2. Après avoir sélectionné une ressource, vous pouvez sélectionner Appliquer ou utiliser les menus supplémentaires pour affiner les critères de filtrage:

      • Pour afficher les erreurs des ressources App Engine, sélectionnez Services GAE, puis cliquez sur Appliquer.

      • Pour afficher les erreurs d'un service App Engine spécifique, sélectionnez Services GAE, sélectionnez le service, puis cliquez sur Appliquer.

  8. Pour appliquer vos modifications au tableau de bord, cliquez sur Appliquer dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.

    L'exemple suivant montre un panneau de signalement d'erreur:

    Exemple de volet de configuration d'un panneau de signalement d'erreurs.

  9. Pour enregistrer le tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Résoudre les problèmes

Étape suivante