Créer et gérer des canaux de notification

Ce document explique comment configurer des canaux de notification à l'aide de la console Google Cloud. Cloud Monitoring utilise ces canaux pour vous avertir ou envoyer une notification à votre équipe d'astreinte lorsqu'une règle d'alerte se déclenche. Lorsque vous créez une règle d'alerte, vous pouvez sélectionner les utilisateurs qui reçoivent une notification en les sélectionnant dans la liste des canaux de notification configurés. Par exemple, vous pouvez configurer des alertes qui surveillent les instances Compute Engine pour publier un sujet Pub/Sub et avertir le canal Slack de l'équipe d'astreinte.

Si votre canal de notification préféré n'est pas compatible, envisagez de créer un pipeline qui repose sur l'envoi de notifications à Pub/Sub. Pour obtenir un exemple Python utilisant Flask, consultez la page Créer des notifications personnalisées avec Cloud Monitoring et Cloud Run. Pour obtenir d'autres exemples, consultez le dépôt Git cloud-alerting-notification- forwarding.

Pour configurer des canaux de notification à l'aide de l'API Cloud Monitoring, consultez Créer et gérer des canaux de notification par API.

Remarque :Les données envoyées aux destinataires de chaînes peuvent contenir des informations sensibles. Consultez vos pratiques réglementaires avant de créer le canal de notification.

Pour plus d'informations sur les notifications des règles d'alerte, consultez les pages suivantes :

• Pour plus d'informations sur le délai entre le début d'un problème et la création d'une alerte, consultez la section Latence des notifications.
• Pour en savoir plus sur le nombre de notifications générées pour une règle d'alerte, consultez la section Notifications par incident.

Par défaut, une règle d'alerte n'envoie de notification qu'à la création d'un incident. Pour recevoir une notification lorsque l'incident est ouvert ou fermé, modifiez la règle d'alerte. Dans la section des notifications, sélectionnez Notifier à la fermeture de l'incident.

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 attribuer le rôle IAM Éditeur Monitoring (roles/monitoring.editor) sur votre projet. 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.

Pour en savoir plus sur les rôles Cloud Monitoring, consultez la page Contrôler les accès avec Identity and Access Management.

Créer un canal de notification

Lorsque vous créez une règle d'alerte, vous pouvez sélectionner n'importe quel canal de notification configuré et l'ajouter à votre règle. Vous pouvez préconfigurer vos canaux de notification, ou les configurer dans le cadre de la création d'une règle d'alerte. Pour en savoir plus, consultez Créer un canal à la demande.

Remarque :Nous vous recommandons de créer plusieurs canaux de notification à des fins de redondance. Google n'a aucun contrôle sur un grand nombre de systèmes de livraison après leur avoir transmis la notification. En outre, un seul service Google est compatible avec Cloud Mobile App, PagerDuty, les webhooks et Slack. Si vous utilisez l'un de ces canaux de notification, utilisez la messagerie redondante, les SMS ou Pub/Sub.

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

Adresse e-mail

Pour ajouter un canal de notification par e-mail, procédez comme suit:

1. Dans la console Google Cloud, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

2. Cliquez sur Modifier les canaux de notification.
3. Dans la section E-mail, cliquez sur Nouveau.
4. Saisissez une seule adresse e-mail 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].

Vous pouvez créer des canaux de messagerie lors de la création d'une règle d'alerte. Pour en savoir plus, consultez Créer une chaîne à la demande.

Application pour mobile

Utilisez l'application mobile de la console Google Cloud pour surveiller les ressources de la console Google Cloud et les informations de Monitoring où que vous soyez. 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 à tous vos appareils sur lesquels l'application mobile Google Cloud Console 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 d'application mobile dans la console Google Cloud pour un projet Google Cloud spécifique, 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 en tant que canal de notification pour une règle d'alerte, accédez à la section Notifications et sélectionnez Google Cloud Console (mobile), puis choisissez votre appareil mobile dans la liste.

PagerDuty

L'intégration avec PagerDuty permet une synchronisation unidirectionnelle ou bidirectionnelle avec Monitoring. Indépendamment de votre configuration, les conditions suivantes s'appliquent :

• Lorsqu'un incident est créé dans Monitoring, un incident miroir est également ouvert dans PagerDuty.
• Vous ne pouvez pas utiliser PagerDuty pour fermer un incident de Monitoring.

Si vous utilisez la synchronisation à sens unique et que vous corrigez l'incident dans PagerDuty, l'état de l'incident dans PagerDuty est dissocié de l'état de l'incident dans Monitoring. En effet, si vous résolvez un incident dans PagerDuty, il est définitivement fermé dans PagerDuty et ne peut pas être rouvert.

Si vous utilisez la synchronisation bidirectionnelle, Monitoring contrôle l'état indiqué par PagerDuty. Si vous corrigez l'incident dans PagerDuty et que celui-ci est ouvert par Monitoring, l'incident est rouvert dans PagerDuty.

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

1. Dans PagerDuty : créez un compte PagerDuty sur le site PagerDuty.
2. Ajoutez le canal de notification PagerDuty :

   1. Dans la console Google Cloud, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

      Accéder à l'interface des alertes

   2. Cliquez sur Modifier les canaux de notification.
   3. Dans la section PagerDuty, cliquez sur Nouveau.
   4. Saisissez le Display Name (Nom à afficher). Ce nom doit correspondre à celui fourni à PagerDuty lorsque vous avez ajouté l'intégration.
   5. Saisissez la clé de service d'intégration générée par PagerDuty dans le champ Clé de service.
   6. Cliquez sur Enregistrer.
3. (Facultatif) Si vous souhaitez configurer la synchronisation bidirectionnelle, procédez comme suit :
   1. Ouvrir PagerDuty
   2. Sélectionnez Configuration, sélectionnez Services, puis le nom de service que vous avez saisi lors de la configuration de l'intégration.
   3. Cliquez sur Modifier les paramètres, sélectionnez Créer des incidents, puis décochez la case Créer des alertes et des incidents.

Lorsque vous créez une règle d'alerte, sélectionnez PagerDuty dans la section Notifications et choisissez votre configuration PagerDuty.

Le paquet JSON de PagerDuty est au format suivant:

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

Pour afficher un exemple et le schéma du champ details, développez les sections suivantes.

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format de la version 1.2. Pour en savoir plus sur cette mise en forme, consultez la section suivante.

Voici un exemple de ce type de paquet :

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Structure du schéma, version 1.2

Cette section décrit la version 1.2 du schéma de charge utile. Certains champs peuvent ne pas apparaître dans tous les paquets renvoyés ou présenter des valeurs vides, selon la configuration de la règle d'alerte, l'état de l'incident ou la ressource surveillée. Certains champs utilisent des structures intégrées en tant que valeurs. Ces structures sont décrites par référence, car leur contenu peut également varier.

Dans un paquet renvoyé, les champs peuvent apparaître dans n'importe quel ordre. Dans la description qui suit, ils sont organisés en groupes connexes.

{
  "version": "1.2",
  "incident": {
    
    Informations sur l'incident
    
    "incident_id" : chaîne ; ID généré pour cet incident.
    "scoping_project_id" : chaîne, ID du projet qui héberge le champ d'application des métriques.
    "scoping_project_number" : numéro du projet effectuant une surveillance
    "url" : chaîne, URL de la console Google Cloud pour cet incident.
    "started_at" : nombre, heure (en secondes de l'epoch Unix) à laquelle l'incident a été ouvert.
    "ended_at" : nombre (en secondes epoch Unix) pendant lequel l'incident a été fermé. Renseigné uniquement lorsque state est closed.
    "state" : chaîne, état de l'incident: open ou closed. Si la valeur est open, ended_at est nul.
    "summary" : chaîne, résumé textuel de l'incident généré.
    "apigee_url" : chaîne, URL Apigee de cet incident, uniquement pour les types de ressources Apigee Environment et Proxy*.
    "observed_value" : chaîne, valeur observée ayant déclenché/résolu l'alerte, peut être vide si la condition a expiré.
    
    Informations sur la ressource surveillée pour laquelle l'incident a été ouvert.
    
    "resource": {
      "type" : chaîne, identifiant du type de ressource surveillée faisant l'objet d'une alerte (par exemple, gce_instance ; voir Liste des ressources surveillées).
      "labels" : paires objet/clé-valeur pour les étiquettes associées à la ressource surveillée.
    },
    "resource_type_display_name" : chaîne, nom à afficher du type de ressource surveillée.
    "resource_id" : chaîne, ID d'instance de la ressource surveillée, même valeur que resource.labels.instance_id.
    "resource_display_name" : chaîne, nom à afficher de la ressource surveillée.
    "resource_name" : chaîne, nom généré pour cette ressource surveillée ; contient les valeurs d'autres champs.
    
    Informations sur le type de métrique des données de séries temporelles.
    
    "metric": {
      "type" : chaîne, identifiant du type de métrique faisant l'objet d'une alerte (par exemple, compute.googleapis.com/instance/cpu/utilization ; voir Liste des métriques).
      "displayName" : chaîne, nom à afficher du type de métrique.
      "labels" : paires objet/valeur pour les libellés associés à la métrique.
    },
    "metadata": {
      "system_labels" : paires objet/clé-valeur pour les libellés de métadonnées système.
      "user_labels" : paires objet/clé-valeur pour les libellés de métadonnées utilisateur.
    },
    
    Informations sur la règle d'alerte et la condition qui ont ouvert/résolu l'incident.
    Les valeurs sont extraites de l'objet AlertPolicy concerné.
    
    "policy_name" : chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels" : paires clé/valeur pour tous les libellés utilisateur associés à la règle.
    "documentation" : objet, structure intégrée au format Documentation.
    "condition" : objet, structure intégrée au format Condition.
    "condition_name" : chaîne, nom à afficher de la condition, même valeur que condition.displayName.
    "threshold_value" : chaîne (valeur de seuil de cette condition) peut être vide si la condition n'est pas une condition de seuil.
  },
}

Règlement relatif aux abandons

Le schéma de charge utile est soumis au règlement relatif aux abandons de Google Cloud décrit dans la section 1.4(d) des Conditions d'utilisation de Google Cloud Platform. Notez que le schéma ne contrôle pas les formats des valeurs de champ générées et que ces formats peuvent changer sans préavis. Par exemple, incident.summary, incident.documentation.content et incident.url sont destinés à inclure des données appartenant à leurs champs, mais le schéma ne présente aucune contrainte pour garantir une analyse précise de ces champs. Vous pouvez utiliser la valeur dans son ensemble et vous attendre à ce qu'elle respecte le règlement relatif aux abandons, mais ne vous appuyez pas sur l'analyse des champs générés.

SMS

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

1. Dans la console Google Cloud, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

2. Cliquez sur Modifier les canaux de notification.
3. Dans la section SMS, cliquez sur Ajouter.
4. Renseignez la boîte de dialogue, puis cliquez sur Enregistrer.

Lorsque vous configurez votre règle d'alerte, sélectionnez le type de notification SMS et choisissez un numéro de téléphone validé dans la liste.

Slack

Remarque :Pour effectuer ces étapes, vous devez être propriétaire ou administrateur de Workspace Slack. Pour en savoir plus, consultez Gérer les demandes d'invitation.

L'intégration de Monitoring avec Slack permet à vos règles d'alerte de publier des données sur un canal Slack lorsqu'un incident est créé. 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, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

3. Cliquez sur Modifier les canaux de notification.

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

   1. Sélectionnez votre espace de travail Slack.
   2. Cliquez sur Autoriser pour autoriser Cloud Monitoring à accéder à 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 Nom à afficher des alertes Cloud, saisissez une courte instruction. 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 Envoyer un message de test. Si la connexion aboutit, un 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 canal privé, vous devez inviter manuellement l'application Monitoring à ce 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 au canal en saisissant et en envoyant le message suivant dans le canal:

      /invite @Google Cloud Monitoring

      Veillez à inviter l'application Monitoring au canal privé que vous avez spécifié lors de la création du canal de notification dans Monitoring. L'invitation de l'application Monitoring à des canaux publics est facultative.

   Lorsque vous créez une règle d'alerte, sélectionnez Slack dans la section Notifications et choisissez votre configuration Slack.

Webhooks

Remarque:Les webhooks ne sont compatibles qu'avec les points de terminaison publics. Si vous avez besoin que les notifications soient envoyées à un point de terminaison non public, créez un canal de notification Pub/Sub et configurez un abonnement au sujet Pub/Sub. Pour en savoir plus, consultez la section Échec des notifications de webhook lorsqu'elles sont configurées pour un point de terminaison privé.

Remarque:Si une fonction Cloud est configurée comme point de terminaison webhook pour un canal de notification, assurez-vous que l'utilisateur appelant la fonction dispose de l'autorisation d'authentification requise. Pour en savoir plus, consultez les sections Authentifier des fonctions pour les appels de fonction et Activer l'accès à une fonction.

Attention:Pour recevoir des notifications avec Google Chat, déployez un service Cloud Run et envoyez vos notifications à Pub/Sub. Pour obtenir un exemple de cette configuration, consultez Créer des notifications personnalisées avec Cloud Monitoring et Cloud Run.

Ne configurez pas une notification de webhook, puis configurez Google Chat pour utiliser ce webhook.

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, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

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

Lorsque vous créez une règle d'alerte, sélectionnez Webhook dans la section Notifications et choisissez votre configuration Webhook. Les notifications envoyées par Error Reporting suivent le schéma 1.0, tandis que celles envoyées par Monitoring suivent le schéma 1.2:

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format de la version 1.2. Pour en savoir plus sur cette mise en forme, consultez la section suivante.

Voici un exemple de ce type de paquet :

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Structure du schéma, version 1.2

Cette section décrit la version 1.2 du schéma de charge utile. Certains champs peuvent ne pas apparaître dans tous les paquets renvoyés ou présenter des valeurs vides, selon la configuration de la règle d'alerte, l'état de l'incident ou la ressource surveillée. Certains champs utilisent des structures intégrées en tant que valeurs. Ces structures sont décrites par référence, car leur contenu peut également varier.

Dans un paquet renvoyé, les champs peuvent apparaître dans n'importe quel ordre. Dans la description qui suit, ils sont organisés en groupes connexes.

{
  "version": "1.2",
  "incident": {
    
    Informations sur l'incident
    
    "incident_id" : chaîne ; ID généré pour cet incident.
    "scoping_project_id" : chaîne, ID du projet qui héberge le champ d'application des métriques.
    "scoping_project_number" : numéro du projet effectuant une surveillance
    "url" : chaîne, URL de la console Google Cloud pour cet incident.
    "started_at" : nombre, heure (en secondes de l'epoch Unix) à laquelle l'incident a été ouvert.
    "ended_at" : nombre (en secondes epoch Unix) pendant lequel l'incident a été fermé. Renseigné uniquement lorsque state est closed.
    "state" : chaîne, état de l'incident: open ou closed. Si la valeur est open, ended_at est nul.
    "summary" : chaîne, résumé textuel de l'incident généré.
    "apigee_url" : chaîne, URL Apigee de cet incident, uniquement pour les types de ressources Apigee Environment et Proxy*.
    "observed_value" : chaîne, valeur observée ayant déclenché/résolu l'alerte, peut être vide si la condition a expiré.
    
    Informations sur la ressource surveillée pour laquelle l'incident a été ouvert.
    
    "resource": {
      "type" : chaîne, identifiant du type de ressource surveillée faisant l'objet d'une alerte (par exemple, gce_instance ; voir Liste des ressources surveillées).
      "labels" : paires objet/clé-valeur pour les étiquettes associées à la ressource surveillée.
    },
    "resource_type_display_name" : chaîne, nom à afficher du type de ressource surveillée.
    "resource_id" : chaîne, ID d'instance de la ressource surveillée, même valeur que resource.labels.instance_id.
    "resource_display_name" : chaîne, nom à afficher de la ressource surveillée.
    "resource_name" : chaîne, nom généré pour cette ressource surveillée ; contient les valeurs d'autres champs.
    
    Informations sur le type de métrique des données de séries temporelles.
    
    "metric": {
      "type" : chaîne, identifiant du type de métrique faisant l'objet d'une alerte (par exemple, compute.googleapis.com/instance/cpu/utilization ; voir Liste des métriques).
      "displayName" : chaîne, nom à afficher du type de métrique.
      "labels" : paires objet/valeur pour les libellés associés à la métrique.
    },
    "metadata": {
      "system_labels" : paires objet/clé-valeur pour les libellés de métadonnées système.
      "user_labels" : paires objet/clé-valeur pour les libellés de métadonnées utilisateur.
    },
    
    Informations sur la règle d'alerte et la condition qui ont ouvert/résolu l'incident.
    Les valeurs sont extraites de l'objet AlertPolicy concerné.
    
    "policy_name" : chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels" : paires clé/valeur pour tous les libellés utilisateur associés à la règle.
    "documentation" : objet, structure intégrée au format Documentation.
    "condition" : objet, structure intégrée au format Condition.
    "condition_name" : chaîne, nom à afficher de la condition, même valeur que condition.displayName.
    "threshold_value" : chaîne (valeur de seuil de cette condition) peut être vide si la condition n'est pas une condition de seuil.
  },
}

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 du point de terminaison ainsi qu'une clé que le serveur s'attend à être secrète entre lui-même 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 afin d'empêcher les pirates informatiques d'apprendre le jeton.

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

Règlement relatif aux abandons

Le schéma de charge utile est soumis au règlement relatif aux abandons de Google Cloud décrit dans la section 1.4(d) des Conditions d'utilisation de Google Cloud Platform. Notez que le schéma ne contrôle pas les formats des valeurs de champ générées et que ces formats peuvent changer sans préavis. Par exemple, incident.summary, incident.documentation.content et incident.url sont destinés à inclure des données appartenant à leurs champs, mais le schéma ne présente aucune contrainte pour garantir une analyse précise de ces champs. Vous pouvez utiliser la valeur dans son ensemble et vous attendre à ce qu'elle respecte le règlement relatif aux abandons, mais ne vous appuyez pas sur l'analyse des champs générés.

Pub/Sub

Cette section explique comment configurer les canaux de notification Pub/Sub. Pour assurer la redondance, nous vous recommandons de créer plusieurs canaux de notification. Nous vous recommandons d'associer Pub/Sub à l'application mobile de la console Google Cloud, PagerDuty, les webhooks ou Slack, car Pub/Sub utilise un mécanisme de distribution différent.

Pour configurer un canal de notification Pub/Sub:

1. Activer l'API Pub/Sub et créer un sujet
2. Configurer le canal de notification pour un sujet
3. Autoriser un compte de service
4. Définir le canal de notification dans une règle d'alerte

Pour comprendre le schéma de données, consultez Exemple de schéma.

Pour recevoir des notifications d'alerte, vous devez également créer l'un des abonnements suivants: pull, push ou BigQuery.

Lorsque l'abonnement se trouve dans un projet différent de celui du sujet, créez un compte de service dans le projet d'abonné et attribuez-lui le rôle roles/pubsub.subscriber.

Avant de commencer

Lorsque vous ajoutez le premier canal de notification pour un projet Google Cloud, Cloud Monitoring crée un compte de service pour ce projet. Il accorde également le rôle Identity and Access Management Agent de service de notification Monitoring au compte de service. Ce compte de service permet à Monitoring d'envoyer des notifications aux canaux de notification basés sur Pub/Sub de ce projet.

Le compte de service a le format suivant :

[e-mail]

Le nom du compte de service de notifications inclut un numéro unique de projet Google Cloud. Vous trouverez le nom, l'ID et le numéro du projet dans le tableau de bord du projet dans la console Google Cloud. Vous pouvez également le récupérer à l'aide de la commande suivante:

gcloud projects describe PROJECT_ID --format="value(project_number)"

Vous pouvez afficher et modifier le compte de service à l'aide de la console Google Cloud ou de Google Cloud CLI.

Activer l'API Pub/Sub et créer un sujet

1. Activez l'API Pub/Sub pour votre projet Google Cloud:
   Activer l'API Pub/Sub

   1. Sélectionnez le projet Google Cloud dans lequel vous prévoyez de créer le sujet Pub/Sub.
   2. Cliquez sur Activer lorsqu'elle s'affiche. Aucune action n'est requise lorsque le message API activée s'affiche.

2. Créer un sujet Pub/Sub Pour savoir comment créer un sujet, consultez Créer un sujet. Par exemple, pour créer un sujet nommé notificationTopic à l'aide de Google Cloud CLI, exécutez la commande suivante:

   gcloud pubsub topics create notificationTopic

Configurez ensuite vos canaux de notification Pub/Sub.

Configurer les notifications pour un sujet

Pour créer un canal de notification Pub/Sub, vous pouvez utiliser l'API Monitoring, Google Cloud CLI ou la console Google Cloud. Après avoir créé le canal de notification, autorisez le compte de service des notifications à publier chaque sujet que vous utilisez comme canal de notification.

Pour plus d'informations sur l'utilisation de l'API Monitoring ou de Google Cloud CLI pour créer le canal de notification, consultez Créer des canaux.

Pour créer le canal de notification à l'aide de la console Google Cloud, procédez comme suit:

1. Dans la console Google Cloud, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

2. Sélectionnez le projet Google Cloud qui contient le sujet Pub/Sub que vous avez créé.
3. Cliquez sur Modifier les canaux de notification.

4. Dans la section Pub/Sub, cliquez sur Nouveau.

   La boîte de dialogue Created Pub/Sub Channel (Canal Pub/Sub créé) affiche le nom du compte de service créé par Monitoring.

5. Autorisez le compte de service. Votre compte de service peut publier tous les sujets ou des sujets spécifiques:

   • Pour publier tous les sujets, sélectionnez Gérer les rôles et ajoutez le rôle Éditeur Pub/Sub.

     Une fois que vous avez terminé la configuration du canal de notification, ignorez la section suivante, intitulée Autoriser le compte de service, et passez à l'étape Définir le canal de notification dans une règle d'alerte.

   • Pour publier des sujets spécifiques, passez à l'étape suivante et autorisez le compte de service à publier des sujets spécifiques une fois le canal de notification configuré. Pour obtenir des instructions, consultez la section Autoriser le compte de service.
6. Saisissez un nom à afficher pour votre canal et le nom du sujet Pub/Sub.
7. (Facultatif) Pour vérifier que le canal est correctement configuré, cliquez sur Envoyer une notification test.
8. Sélectionnez Ajouter une chaîne.

Autorisez ensuite le compte de service.

Autoriser le compte de service

Remarque :Effectuez cette étape lorsque vous créez le canal de notification à l'aide de l'API ou de Google Cloud CLI, et lorsque vous avez ignoré l'étape d'autorisation lorsque vous utilisez la console Google Cloud.

L'autorisation permet au compte de service de notifications de publier chaque sujet Pub/Sub que vous utilisez en tant que canal de notification. Cette section décrit la procédure à suivre pour:

• Autorisez un compte de service pour un sujet spécifique.
• Autorisez un compte de service pour tous les sujets.

Autoriser un compte de service pour un sujet spécifique

Vous pouvez autoriser un compte de service à publier un sujet spécifique à l'aide de la console Google Cloud et de Google Cloud CLI. Cette section décrit les deux approches.

Pour autoriser votre compte de service pour un sujet spécifique à l'aide de la console Google Cloud, procédez comme suit:

1. Dans la console Google Cloud, sélectionnez Pub/Sub, puis Thèmes, ou cliquez sur le bouton suivant:

   Accéder aux sujets Pub/Sub

2. Sélectionnez le sujet.
3. Dans l'onglet Autorisations, sélectionnez Ajouter un compte principal.
4. Dans le champ Nouveau compte principal, saisissez le nom du compte de service des notifications. Le compte de service utilise la convention de dénomination suivante:

   [e-mail]

5. Sélectionnez le rôle Éditeur Pub/Sub, puis cliquez sur Enregistrer.

Pour autoriser votre compte de service pour un sujet spécifique à l'aide de Google Cloud CLI, attribuez au compte de service le rôle IAM pubsub.publisher pour le sujet. Par exemple, la commande suivante configure le rôle IAM pour le sujet notificationTopic:

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:[e-mail]
 

La réponse à une exécution réussie de la commande add-iam-policy-binding se présente comme suit:

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:[e-mail]
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1
 

Pour en savoir plus, consultez la page de référence pubsub topics add-iam-policy-binding.

Autoriser un compte de service pour tous les sujets

Pour autoriser votre compte de service pour tous les sujets, procédez comme suit:

1. Dans la console Google Cloud, sélectionnez IAM ou cliquez sur le bouton suivant:

   Accéder à IAM

2. Sélectionnez Inclure les attributions de rôles fournies par Google, comme illustré dans l'image suivante:
   
3. Recherchez le compte de service au format suivant:

   [e-mail]

   Actualisez la page lorsque le compte de service ne figure pas dans la liste.

4. Sélectionnez Modifier pour le compte de service de notifications, sélectionnez Ajouter un autre rôle, puis ajoutez le rôle Éditeur Pub/Sub.

Ensuite, définissez le canal de notification dans une règle d'alerte.

Définir le canal de notification dans une règle d'alerte

Pour utiliser un canal de notification Pub/Sub dans une règle d'alerte, sélectionnez le type de canal Pub/Sub, puis le sujet.

Exemple de schéma

Pour afficher un exemple de paquet JSON et le schéma, développez les sections suivantes.

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format de la version 1.2. Pour en savoir plus sur cette mise en forme, consultez la section suivante.

Voici un exemple de ce type de paquet :

{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\\"compute.googleapis.com/instance/cpu/utilization\\" resource.type=\\"gce_instance\\" metadata.system_labels.\\"state\\"=\\"ACTIVE\\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown"
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}
       

Structure du schéma, version 1.2

Cette section décrit la version 1.2 du schéma de charge utile. Certains champs peuvent ne pas apparaître dans tous les paquets renvoyés ou présenter des valeurs vides, selon la configuration de la règle d'alerte, l'état de l'incident ou la ressource surveillée. Certains champs utilisent des structures intégrées en tant que valeurs. Ces structures sont décrites par référence, car leur contenu peut également varier.

Dans un paquet renvoyé, les champs peuvent apparaître dans n'importe quel ordre. Dans la description qui suit, ils sont organisés en groupes connexes.

{
  "version": "1.2",
  "incident": {
    
    Informations sur l'incident
    
    "incident_id" : chaîne ; ID généré pour cet incident.
    "scoping_project_id" : chaîne, ID du projet qui héberge le champ d'application des métriques.
    "scoping_project_number" : numéro du projet effectuant une surveillance
    "url" : chaîne, URL de la console Google Cloud pour cet incident.
    "started_at" : nombre, heure (en secondes de l'epoch Unix) à laquelle l'incident a été ouvert.
    "ended_at" : nombre (en secondes epoch Unix) pendant lequel l'incident a été fermé. Renseigné uniquement lorsque state est closed.
    "state" : chaîne, état de l'incident: open ou closed. Si la valeur est open, ended_at est nul.
    "summary" : chaîne, résumé textuel de l'incident généré.
    "apigee_url" : chaîne, URL Apigee de cet incident, uniquement pour les types de ressources Apigee Environment et Proxy*.
    "observed_value" : chaîne, valeur observée ayant déclenché/résolu l'alerte, peut être vide si la condition a expiré.
    
    Informations sur la ressource surveillée pour laquelle l'incident a été ouvert.
    
    "resource": {
      "type" : chaîne, identifiant du type de ressource surveillée faisant l'objet d'une alerte (par exemple, gce_instance ; voir Liste des ressources surveillées).
      "labels" : paires objet/clé-valeur pour les étiquettes associées à la ressource surveillée.
    },
    "resource_type_display_name" : chaîne, nom à afficher du type de ressource surveillée.
    "resource_id" : chaîne, ID d'instance de la ressource surveillée, même valeur que resource.labels.instance_id.
    "resource_display_name" : chaîne, nom à afficher de la ressource surveillée.
    "resource_name" : chaîne, nom généré pour cette ressource surveillée ; contient les valeurs d'autres champs.
    
    Informations sur le type de métrique des données de séries temporelles.
    
    "metric": {
      "type" : chaîne, identifiant du type de métrique faisant l'objet d'une alerte (par exemple, compute.googleapis.com/instance/cpu/utilization ; voir Liste des métriques).
      "displayName" : chaîne, nom à afficher du type de métrique.
      "labels" : paires objet/valeur pour les libellés associés à la métrique.
    },
    "metadata": {
      "system_labels" : paires objet/clé-valeur pour les libellés de métadonnées système.
      "user_labels" : paires objet/clé-valeur pour les libellés de métadonnées utilisateur.
    },
    
    Informations sur la règle d'alerte et la condition qui ont ouvert/résolu l'incident.
    Les valeurs sont extraites de l'objet AlertPolicy concerné.
    
    "policy_name" : chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels" : paires clé/valeur pour tous les libellés utilisateur associés à la règle.
    "documentation" : objet, structure intégrée au format Documentation.
    "condition" : objet, structure intégrée au format Condition.
    "condition_name" : chaîne, nom à afficher de la condition, même valeur que condition.displayName.
    "threshold_value" : chaîne (valeur de seuil de cette condition) peut être vide si la condition n'est pas une condition de seuil.
  },
}

Règlement relatif aux abandons

Le schéma de charge utile est soumis au règlement relatif aux abandons de Google Cloud décrit dans la section 1.4(d) des Conditions d'utilisation de Google Cloud Platform. Notez que le schéma ne contrôle pas les formats des valeurs de champ générées et que ces formats peuvent changer sans préavis. Par exemple, incident.summary, incident.documentation.content et incident.url sont destinés à inclure des données appartenant à leurs champs, mais le schéma ne présente aucune contrainte pour garantir une analyse précise de ces champs. Vous pouvez utiliser la valeur dans son ensemble et vous attendre à ce qu'elle respecte le règlement relatif aux abandons, mais ne vous appuyez pas sur l'analyse des champs générés.

Créer une chaîne à la demande

Lorsque vous ajoutez un canal de notification à une règle d'alerte, vous devez sélectionner un canal dans une liste. Pour mettre à jour la liste des options lorsque vous créez une règle d'alerte, procédez comme suit:

1. Dans la boîte de dialogue de notification, cliquez sur Manage Notification Channels (Gérer les canaux de notification). Vous êtes redirigé vers la fenêtre Notification Channels (Canaux de notification) d'un nouvel onglet.
2. Pour ajouter un nouveau canal de notification, recherchez son type, cliquez sur Nouveau, puis suivez les instructions propres au canal figurant dans le tableau précédent.

3. Revenez à l'onglet d'origine et, dans la boîte de dialogue de notification, cliquez sur Actualiser .

   

4. Sélectionnez le canal de notification dans la liste actualisée.

Tester un canal de notification

Cloud Monitoring ne permet pas de tester les canaux de notification. Toutefois, vous pouvez vérifier qu'un canal de notification est correctement configuré en créant une règle d'alerte et en configurant la condition pour qu'elle se déclenche.

Par exemple, vous pouvez vérifier la configuration de vos canaux de notification en appliquant la procédure suivante:

1. Si votre projet Google Cloud ne comporte pas d'instance Compute Engine, créez-en une.

2. Créez une règle d'alerte pour surveiller l'utilisation du processeur par cette instance.

   Si votre projet Google Cloud contient plusieurs instances, ajoutez un filtre pour sélectionner une seule instance.

3. Configurez les champs du déclencheur de condition comme suit:

   1. Sélectionnez Seuil dans le champ Type de condition.
   2. Sélectionnez Inférieur au seuil pour le champ Position du seuil.
   3. Sélectionnez une valeur supérieure à l'utilisation du processeur pour votre instance. Par exemple, si le graphique indique que l'utilisation du processeur est d'environ 5%, définissez le seuil sur 10%.
   4. Développez Options avancées, puis sélectionnez Aucun nouveau test pour le champ Fenêtre la plus longue.

   Ces paramètres configurent la règle pour qu'elle se déclenche lorsque l'utilisation du processeur d'une instance Compute Engine est inférieure au seuil spécifié. Étant donné que vous avez sélectionné un seuil supérieur à l'utilisation du processeur de votre instance, la condition se déclenche.

4. Ajoutez les canaux de notification à votre règle.

5. Développez Durée de la fermeture automatique de l'incident, puis sélectionnez 30 min.

6. Saisissez un nom de règle, puis cliquez sur Créer une règle.

7. Une fois la condition déclenchée, vérifiez que vous avez reçu une notification sur chaque canal de notification.

8. Supprimez la règle d'alerte et l'instance Compute Engine que vous avez créées. L'incident est automatiquement fermé une fois le délai de fermeture automatique expiré.

9. Si vous avez créé une VM pour ce test, supprimez-la.

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:

1. Dans la console Google Cloud, sélectionnez Monitoring, puis  Alertes, ou cliquez sur le bouton suivant:

   Accéder à l'interface des alertes

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 lorsqu'il est associé à une règle d'alerte. Toutefois, vous pouvez supprimer le canal à l'aide de Google Cloud CLI ou de l'API Cloud Monitoring. Pour en savoir plus, consultez Créer et gérer des canaux de notification par API.

Afficher les journaux du canal de notification

Vous pouvez utiliser l'explorateur de journaux pour afficher les erreurs du canal de notification:

1. Dans la console Google Cloud, sélectionnez Logging, puis Explorateur de journaux, ou cliquez sur le bouton suivant :

   Accéder à l'explorateur de journaux

2. Saisissez et exécutez votre requête. Pour les requêtes spécifiques aux erreurs de canaux de notification, consultez la section Requêtes Cloud Monitoring.