Afficher les événements sur un tableau de bord

Ce document explique comment afficher des événements dans les graphiques d'un tableau de bord. Un événement est une activité, telle qu'un déploiement ou un plantage, qui affecte le fonctionnement d'un système. L'affichage d'événements peut vous aider à corréler des données provenant de différentes sources lorsque vous résolvez un problème.

Vous pouvez afficher des événements sur la plupart des tableaux de bord répertoriés sur la page Tableaux de bord de la console Google Cloud. De même, vous pouvez configurer certains onglets Observabilité spécifiques au service, tels que ceux de Compute Engine et Google Kubernetes Engine, pour afficher des événements. Pour configurer les types d'événements affichés par un tableau de bord ou un onglet Observabilité, vous pouvez utiliser la console Google Cloud. Pour les tableaux de bord personnalisés, vous pouvez également utiliser l'API Cloud Monitoring.

Comment les événements sont-ils identifiés ?

Les tableaux de bord interrogent différentes sources de données pour identifier les événements à afficher:

  • Les événements d'alerte sont identifiés par Monitoring. Les événements d'alerte fournissent des informations sur le moment où les incidents ont été ouverts.

  • Les événements personnalisés sont identifiés par des requêtes que Monitoring envoie à l'API Service Health. Ces événements indiquent s'il y a une interruption dans un service Google Cloud.

  • Tous les autres types d'événements sont identifiés en analysant les entrées de journal qui transitent par les récepteurs Cloud Logging de votre projet Google Cloud. Ces entrées de journal incluent celles générées par votre projet et celles acheminées vers celui-ci. Pour recevoir une notification lorsque l'un de ces événements se produit, vous pouvez créer une règle d'alerte basée sur les journaux. Dans la règle d'alerte, utilisez les requêtes fournies sur la page Types d'événements.

Mode d'affichage des événements

Pour tous les événements, à mesure qu'ils se produisent, les graphiques de votre tableau de bord sont annotés. Les événements identifiés par l'analyse des entrées de journal sont affichés avec une référence temporelle unique. En revanche, les événements Service Health sont affichés avec une heure de début, puis l'arrière-plan du graphique est modifié pendant toute la durée de l'événement. Ces événements sont également signalés par une icône en forme de cœur.

La capture d'écran suivante illustre un graphique présentant plusieurs événements identifiés lors de l'analyse des entrées de journal et un événement Service Health:

Graphique affichant les avertissements et les annotations d'événements informatifs.

Comme indiqué dans la capture d'écran précédente, l'info-bulle d'un événement inclut des informations telles que les suivantes:

  • Nom de l'événement
  • Date et heure de début de l'événement.
  • Pour les événements Service Health, des chips indiquant le nombre de produits et d'emplacements concernés. Pour lister les produits ou emplacements concernés, placez votre curseur sur le chip correspondant.
  • Un bouton Afficher qui, lorsqu'il est sélectionné, ouvre une page contenant plus d'informations sur l'événement. Par exemple, il peut ouvrir l'explorateur de journaux pour vous permettre d'afficher les entrées de journal, ou la page d'informations d'un événement Service Health.

Les filtres de tableau de bord, qui limitent les données affichées par un tableau de bord, filtrent généralement à la fois les données de séries temporelles et les événements.

Avant de commencer

  • Pour obtenir les autorisations nécessaires pour afficher et afficher des événements dans les tableaux de bord, ainsi que pour créer des règles d'alerte, demandez à votre administrateur de vous attribuer les rôles IAM suivants sur votre projet:

    • Affichez et créez des tableaux de bord et des règles d'alerte dans l'éditeur Monitoring (roles/monitoring.editor).
    • Affichez et affichez les événements identifiés à partir des entrées de journal autres que des accès aux données qui sont créées dans votre projet Google Cloud : Visionneuse de journaux (roles/logging.viewer).
    • Affichez et affichez les événements identifiés à partir des entrées de journal créées dans votre projet Google Cloud : Lecteur des journaux privés (roles/logging.privateLogViewer).
    • Afficher les événements Service Health : Lecteur Custom Service Health (roles/servicehealth.viewer)

    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.

  • Si vous souhaitez afficher les événements Service Health sur votre tableau de bord, activez l'API Service Health:

    Activer l'API

Afficher les événements

Cette section explique comment configurer un tableau de bord ou un onglet Observabilité pour afficher des événements.

Configurer des tableaux de bord pour afficher des événements

Cette section explique comment configurer les tableaux de bord répertoriés sur la page Tableaux de bord de la console Google Cloud pour afficher des événements.

Pour obtenir la liste des types d'événements, des références de dépannage et des requêtes pouvant être utilisées avec l'explorateur de journaux ou avec les règles d'alerte basées sur les journaux, consultez la page Types d'événements.

Console

Pour afficher des événements sur un tableau de bord, procédez comme suit:

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

    Accéder à Tableaux de bord

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

  2. Sélectionnez le tableau de bord que vous souhaitez afficher.

  3. Dans la barre d'outils du tableau de bord, assurez-vous que l'option Événements est activée.

    Si le bouton d'activation Événements n'est pas affiché, le tableau de bord ne peut pas afficher d'événements.

  4. Cliquez sur Sélectionner les types d'événements, sélectionnez les types d'événements que vous souhaitez afficher sur le tableau de bord, puis effectuez l'une des opérations suivantes:

    • Si vous consultez un tableau de bord personnalisé et que vous souhaitez enregistrer vos sélections de types d'événements, cliquez sur Épingler la sélection. Si l'enregistrement automatique est désactivé sur votre tableau de bord, accédez à la barre d'outils du tableau de bord et cliquez sur Enregistrer.

      Lorsque vous épinglez vos sélections, vous modifiez la définition JSON du tableau de bord. Par conséquent, lorsque le tableau de bord est rouvert, vos sélections sont chargées et le tableau de bord affiche des annotations pour les types d'événements correspondants.

    • Sinon, cliquez sur OK.

    Une fois la liste des types d'événements à afficher mise à jour, Cloud Monitoring émet des requêtes, ce qui prend quelques instants, puis ajoute les annotations aux graphiques du tableau de bord.

  5. Pour afficher le résumé d'un événement ou accéder à des liens vers des informations supplémentaires, activez l'info-bulle à l'aide de votre curseur.

API

Pour configurer un tableau de bord personnalisé afin d'afficher des événements, incluez un champ annotations dans l'objet Dashboard. Le champ annotations contient une instance d'un objet DashboardAnnotations, qui comprend deux champs:

  • Le champ defaultResourceName répertorie les valeurs par défaut au niveau du tableau de bord pour les projets Google Cloud dans lesquels rechercher des événements. Si vous ne spécifiez pas ce champ, la recherche est effectuée dans le projet sélectionné.

  • Tableau d'objets EventAnnotation. Chaque objet contient les éléments suivants:

    • Un champ displayName, qui vous permet de définir le libellé sur le bouton d'activation spécifique à l'événement. Si ce champ n'est pas spécifié ou si sa valeur est une chaîne vide, le nom par défaut de l'événement est affiché.
    • Un champ enabled qui contrôle la valeur du bouton d'activation de l'événement. Lorsque la valeur est true, le bouton d'activation est en position on et les événements sont affichés sur le tableau de bord. Lorsque la valeur est false, le bouton est en position off.
    • Un champ eventType, qui contient une valeur de l'énumération EventType.
    • Un champ filter, qui vous permet de spécifier une requête à ajouter à la requête spécifique à l'événement. Lorsque la valeur de ce champ est une chaîne vide, la requête spécifique à l'événement est utilisée.
    • Un champ resourceNames, qui vous permet de définir une liste de projets Google Cloud pour rechercher des événements. Lorsque ce champ est un tableau vide, la recherche est effectuée dans le projet sélectionné.

Vous trouverez ci-dessous un exemple d'objet annotations pour un événement de mise à jour de cluster. Dans cet exemple, le champ filter limite les événements à un cluster spécifique:

"annotations": {
  "defaultResourceNames": [],
  "eventAnnotations": [
    {
      "displayName": "",
      "enabled": true,
      "eventType": "GKE_CLUSTER_UPDATE",
      "filter": "resource.labels.cluster_name=my-cluster",
      "resourceNames": []
    }
  ]
}

Pour plus d'informations sur l'utilisation de l'API Cloud Monitoring pour créer des tableaux de bord, consultez les pages Créer et gérer des tableaux de bord à l'aide de l'API et Exemple: Activer des événements dans les tableaux de bord.

Configurer l'onglet Observabilité pour afficher les événements

Cette section explique comment configurer l'onglet Observabilité pour afficher des événements. Certains services, tels que Compute Engine et Google Kubernetes Engine, fournissent un onglet Observabilité qui affiche les données de métriques et de journaux.

Console

Pour configurer l'onglet Observabilité afin d'afficher les événements, procédez comme suit:

  1. Accédez à l'onglet Observabilité d'un service ou d'un produit.

    Par exemple, vous pouvez accéder à la page Clusters Kubernetes, puis sélectionner l'onglet Observabilité. De même, vous pouvez accéder à la page Charges de travail Kubernetes ou à la page des détails d'une instance de machine virtuelle (VM), puis sélectionner l'onglet Observabilité.

  2. Assurez-vous que le menu Tableau de bord est défini sur Prédéfini. Impossible d'afficher les événements dans les tableaux de bord personnalisés.

  3. Dans la barre d'outils, cliquez sur Select Events (Sélectionner des événements) et renseignez les champs de la boîte de dialogue.

    Une fois la liste des événements à afficher mise à jour, des requêtes sont émises pour récupérer les données d'événement, puis le tableau de bord est mis à jour.

    Lorsque le bouton Sélectionner des événements n'est pas affiché, l'onglet ne peut pas être configuré pour afficher les événements.

API

Non disponible.

Afficher les détails de l'événement

Lorsque vous consultez un graphique qui affiche des annotations d'événements, vous pouvez utiliser les liens fournis dans l'info-bulle pour accéder à des informations supplémentaires.

Pour accéder aux détails d'un événement spécifique, cliquez sur Afficher.

La page de la console Google Cloud ouverte par le bouton Afficher est déterminée par le type d'événement. Par exemple, pour un événement de test de disponibilité, ce bouton ouvre le tableau de bord du test de disponibilité. Pour un type d'événement différent, l'explorateur de journaux peut s'ouvrir.

Créer des règles d'alerte

Lorsque des événements sont identifiés en analysant les entrées de journal qui transitent par les récepteurs Cloud Logging dans votre projet Google Cloud, vous pouvez être averti lorsque ces événements se produisent en configurant une alerte basée sur les journaux. Les règles d'alerte basées sur les journaux interrogent les entrées de journal à mesure qu'elles sont reçues. Lorsque la requête renvoie un résultat non vide, un incident est créé et des notifications sont envoyées.

Console

Pour créer une alerte basée sur les journaux, procédez comme suit:

  1. Si vous n'avez pas configuré de canal de notification, procédez comme suit:

    1. Dans la console Google Cloud, accédez à la page  Alertes:

      Accéder à l'interface des alertes

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

    2. Cliquez sur Modifier le canal de notification.
    3. Accédez au type de canal de notification que vous souhaitez configurer, cliquez sur Add new (Ajouter), puis renseignez les champs de la boîte de dialogue.

  2. Dans la console Google Cloud, accédez à la page Explorateur de journaux :

    Accéder à l'explorateur de journaux

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

  3. Dans la barre d'outils, sélectionnez Créer une alerte.

  4. Saisissez un nom pour la règle d'alerte, puis cliquez sur Suivant.

  5. Dans la section Définir les entrées de journal sur lesquelles envoyer une alerte, saisissez une requête ou mettez à jour la requête copiée depuis le volet Requête lorsque vous avez sélectionné Créer une alerte.

    Pour chaque type d'événement, la page Types d'événements répertorie une requête adaptée à une règle d'alerte basée sur les journaux.

  6. Renseignez la boîte de dialogue, puis cliquez sur Enregistrer.

API

Pour créer une règle d'alerte basée sur les journaux à l'aide de l'API Cloud Monitoring, procédez comme suit:

  1. Identifiez la requête à inclure dans la condition de la règle d'alerte. Pour chaque type d'événement, la page Types d'événements répertorie une requête adaptée à une règle d'alerte basée sur les journaux.

  2. Créez le fichier JSON contenant la représentation de la règle d'alerte. Pour en savoir plus sur cette étape et obtenir un exemple, consultez la section Concevoir la règle d'alerte.

  3. Appelez la méthode API alertPolicies.create. Par exemple, vous pouvez émettre la commande gcloud alpha monitoring policies create.

Masquer les événements

Console

Pour masquer tous les événements, dans la barre d'outils du tableau de bord, assurez-vous que l'option Événements est désactivée.

Pour masquer un type d'événement, désactivez le bouton correspondant.

API

Pour masquer un type d'événement sur un tableau de bord personnalisé, recherchez l'objet EventAnnotation correspondant au type d'événement, puis définissez le champ enabled sur false.

Pour plus d'informations sur l'utilisation de l'API Cloud Monitoring, consultez Créer et gérer des tableaux de bord à l'aide de l'API.

Étapes suivantes