Afficher les événements dans un tableau de bord

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

À propos des annotations d'événements

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

Sauf si vous utilisez l'API Cloud Monitoring ou effectuez une action pour enregistrer vos sélections de type d'événement, elles ne s'appliquent qu'à votre session en cours. Lorsque vous utilisez la console Google Cloud, épingler vos sélections les enregistre.

Pour obtenir la liste des types d'événements, des références de dépannage et d'autres informations, consultez la page Types d'événements.

Les types d'événements suivants peuvent être activés sur un tableau de bord Observabilité, même si vous n'avez sélectionné aucun type d'événement:

Lorsqu'un type d'événement est ajouté automatiquement, il s'agit d'un type d'événement recommandé. Vous pouvez conserver ces types d'événements à l'état recommandé et les enregistrer ou les ignorer, ce qui supprime la recommandation. Pour déterminer les types d'événements enregistrés, développez le menu Annotations, puis consultez la section Épinglés.

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 Surveillance. Les événements d'alerte fournissent des informations sur le moment où les incidents ont été ouverts.

  • Les événements personnalisés Service Health sont identifiés par requêtes envoyées par Monitoring à l'API Service Health. Ces événements indiquent qu'un service Google Cloud est perturbé.

  • Tous les autres types d'événements sont identifiés en analysant les entrées de journal qui passent par les récepteurs Cloud Logging dans votre projet Google Cloud. Ces entrées de journal incluent celles générées par votre projet et celles qui sont acheminées vers votre projet. 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.

Affichage des événements

Pour tous les événements, les graphiques de votre tableau de bord sont annotés au fur et à mesure de leur occurrence. Les événements identifiés en analysant les entrées de journal sont affichés avec une seule référence temporelle. En revanche, les événements Service Health sont affichés une heure de début, puis l'arrière-plan du graphique est modifié pendant 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 affichant plusieurs événements identifiés en analysant les entrées de journal et un événement d'état du service :

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

Comme le montre la capture d'écran précédente, l'info-bulle d'un événement inclut les éléments suivants : les informations 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 des produits et des zones géographiques concernés. Pour afficher la liste des produits ou des établissements concernés, placez votre pointeur sur le chip correspondant.
  • Un bouton Afficher qui, lorsqu'il est sélectionné, permet d'ouvrir une page des informations sur l'événement. Par exemple, il peut ouvrir l'explorateur de journaux pour que vous puissiez afficher les entrées de journal, ou la page d'informations d'un événement de santé du service.

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, et pour créer des règles d'alerte, demandez à votre administrateur de vous accorder le les rôles IAM suivants sur votre projet:

    • Afficher et créer des tableaux de bord et des règles d'alerte: Éditeur Monitoring (roles/monitoring.editor)
    • Affichez les événements identifiés à partir des entrées de journal autres que celles d'accès aux données 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 de disponibilité des services : Afficheur de la disponibilité des services personnalisée (roles/servicehealth.viewer)

    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.

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

    Enable the 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 listés sur la page Dashboards (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, utilisables avec l'explorateur de journaux ou avec des règles d'alerte basées sur les journaux, consultez la page Types d'événements.

Console

Pour afficher des événements dans un tableau de bord, 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 le tableau de bord que vous souhaitez afficher.
  3. Dans la barre d'outils du tableau de bord, cliquez sur  Annotations, puis sélectionnez les types d'événements que vous souhaitez afficher dans votre tableau de bord.

  4. Effectuez l'une des opérations suivantes :

    • Pour enregistrer vos sélections afin que les événements s'affichent lorsque vous actualisez le tableau de bord, cliquez sur Épingler les éléments sélectionnés. Si vous avez désactivé l'enregistrement automatique sur votre tableau de bord, accédez à la barre d'outils du tableau de bord, puis 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 les annotations pour les types d'événements correspondants.

    • Pour n'afficher que les types d'événements de votre session en cours, cliquez sur Appliquer.

    Après avoir modifié la liste des types d'événements à afficher, 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, utilisez votre pointeur pour activer l'info-bulle.

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 contient deux champs:

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

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

    • Un champ displayName, qui vous permet de définir l'étiquette sur le d'activation/de désactivation spécifique à l'événement. Lorsque ce champ n'est pas spécifié ou lorsque sa valeur est une chaîne vide, le nom par défaut de l'événement s'affiche.
    • Champ enabled, qui contrôle la valeur du bouton d'activation/de désactivation de l'événement. Lorsque la valeur est true, le bouton 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.
    • Champ eventType, qui contient une valeur de l'énumération EventType.
    • Un champ filter, qui vous permet de spécifier une requête à ajouter au spécifique à un événement. Lorsque la valeur de ce champ est une chaîne vide, alors c'est la requête spécifique à l'événement qui 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 sur le projet sélectionné.

Voici un exemple d'objet annotations pour la mise à jour d'un 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 obtenir des informations détaillées sur l'utilisation de l'API Cloud Monitoring pour créer tableaux de bord, consultez Créer et gérer des tableaux de bord à l'aide d'API Exemple: Activer les événements dans les tableaux de bord

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

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

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 consulter Charges de travail Kubernetes ou à la page d'informations d'une une instance de VM, puis sélectionnez 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  Annotations, puis remplissez la boîte de dialogue.

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

    Lorsque le menu Annotations ne s'affiche pas, l'onglet ne peut pas être configuré pour afficher des événements.

API

Non disponible.

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

Lorsque vous consultez un graphique affichant 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 passent par les sinks Cloud Logging de votre projet Google Cloud, vous pouvez recevoir une notification lorsqu'ils se produisent en configurant une alerte basée sur les journaux. Requête de règles d'alerte basées sur les journaux vos entrées de journal à mesure qu'elles sont reçues. Lorsque la requête renvoie un 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 encore 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 Monitoring.

    2. Cliquez sur Modifier le canal de notification.
    3. Accédez au type de canal de notification que vous souhaitez configurer, cliquez sur Ajouter, puis remplissez 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 déclencher une alerte, saisissez une requête ou mettez à jour celle qui a été 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énement répertorie une pouvant être utilisée dans 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 du règle d'alerte. Pour chaque type d'événement, la page Types d'événements liste une requête adaptée à une règle d'alerte basée sur les journaux.

  2. Créer le fichier JSON contenant la représentation de l'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 le 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, cliquez sur  Annotations, sélectionnez Effacer, puis Appliquer.

Pour masquer un type d'événement, cliquez sur  Annotations, désélectionnez ce type d'événement, puis sélectionnez Appliquer.

API

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

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

Étape suivante