Afficher les événements sur 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 répertoriés dans la section 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 sont affichés dans un tableau de bord ou dans l'onglet Observabilité, vous pouvez utiliser la console Google Cloud. Pour les tableaux de bord que vous créez, qui sont classés en tant que tableaux de bord personnalisés, vous pouvez aussi utiliser l'API Cloud Monitoring.

À moins d'utiliser l'API Cloud Monitoring ou d'enregistrer votre types d'événements sélectionnés, ils ne s'appliquent qu'à la session en cours. Lorsque vous utilisez la console Google Cloud, épinglez vos sélections pour les enregistrer.

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 Sélectionner des types d'événements, 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 sur votre tableau de bord:

  • Les événements d'alerte sont identifiés Surveillance. Les événements d'alerte indiquent quand d'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 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 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.

Mode d'affichage des événements

Pour tous les événements, lorsqu'ils se produisent, les graphiques de votre tableau de bord sont annotée. Les événements identifiés par l'analyse des entrées de journal sont indiqués ou une 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 qui présente plusieurs événements identifiés en analysant les entrées de journal, et un Événement Service Health:

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 lister les produits ou emplacements concernés, placez votre curseur sur la sur le chip correspondant.
  • Un bouton Afficher qui, lorsqu'il est sélectionné, permet d'ouvrir une page qui affiche plus des informations sur l'événement. Par exemple, il peut ouvrir l'explorateur de journaux, afin que vous puissiez afficher les entrées de journal, ou la page d'informations peut s'ouvrir pour 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, 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 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: Lecteur 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)
    • Affichez 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 tableau de bord, puis 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 dans la page Tableaux de bord de la console Google Cloud pour afficher les é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 sur 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, assurez-vous que la Événements est activé.

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

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

    • Si vous consultez un tableau de bord personnalisé et que vous souhaitez enregistrer votre type d'événement sélections, puis cliquez sur Épingler les éléments sélectionnés. Si l'enregistrement automatique est désactivé dans votre tableau de bord, puis accédez à la barre d'outils cliquez sur Enregistrer.

      Lorsque vous épinglez vos sélections, vous modifiez la définition JSON du tableau de bord. Lorsque le tableau de bord est rouvert, vos sélections sont chargés et le tableau de bord affiche les annotations correspondant les différents types d'événements.

    • Sinon, cliquez sur OK.

    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, procédez comme suit : 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 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. Si ce champ n'est pas spécifié ou lorsque la valeur de ce champ est une chaîne vide, le nom par défaut de l'événement s'affiche.
    • Un champ enabled qui contrôle la valeur du bouton d'activation 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.
    • Un champ eventType, qui contient une valeur issue du EventType énumération.
    • 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 des 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, fournissez un onglet Observabilité qui affiche 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électionnez l'onglet Observabilité. De même, vous pouvez consulter Charges de travail Kubernetes ou à la page d'informations d'une de machine virtuelle (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 Sélectionner des événements . et terminez 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 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.

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 une autre type d'événement, 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 passer par les récepteurs Cloud Logging dans votre projet Google Cloud, peuvent recevoir une notification lorsque ces événements se produisent configurer 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 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 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 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, effectuer les opérations suivantes:

  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 pouvant être utilisée dans 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 Concevez 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, accédez à 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 l'option correspondante la position de votre annonce.

API

Pour masquer un type d'événement dans un tableau de bord personnalisé, recherchez l'icône 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 Créer et gérer des tableaux de bord à l'aide d'API

Étape suivante