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

Ce document explique comment afficher les données de journaux et les données d'erreur dans vos tableaux de bord personnalisés.

Pour afficher les données des journaux, vous pouvez ajouter les widgets suivants à votre tableau de bord:

Pour afficher les entrées de journal les plus récentes de votre projet Google Cloud en cours, ajoutez un widget de panneau de journaux. Vous pouvez également configurer le panneau des journaux pour afficher les entrées de journal stockées dans les projets Google Cloud accessibles via le champ d'application des métriques actuel.
Pour identifier des modèles et des tendances dans vos données de journaux, ajoutez un widget de graphique d'Analyse de journaux qui affiche les résultats d'une requête SQL.

Pour afficher les groupes d'erreurs, vous pouvez ajouter un panneau de création de rapports d'erreurs. Le panneau Error Reporting affiche les groupes d'erreurs les plus récents pour un seul projet Google Cloud.

Lorsque vous ajoutez un panneau de journaux et un panneau de création de rapports d'erreurs à un tableau de bord personnalisé, vous pouvez afficher vos journaux et vos erreurs dans le même contexte que vos métriques. Étant donné que le panneau "Journaux" vous permet de filtrer les entrées de journal, vous pouvez le configurer pour n'afficher que les entrées de journal qui vous intéressent. De même, le panneau Error Reporting vous permet d'identifier les erreurs et de corriger la cause de l'échec.

Explorateur de journaux et panneaux de journaux

L'explorateur de journaux est la méthode standard pour examiner les journaux. Les panneaux de journaux ne remplacent pas l'explorateur de journaux. À la place, ils permettent d'afficher les entrées de journal dans le même contexte que vos métriques.

Les panneaux "Journaux" affichent les entrées de journal sur des lignes avec des colonnes pour la gravité, l'horodatage 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 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ésumé affiche des informations sur le service, une adresse e-mail et une version de la structure JSON de l'entrée sous forme de chaîne. La deuxième entrée affiche les résultats d'une requête et n'inclut qu'une phrase résumant l'action qui s'est produite.

Les panneaux de journaux sont préconfigurés pour afficher les entrées de journal stockées dans votre projet Google Cloud actuel. Toutefois, vous pouvez configurer un panneau de journaux pour afficher les entrées de journal stockées dans n'importe quel projet dans le champ d'application des métriques actuel.

Les panneaux de journaux sont compatibles avec le même langage de requête que l'explorateur de journaux.

Les panneaux de journaux ne sont pas compatibles avec les vues de stockage. Lorsque vos journaux ne sont disponibles que via une vue de stockage, utilisez l'explorateur de journaux. Pour en savoir plus sur les vues de stockage, consultez la section Affiner le champ d'application.

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

Avant de commencer

Pour obtenir les autorisations dont vous avez besoin pour ajouter un widget de journaux à un tableau de bord personnalisé à l'aide de la console Google Cloud, demandez à votre administrateur de vous attribuer les rôles IAM suivants sur votre projet:
- Éditeur Monitoring (roles/monitoring.editor)
- Lecteur de journaux (roles/logging.viewer) pour chaque projet dont vous souhaitez afficher les entrées de journal. Les tableaux de bord n'affichent pas les entrées de journal des projets pour lesquels vous ne disposez pas des autorisations nécessaires pour afficher les journaux. Pour en savoir plus sur les rôles requis pour afficher les entrées de journal, consultez la page Contrôle des accès Cloud Logging avec IAM.
Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.
Un tableau de bord peut contenir jusqu'à 40 widgets simultanément.

Panneau "Ajouter et configurer des journaux"

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

Ajouter un panneau de journaux

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

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Tableaux de bord :
Accédez à Tableaux de bord.
Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
Dans la barre d'outils, cliquez sur Ajouter un widget.
Dans la boîte de dialogue Ajouter un widget, sélectionnez Journaux.
(Facultatif) Mettez à jour la configuration par défaut :
1. Ajoutez un titre.
2. Pour afficher les journaux de plusieurs projets Google Cloud au lieu du seul projet en cours, cliquez sur Projets, puis effectuez vos sélections.
3. Pour limiter les journaux affichés par le panneau des journaux, saisissez une requête dans le champ Éditeur de requête.
Pour en savoir plus sur les étapes précédentes, consultez la section Configurer un panneau de journaux:
Pour appliquer vos modifications au tableau de bord, cliquez sur Apply (Appliquer) dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.
Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Par défaut, le panneau des journaux affiche une table d'entrées de journal. Vous pouvez utiliser le menu Gravité et les paramètres de la barre de filtre pour modifier temporairement les journaux affichés. Vous pouvez également modifier la taille et la position du panneau des journaux à l'aide de votre pointeur.

Configurer un panneau de journaux

Les panneaux de journaux sont préconfigurés pour afficher toutes les entrées de journal stockées dans le projet Google Cloud en cours. Toutefois, vous souhaitez peut-être ne consulter que des entrées de journal indiquant un certain type de condition d'erreur, ou afficher les journaux de plusieurs projets. Cette section explique comment modifier la configuration par défaut d'un panneau de journaux.

Pour configurer le titre, la liste des projets dont les journaux sont affichés, ou pour saisir une requête, procédez comme suit :

Placez le pointeur sur le panneau des journaux pour activer la barre d'outils, puis sélectionnez Modifier le widget.

La capture d'écran suivante illustre le volet de configuration:

$Exemple de volet de configuration d'un panneau de journaux.$
Facultatif: Ajoutez un titre qui apparaîtra dans le panneau des journaux.
Facultatif: Pour afficher les journaux de plusieurs projets Google Cloud, cliquez sur Projets , puis effectuez vos sélections.

Par défaut, seules les entrées de journal du projet Google Cloud actuel sont affichées. Toutefois, un panneau "Journaux" peut afficher les journaux de n'importe quel projet Google Cloud accessible via le champ d'application actuel des métriques.

Si vous ne disposez pas des autorisations nécessaires pour afficher les journaux d'un projet Google Cloud, le menu Projects (Projets) affiche le message "Vous ne disposez pas des autorisations nécessaires pour afficher les journaux de ce projet". Pour résoudre l'erreur d'autorisation, contactez votre administrateur système et demandez-lui de vous accorder le rôle Lecteur de journaux (roles/logging.viewer) sur le projet.
Facultatif: Pour limiter les journaux affichés par le panneau des journaux, 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 après avoir saisi votre requête.

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 active des menus supplémentaires et un bouton Ajouter après avoir sélectionné une ressource individuelle. Ce menu vous permet de sélectionner un type de ressource, un service pour un type de ressource spécifique ou une méthode pour un service pour un type de ressource. Par exemple, pour ajouter une clause pour le type de ressource auditée, sélectionnez Ressource auditée, puis Ajouter. 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 clause pour un service spécifique qui est audité, sélectionnez Ressource auditée, sélectionnez le service dans le menu Tous les services, puis sélectionnez Ajouter. Voici un exemple de clause créée suivant cette approche :
```
 resource.type="audited_resource" resource.labels.service="bigquery.googleapis.com"
```
Facultatif: appliquez des variables de modèle au panneau des journaux. Pour en savoir plus, consultez Ajouter des filtres temporaires à un tableau de bord personnalisé et Appliquer un filtre permanent à un widget.
Pour appliquer vos modifications au tableau de bord, cliquez sur Apply (Appliquer) dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.
Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Filtrer les entrées de journal

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

Sélecteur de temps du tableau de bord: la requête ne récupère que les entrées de journal écrites dans l'intervalle spécifié par ce champ.
Champ Filter (Filtre) 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 panneau des journaux: le filtre par niveau de gravité est appliqué une fois la requête exécutée. La valeur de ce champ n'est conservée que pour la session en cours.
Requête spécifiée par le panneau des journaux: le champ de requête détermine les journaux à récupérer. Si vous ne spécifiez pas de requête, tous les journaux de l'intervalle de temps sélectionné sont récupérés. Si vous spécifiez une requête, le 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, effectuez l'une des opérations suivantes:
- Pour modifier la requête de manière définitive, modifiez le panneau des journaux.
- Pour modifier temporairement la requête, ajoutez un filtre sur un libellé de ressource à l'aide de la barre d'outils du tableau de bord. Par exemple, si vous ajoutez le filtre cluster_name: mycluster au niveau du tableau de bord, la requête est mise à jour pour inclure resource.labels."cluster_name"="mycluster". Pour en savoir plus, consultez les sections Ajouter des filtres temporaires et Ajouter des filtres permanents.
Projet Google Cloud spécifié par le panneau des journaux. Pour modifier ce paramètre, modifiez le panneau des journaux.

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

Filtrer les entrées de journal par date

Pour afficher les journaux les plus récents dans un 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 panneau des journaux affiche toujours les journaux les plus récents, même s'ils datent d'une période antérieure à 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 panneau de journaux n'est pas automatiquement actualisé.

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 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 panneau de 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.

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. Cependant, 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.

Exemples de configurations

Voici quelques exemples de configurations :

Pour afficher les journaux les plus récents, définissez la barre d'outils du tableau de bord sur 1H, laissez le champ Éditeur de requête vide et laissez leurs valeurs par défaut pour les champs du panneau de journaux.
Pour afficher temporairement les journaux dont le niveau de gravité est au moins "Warning" (Avertissement), sélectionnez Avertissement dans le menu Gravité du panneau de journaux.

La valeur du menu Niveau de gravité du panneau de journaux est réinitialisée à la valeur par défaut lorsque vous actualisez la page ou que vous quittez le tableau de bord.
Pour configurer le panneau de journaux de façon à n'afficher que les journaux dont le niveau de gravité est "Warning" (Avertissement), ajoutez la clause severity=WARNING dans le champ Éditeur de requête.

La requête stockée dans le champ Éditeur de requête est enregistrée. Même lorsque vous actualisez la page ou actualisez le tableau de bord, le panneau de journaux n'affiche que les journaux correspondant au niveau d'avertissement spécifié.
Pour configurer le panneau des journaux de façon à n'afficher que les journaux des instances Compute Engine, ajoutez la clause resource.type="gce_instance" dans le champ Éditeur de requête.

Le message "Aucune entrée correspondant au filtre actuel trouvée" s'affiche lorsqu'aucune entrée de journal ne correspond aux paramètres actuels. Lorsque vous configurez une requête dans le champ Éditeur de requête et définissez également les filtres du panneau de journaux, il est possible que les paramètres entrent en conflit. Pour en savoir plus, consultez la section Le panneau de journaux affiche le message "Aucune entrée trouvée".

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

Les panneaux de 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 :

Sélectionnez Afficher dans l'explorateur de journaux dans le panneau de journaux.
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 panneau de journaux sont automatiquement appliqués.
Sélectionnez l'entrée de journal que vous souhaitez afficher.

Ajouter des graphiques générés à partir d'une requête d'Analyse de journaux

Cette section explique comment configurer et enregistrer un graphique généré à partir d'une requête d'Analyse de journaux 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 "Analyse de journaux" pour configurer et enregistrer des graphiques dans un tableau de bord, vous pouvez enregistrer un graphique d'Analyse de journaux directement dans Monitoring en procédant comme suit:

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Tableaux de bord :
Accédez à Tableaux de bord.
Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
Dans la barre d'outils, cliquez sur Ajouter un widget.
Dans la boîte de dialogue Ajouter un widget, accédez à la section Données, puis sélectionnez Analyse de journaux.
Dans le panneau Configure widget (Configurer le widget), configurez les données à afficher dans le graphique en créant une requête à l'aide de SQL, puis cliquez sur Run query (Exécuter la requête).
(Facultatif) Dans l'onglet Results (Résultats), personnalisez la configuration du graphique à l'aide du panneau Display (Affichage).

Dans le panneau Affichage, vous pouvez modifier le type de graphique, et personnaliser les lignes et les colonnes qui le sont en modifiant la dimension, la mesure et la répartition:
- Dimension : la dimension doit être une colonne d'horodatage, numérique ou de chaînes. Par défaut, la dimension est définie sur la première colonne basée sur l'horodatage 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 en tant que 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 indique l'évolution des données au fil du temps.
- Mesurer : 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.
- Répartition : pour diviser une série de données en plusieurs séries de données basées sur une autre colonne, ajoutez une répartition.
Pour en savoir plus sur la personnalisation de la configuration des graphiques, consultez Personnaliser la configuration des graphiques.
Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Vous pouvez également modifier les graphiques d'Analyse de journaux après les avoir enregistrés dans un tableau de bord. Pour en savoir plus, consultez la section Modifier la configuration d'un widget.

Cette section explique comment ajouter et configurer un panneau de création de rapports d'erreurs à l'aide de la console Google Cloud. Pour en savoir plus sur l'ajout d'un panneau de création de rapports 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 Error Reporting au tableau de bord à l'aide de la console, procédez comme suit:

Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis Tableaux de bord :
Accédez à Tableaux de bord.
Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
Dans la barre d'outils, cliquez sur Ajouter un widget.
Dans la boîte de dialogue Ajouter un widget, accédez à la section Visualisation, puis sélectionnez Panneau Error Reporting.
Sélectionnez le projet dont les groupes d'erreurs sont affichés, cliquez sur Projects (Projets), puis faites une sélection.
Facultatif: modifiez le titre.
Facultatif: Pour limiter les ressources pour lesquelles des erreurs s'affichent, procédez comme suit:
1. Cliquez sur Toutes les ressources et sélectionnez une ressource.
2. Après avoir sélectionné une ressource, vous pouvez sélectionner Apply (Appliquer) ou utiliser les menus supplémentaires pour affiner les critères de filtre:
  - Pour afficher les erreurs liées aux 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, choisissez le service, puis cliquez sur Appliquer.
Pour appliquer vos modifications au tableau de bord, cliquez sur Apply (Appliquer) dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.

L'exemple suivant présente un panneau de création de rapports d'erreurs:

$Exemple de volet de configuration d'un panneau de création de rapports d'erreurs.$
Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Résoudre les problèmes

Étapes suivantes

Pour en savoir plus sur la manière dont Cloud Monitoring offre une visibilité sur les métriques et les journaux stockés dans plusieurs projets Google Cloud, consultez la section Présentation du champ d'application des métriques.
Pour en savoir plus sur la configuration d'un panneau de journaux à l'aide de l'API Cloud Monitoring, consultez la section Tableau de bord avec un widget LogsPanel.
Pour en savoir plus sur les groupes d'erreurs, consultez la présentation d'Error Reporting.