Configurer et gérer les notifications

Vous pouvez configurer Error Reporting pour envoyer des notifications d'erreur aux canaux de notification Cloud Monitoring sélectionnés.

Error Reporting envoie des notifications dans les cas suivants :

• Lorsqu'une erreur se produit pour la première fois dans un projet Google Cloud et qu'elle ne peut pas être regroupée avec des erreurs précédentes.

• Si une erreur à l'état Résolu réapparaît.

Gérer les canaux de notification

Vous pouvez créer, modifier et supprimer des canaux de notification dans Monitoring. Une fois que vous avez créé des canaux de notification, vous pouvez configurer Error Reporting pour les utiliser.

Error Reporting vous permet de choisir parmi quatre types de notifications canaux: e-mail, mobile, Slack et webhooks.

Avant de commencer

Pour obtenir les autorisations nécessaires pour afficher et configurer les canaux de notification à l'aide de la console Google Cloud, demandez à votre administrateur de vous accorder le Éditeur Monitoring (roles/monitoring.editor) sur votre projet. 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.

Pour en savoir plus sur les rôles Cloud Monitoring, voir Contrôlez les accès avec Identity and Access Management.

Créer un canal de notification

Pour créer un canal de notification à l'aide de la console Google Cloud, suivez les instructions propres au canal figurant dans le tableau suivant :

E-mail

Pour ajouter un canal de notification par e-mail, 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 les canaux de notification.
3. Dans la section E-mail, cliquez sur Nouveau.
4. Saisissez une adresse e-mail unique et une description.
5. Cliquez sur Enregistrer.

Si vous utilisez une adresse e-mail de groupe comme canal de notification pour une règle d'alerte, configurez le groupe pour qu'il accepte les e-mails provenant de [e-mail].

Application mobile

Utilisez l'application mobile de la console Google Cloud pour surveiller votre Ressources de la console Google Cloud et Monitoring des informations depuis n'importe où. Les notifications de l'application mobile de la console Google Cloud sont envoyées à un appareil ou à un utilisateur spécifique:

• La valeur Device (Appareil) indique que les notifications ne sont envoyées que sur l'appareil spécifique qui a créé le canal de notification. Pour les canaux de notification à l'échelle de l'appareil, le champ Display name (Nom à afficher) inclut les informations sur l'appareil.
• Utilisateur indique que les notifications sont envoyées à l'ensemble des les appareils sur lesquels l'application mobile est installée.

Cloud Monitoring détermine le champ d'application des notifications lors de la création du canal. Vous ne pouvez ni sélectionner, ni modifier le champ d'application.

Pour configurer un canal de notification de l'application mobile de la console Google Cloud pour un Google Cloud, procédez comme suit:

1. Installez l'application mobile Google Cloud Console depuis la plate-forme de téléchargement d'applications de votre appareil mobile.

2. Sélectionnez un projet à afficher dans l'application mobile de la console Google Cloud.

   Une fois le projet sélectionné, un échange de données entre l'application et le projet Google Cloud sélectionné se produit. Un canal de notification est créé lorsqu'il n'en existe aucun. Au bout de quelques minutes, il est répertorié dans la section Appareils mobiles de la page Canaux de notification.

Pour ajouter votre appareil mobile comme canal de notification pour une alerte : , dans la section Notifications d'alerte, sélectionnez Console Google Cloud (mobile), puis sélectionnez votre appareil mobile dans la liste.

Slack

Remarque : Pour effectuer cette procédure, vous devez être propriétaire ou administrateur d'un espace de travail Slack. Pour en savoir plus, consultez la section Gérer les demandes d'invitation.

Pour configurer les notifications Slack, procédez comme suit :

1. Dans Slack : créez un espace de travail et un canal Slack sur le site Slack. Enregistrez l'URL du canal.

2. 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.

3. Cliquez sur Modifier les canaux de notification.

4. Dans la section Slack, cliquez sur Ajouter pour ouvrir la Page de connexion à Slack:

   1. Sélectionnez votre espace de travail Slack.
   2. Cliquez sur Autoriser pour activer Cloud Monitoring. à votre espace de travail Slack. Cette action vous renvoie à la page de configuration Monitoring de votre canal de notification.
   3. Dans le champ Nom du canal Slack, saisissez le nom du canal Slack que vous souhaitez utiliser pour les notifications.
   4. Dans le champ Cloud Alerting Display Name (Nom à afficher pour les alertes Cloud), saisissez une courte déclaration descriptive. Monitoring affiche la valeur de ce champ sur la page Canal de notifications.
   5. (Facultatif) Pour tester la connexion entre Cloud Monitoring et votre espace de travail Slack, cliquez sur Envoyez une notification de test. Si la connexion aboutit, le message This is a test alert notification... s'affiche dans le canal de notification Slack que vous avez spécifié. Consultez le canal de notification pour confirmer la réception.

5. Si le canal Slack que vous souhaitez utiliser pour les notifications est un chaîne privée, vous devez inviter manuellement Application de surveillance au canal:

   1. Ouvrez Slack.

   2. Accédez au canal que vous avez spécifié en tant que canal de notification Monitoring.

   3. Invitez l'application Monitoring sur le canal en en saisissant et en envoyant le message suivant dans le canal:

      /invite @Google Cloud Monitoring

      Veillez à inviter l'application Monitoring à accéder au que vous avez spécifié lors de la création du canal de notification Surveillance. Inviter l'application Monitoring vers des canaux publics est facultative.

Webhooks

Remarque:Les webhooks ne sont compatibles qu'avec les les points de terminaison.

Remarque:Si une fonction Cloud Run est comme point de terminaison du webhook pour un canal de notification, assurez-vous que l'utilisateur qui appelle la fonction dispose des identifiants l'autorisation. Pour en savoir plus, consultez Authentification à des appels de fonctions et Autoriser l'accès à une fonction

Pour configurer les notifications par webhook, procédez comme suit :

1. Gestionnaire de webhooks : identifiez l'URL du point de terminaison public qui recevra les données de webhooks de Monitoring.

2. 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.

3. Cliquez sur Modifier les canaux de notification.
4. Dans la section Webhook, cliquez sur Add new (Ajouter).
5. Remplissez la boîte de dialogue.
6. Cliquez sur Tester la connexion pour envoyer une charge utile de test au webhook. et un point de terminaison unique. Vous pouvez accéder au point de terminaison de réception pour vérifier la distribution.
7. Cliquez sur Enregistrer.

Schéma du webhook

Pour afficher la structure du schéma de webhook pour Error Reporting, procédez comme suit : cliquez sur ce qui suit:

Structure de schéma, version 1.0

{
  "version": "1.0",
  "subject" : chaîne, description du nouveau groupe d'erreur ou du groupe d'erreur rouvert.
  "group_info": {
    "project_id": chaîne, le projet auquel appartient le groupe d'erreurs.
    "detail_link": chaîne, lien vers la page Informations sur Error Reporting pour l'erreur groupe.
  },
  "exception_info": {
    "type": string : type d'exception consignée dans l'événement.
    "message": chaîne, message d'exception pour l'événement.
  },
  "event_info": {
    "log_message": chaîne
    "request_method": chaîne
    "request_url": chaîne
    "referrer": chaîne
    "user_agent": chaîne
    "service": chaîne
    "version": chaîne
    "response_status": chaîne
  },
}

Authentification de base

En plus de la requête de webhook, Cloud Monitoring envoie le nom d'utilisateur et le mot de passe conformément à la spécification HTTP de l'authentification de base. Cloud Monitoring exige que votre serveur renvoie une réponse 401 avec l'en-tête WWW-Authenticate approprié. Pour plus d'informations sur l'authentification de base, consultez les ressources suivantes :

• Spécification RFC
• Authentification de base

Authentification par jeton

L'authentification par jeton nécessite un paramètre de chaîne de requête dans l'URL de point de terminaison et une clé considérée par le serveur comme étant secrète entre elle et Monitoring. Vous trouverez ci-dessous un exemple d'URL incluant un jeton :

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Si Monitoring publie un incident sur l'URL du point de terminaison, votre serveur peut valider le jeton associé. Cette méthode d'authentification est plus efficace lorsqu'elle est utilisée avec SSL/TLS pour chiffrer la requête HTTP, car elle empêche les espions de découvrir le jeton.

Pour obtenir un exemple de serveur en Python, consultez cet exemple de serveur.

Modifier et supprimer des canaux de notification

Pour modifier ou supprimer un canal de notification à l'aide de la console Google Cloud, procédez comme suit : effectuer les opérations suivantes:

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 les canaux de notification.

   Le tableau de bord des canaux de notification contient une section pour chaque type de canal de notification. Chaque section répertorie toutes les configurations pour ce type :

   • Pour modifier une entrée, cliquez sur Modifier. Cliquez sur Enregistrer une fois les modifications effectuées.
   • Pour supprimer une entrée, cliquez sur Supprimer. Cliquez sur Supprimer dans la boîte de dialogue de confirmation.

Remarque :Vous ne pouvez pas supprimer un canal de notification à l'aide de la console Google Cloud. lorsque le canal est associé à une règle d'alerte. Toutefois, vous pouvez supprimer le canal à l'aide de la Google Cloud CLI ou de la API Cloud Monitoring. Pour en savoir plus, consultez Créez et gérez des canaux de notification par API.

Sélectionner des canaux de notification via la console Google Cloud

Pour sélectionner un canal de notification existant, vous devez disposer de l'un des rôles suivants :

• Utilisateur Error Reporting
• Administrateur Error Reporting
• Éditeur de projet
• Propriétaire du projet

Pour sélectionner la destination des notifications lorsque de nouveaux groupes d'erreurs se produisent, procédez comme suit.

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

   Accéder à Error Reporting

   Vous pouvez également accéder à cette page à l'aide de la barre de recherche.

2. Cliquez sur Configurer les notifications pour ouvrir la page Notifications d'erreur.

3. Dans le menu déroulant Canaux de notification, sélectionnez les canaux auxquels vous souhaitez envoyer les notifications.

   Si le canal dont vous avez besoin ne s'affiche pas, cliquez sur Gérer les canaux de notification pour créer un canal. Pour créer un canal de notification, votre rôle doit correspondre à celui répertorié dans la section Créer des canaux.

4. Après avoir sélectionné les canaux, cliquez sur Enregistrer.

Informations supplémentaires

Vous trouverez ci-dessous des informations supplémentaires qui s'appliquent lors de la création et de la gestion des notifications dans Error Reporting.

Contenu des notifications

Les notifications pour les groupes d'erreurs contiennent des informations sur les entrées de journal du groupe. Les informations incluses dépendent du type de ressource dans laquelle l'erreur s'est produite. Par exemple, certaines notifications peut contenir le nom et la version de la ressource surveillée.

Le message d'erreur n'est inclus dans la notification que lorsque le groupe d'erreurs est identifié par les entrées de journal d'un bucket de journaux dont la région est global.

Quand les notifications sont-elles envoyées ?

Error Reporting envoie une notification dans deux scénarios:

• Lorsque le groupe d'erreurs n'a jamais été vu par Error Reporting.
• Lorsqu'une erreur se produit pour un groupe d'erreurs existant et que son état est défini sur Resolved.

Pour recevoir les futures notifications pour le groupe d'erreurs, vous devez définir le groupe d'erreurs l'état sur Resolved. Aucune autre action (par exemple, utiliser l'API pour supprimer le le groupe d'erreurs ou l'attente de l'expiration des données, une notification si une autre erreur se produit.

Limite du taux de notifications

Error Reporting utilise les règles suivantes pour limiter le nombre de notifications susceptibles de s'afficher en raison d'erreurs:

• Cinq notifications au maximum en raison d'une erreur peuvent être envoyées dans une fenêtre de 60 minutes.

• Si plus de cinq erreurs se produisent dans une fenêtre de 60 minutes, voici ce qui se produit:

  • Vous recevez une notification indiquant notifications sont désactivées pendant les six prochaines heures.

  • Une entrée de journal indiquant le niveau de gravité de l'avertissement est écrite.

• Lorsque vous résolvez un groupe d'erreurs, les notifications associées sont suspendues pendant cinq minutes.

État de résolution

Si une erreur à l'état Résolu se reproduit, elle repasse à l'état Ouvert même si elle a déjà été supprimée, et Error Reporting envoie une notification.

Error Reporting n'envoie pas de notification si l'erreur ignorée se reproduit.

Pour gérer l'état de résolution de vos erreurs, consultez la page Gérer les erreurs.

Notifications sur mobile

Error Reporting envoie des notifications sur mobile au l'application Google Cloud sur Android et iOS. Pour activer les notifications mobiles, vous devez d'abord installer l'application sur votre appareil mobile :

Télécharger l'application Google Cloud