Cette page a été traduite par l'API Cloud Translation.

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, vous ou votre équipe d'astreinte, lorsqu'une règle d'alerte se déclenche. Lorsque vous créez une règle d'alerte, vous sélectionnez les personnes à avertir en effectuant des choix dans la liste des canaux de notification configurés. Par exemple, vous pouvez configurer des règles d'alerte qui surveillent les instances Compute Engine pour publier un sujet Pub/Sub et avertir le canal Slack de l'équipe de garde.

Pour en savoir plus, consultez les sections Latence des notifications et Notifications par incident.

Ce document explique comment utiliser la console Google Cloud. Si vous utilisez l'API Cloud Monitoring, consultez la section Créer et gérer des canaux de notification avec l'API.

Avant de commencer

Pour obtenir les autorisations nécessaires pour afficher et configurer des canaux de notification à l'aide de la console Google Cloud, demandez à votre administrateur de vous accorder le rôle IAM Éditeur Monitoring (roles/monitoring.editor) dans 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, consultez la section 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 la section Créer un canal à la demande.

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:

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.
Cliquez sur Modifier les canaux de notification.
Dans la section E-mail, cliquez sur Nouveau.
Saisissez une seule adresse e-mail et une description.
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 alerting-noreply@google.com.

Vous pouvez créer des canaux de notification par e-mail lors de la création d'une règle d'alerte. Pour en savoir plus, consultez la section Créer un canal à la demande.

Application mobile

Utilisez l'application mobile Google Cloud Console pour surveiller vos ressources Google Cloud Console et consulter les informations de Monitoring où que vous soyez. Les notifications de l'application mobile Google Cloud Console sont envoyées à un appareil spécifique ou à un utilisateur spécifique:

Liste des canaux de notification de l'application mobile Google Cloud Console.

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.
La valeur User (Utilisateur) indique que les notifications sont envoyées à tous les 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 dans l'application mobile Google Cloud Console pour un projet Google Cloud spécifique, procédez comme suit:

Installez l'application mobile Google Cloud Console depuis la plate-forme de téléchargement d'applications de votre appareil mobile.
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, dans la section Notifications d'alerte, sélectionnez Google Cloud Console (mobile), puis votre appareil mobile dans la liste.

PagerDuty

PagerDuty est compatible avec la synchronisation bidirectionnelle avec Monitoring. Par conséquent, les affirmations suivantes sont vraies:

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 résolvez un incident dans PagerDuty alors qu'il est toujours ouvert dans Monitoring, il est rouvert dans PagerDuty.

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

Dans votre compte PagerDuty, configurez l'intégration dans un nouveau service ou ajoutez-la à un service existant.
1. Créez un compte ou connectez-vous à un compte existant.
2. Accédez à la page Services.
3. Dans le panneau Integrations de votre service, recherchez la fiche de votre nouvelle intégration, développez son menu, puis copiez la clé d'intégration.
4. Facultatif: Configurez PagerDuty pour mapper précisément les valeurs de gravité des incidents à partir de Monitoring.
Dans Cloud Monitoring, ajoutez le canal de notification PagerDuty :
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 PagerDuty, cliquez sur Nouveau.
4. Saisissez le Display Name (Nom à afficher). Ce nom doit correspondre à celui du service PagerDuty dans lequel vous avez configuré votre nouvelle intégration à l'étape 1.
5. Collez la clé d'intégration que vous avez copiée à l'étape 1 dans le champ Clé de service.
6. Cliquez sur Enregistrer.

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

Le paquet JSON pour PagerDuty se présente sous la forme suivante:

 {
     "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 avec le 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",
    "severity": "no severity",
    "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",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "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 la 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, numéro du projet d'étude de faisabilité.
    "url" : chaîne, URL de la console Google Cloud pour cet incident.
    "started_at" : numéro, heure (en secondes epoch Unix) à laquelle l'incident a été ouvert.
    "ended_at" : numéro, heure (en secondes epoch Unix) à laquelle l'incident a été fermé. Renseigné seulement lorsque state est défini sur closed.
    "state" : chaîne, état de l'incident: open ou closed. Si open, alors ended_at est nul.
    "summary" : chaîne, résumé textuel généré de l'incident.
    "apigee_url" : chaîne, URL Apigee pour cet incident, uniquement pour les types de ressources Apigee Environment et Proxy*.
    "observed_value" : chaîne, valeur observée qui a 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 pour lequel une alerte est envoyée, par exemple gce_instance. Consultez la liste des ressources surveillées.
      "labels" : objet, paires clé-valeur pour les libellés associés à 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é de la ressource surveillée. Consiste en des valeurs provenant 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 pour lequel une alerte est envoyée, par exemple compute.googleapis.com/instance/cpu/utilization. Consultez la liste des métriques.
      "displayName" : chaîne, nom à afficher du type de métrique.
      "labels" : objet, paires clé-valeur pour les libellés associés à la métrique.
    },
    "metadata": {
      "system_labels" : objet, paires clé-valeur pour les libellés de métadonnées système.
      "user_labels" : objet, paires clé-valeur pour les libellés de métadonnées utilisateur.
    },

    Informations sur la règle d'alerte et la condition à l'origine de l'ouverture/de la résolution de l'incident.
    Les valeurs sont extraites de l'objet AlertPolicy approprié.

    "policy_name" : chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels" : objet, 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.
    "severity" : chaîne, niveau de gravité des incidents. Si ce champ n'est pas défini lors de la création de la règle d'alerte, Cloud Monitoring définit la gravité de la règle d'alerte sur no severity.
    "threshold_value" : la chaîne, qui correspond à la valeur seuil de cette condition, peut être vide si la condition n'est pas une condition de seuil.
  },
}

Règlement d'obsolescence

Le schéma de la charge utile est soumis au règlement Google Cloud sur l'abandon 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 être modifiés sans préavis. Par exemple, incident.summary, incident.documentation.content et incident.url sont censés inclure des données concernant leurs champs, mais le schéma ne comporte pas de contraintes 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 d'abandon, mais ne vous appuyez pas sur l'analyse des champs générés.

Configurer PagerDuty pour mapper les niveaux de gravité

Par défaut, les notifications PagerDuty affichent tous les niveaux de gravité des incidents comme "critiques". Vous pouvez configurer des règles d'orchestration des événements dans PagerDuty afin que la gravité de l'alerte PagerDuty corresponde à la gravité de l'incident Monitoring:

Dans votre compte PagerDuty, accédez à la page Services.
Sélectionnez le service PagerDuty sur lequel vous recevez les notifications Google Cloud.
Cliquez sur Paramètres.
Accédez à la section Gestion des événements, puis cliquez sur Afficher les règles d'orchestration.
Cliquez sur Nouvelle règle.
Pour chaque valeur de gravité de surveillance que vous souhaitez convertir, créez une règle conditionnelle qui mappe la valeur de gravité à une valeur PagerDuty équivalente :
1. Dans le menu sous Étape 1: Quand cette règle doit-elle être appliquée ?, Sélectionnez Si les événements répondent à certaines conditions.
2. Sélectionnez l'éditeur de code.
3. Dans la section Si, saisissez event.custom_details.incident.severity matches part "VALUE", où VALUE est le nom d'une valeur de gravité de surveillance, puis cliquez sur Suivant.
4. Sous Étape 2: Quelle(s) action(s) appliquer, sélectionnez Alert Data (Alerter les données).
5. Définissez la gravité de l'alerte sur une valeur correspondant à celle de la surveillance que vous avez saisie à l'étape C, puis enregistrez vos modifications.
Facultatif: Pour ajouter des règles supplémentaires, cliquez sur Règle "Sinon".

SMS

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

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.
Cliquez sur Modifier les canaux de notification.
Dans la section SMS, cliquez sur Nouveau.
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

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 :

Dans Slack : créez un espace de travail et un canal Slack sur le site Slack. Enregistrez l'URL du canal.
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.
Cliquez sur Modifier les canaux de notification.
Dans la section Slack, cliquez sur Nouveau pour ouvrir la page de connexion 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 pour les alertes dans le cloud, saisissez une brève 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 Envoyer 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é. Veuillez consulter le canal de notification pour confirmer la réception.
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 à accéder 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 aux 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

Avant de configurer un canal de notification par webhook, tenez compte des points suivants:

Les webhooks ne sont compatibles qu'avec les points de terminaison publics. Si vous devez envoyer des notifications à un point de terminaison qui n'est pas public, créez un canal de notification Pub/Sub et configurez un abonnement au sujet Pub/Sub. Pour en savoir plus, consultez la section Les notifications webhook échouent lorsqu'elles sont configurées pour un point de terminaison privé.
Si une fonction Cloud Run est configurée en tant que point de terminaison webhook pour un canal de notification, assurez-vous que l'utilisateur qui appelle la fonction dispose de l'autorisation d'authentification requise. Pour en savoir plus, consultez les pages S'authentifier pour l'appel et Activer l'accès à une fonction.
Les canaux de notification webhook ne sont pas compatibles avec Microsoft Teams. Pour envoyer des données de notification de Monitoring à Microsoft Teams, créez une couche d'intégration pour recevoir le webhook de Monitoring, puis redirigez-le vers Microsoft Teams.

Configurer des canaux de notification Webhook

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

Gestionnaire de webhooks : identifiez l'URL du point de terminaison public qui recevra les données de webhooks de Monitoring.
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.
Cliquez sur Modifier les canaux de notification.
Dans la section Webhook, cliquez sur Ajouter.
Remplissez la boîte de dialogue.
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.
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 les notifications 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 avec le 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",
    "severity": "no severity",
    "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",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "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

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.

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 :

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

Règlement d'obsolescence

Pub/Sub

Cette section explique comment configurer les canaux de notification Pub/Sub. À des fins de 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, à Webhooks ou à Slack, car Pub/Sub utilise un mécanisme de diffusion différent.

Pour configurer un canal de notification Pub/Sub:

Activer les API requises et créer un sujet
Configurer le canal de notification d'un thème
Autoriser un compte de service
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 les 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 de l'abonné et attribuez-lui le rôle roles/pubsub.subscriber.

Avant de commencer

Lorsque vous ajoutez le premier canal de notification Pub/Sub à 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 de surveillance au compte de service. Ce compte de service permet à Monitoring d'envoyer des notifications aux canaux de notification Pub/Sub de ce projet.

Le compte de service a le format suivant :

service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

Le nom du compte de service de notifications inclut un numéro unique de projet Google Cloud. Vous pouvez trouver le nom, l'ID et le numéro du projet sur le tableau de bord du projet dans la console Google Cloud, ou les 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 les API requises et créer un sujet

Dans le projet Google Cloud dans lequel vous prévoyez de créer le canal de notification et le sujet Pub/Sub, procédez comme suit:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

Créer un sujet Pub/Sub Pour en savoir plus sur la création d'un sujet, consultez la section 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 thème

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

Pour savoir comment utiliser l'API Monitoring ou la Google Cloud CLI pour créer le canal de notification, consultez la section Créer des canaux.

Pour utiliser la console Google Cloud afin de créer le canal de notification, procédez comme suit:

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.
Sélectionnez le projet Google Cloud contenant le sujet Pub/Sub que vous avez créé.
Cliquez sur Modifier les canaux de notification.
Dans la section Pub/Sub, cliquez sur Nouveau.

La boîte de dialogue Canal Pub/Sub créé affiche le nom du compte de service créé par Monitoring.
Autorisez le compte de service. Votre compte de service peut publier tous les thèmes ou des thèmes spécifiques:
- Pour publier tous les sujets, sélectionnez Gérer les rôles, puis ajoutez le rôle Éditeur Pub/Sub.
  
  Une fois que vous avez terminé de configurer le canal de notification, ignorez la section suivante intitulée Autoriser le compte de service et passez à la section 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 la configuration du canal de notification terminée. Pour savoir comment autoriser le compte de service, consultez la section Autoriser le compte de service.
Saisissez un nom à afficher pour votre canal et le nom du sujet Pub/Sub.
(Facultatif) Pour vérifier que le canal est correctement configuré, cliquez sur Envoyer une notification de test.
Sélectionnez Ajouter un canal.

Autorisez ensuite le compte de service.

Autoriser le compte de service

L'autorisation permet au compte de service de notifications de publier chaque sujet Pub/Sub que vous utilisez comme canal de notification. Cette section explique comment effectuer les opérations suivantes:

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 la 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:

Dans la console Google Cloud, accédez à la page Topics (Sujets) :
Accéder à Sujets

Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Pub/Sub.
Sélectionnez le sujet.
Dans l'onglet Autorisations, sélectionnez Ajouter un compte principal.
Dans le champ Nouveau compte principal, saisissez le nom du compte de service de notifications. Le compte de service suit la convention d'attribution de noms suivante:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Sélectionnez le rôle Éditeur Pub/Sub, puis Enregistrer.

Pour autoriser votre compte de service pour un sujet spécifique à l'aide de Google Cloud CLI, attribuez-lui le rôle IAM pubsub.publisher correspondant au 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:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

Une réponse à une exécution réussie de la commande add-iam-policy-binding ressemble à ceci:

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1

Pour en savoir plus, consultez la page de référence sur 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:

Dans la console Google Cloud, accédez à la page IAM :
Accéder à IAM

Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est IAM et administration.
Sélectionnez Inclure les attributions de rôles fournies par Google, comme illustré dans l'image suivante:
Recherchez le compte de service au format suivant:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Actualisez la page si le compte de service n'est pas listé.
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 Pub/Sub comme type de canal, puis sélectionnez 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 avec le 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",
    "severity": "no severity",
    "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",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "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

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, numéro du projet d'étude de faisabilité.
    "url" : chaîne, URL de la console Google Cloud pour cet incident.
    "started_at" : nombre, heure (en secondes epoch Unix) à laquelle l'incident a été ouvert.
    "ended_at" : numéro, heure (en secondes epoch Unix) à laquelle l'incident a été fermé. Renseigné seulement lorsque state est défini sur closed.
    "state" : chaîne, état de l'incident: open ou closed. Si open, alors ended_at est nul.
    "summary" : chaîne, résumé textuel généré de l'incident.
    "apigee_url" : chaîne, URL Apigee pour cet incident, uniquement pour les types de ressources Apigee Environment et Proxy*.
    "observed_value" : chaîne, valeur observée qui a 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 pour lequel une alerte est envoyée, par exemple gce_instance. Consultez la liste des ressources surveillées.
      "labels" : objet, paires clé-valeur pour les libellés associés à 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é de la ressource surveillée. Consiste en des valeurs provenant 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 pour lequel une alerte est envoyée, par exemple compute.googleapis.com/instance/cpu/utilization. Consultez la liste des métriques.
      "displayName" : chaîne, nom à afficher du type de métrique.
      "labels" : objet, paires clé-valeur pour les libellés associés à la métrique.
    },
    "metadata": {
      "system_labels" : objet, paires clé-valeur pour les libellés de métadonnées système.
      "user_labels" : objet, paires clé-valeur pour les libellés de métadonnées utilisateur.
    },

    Informations sur la règle d'alerte et la condition à l'origine de l'ouverture/de la résolution de l'incident.
    Les valeurs sont extraites de l'objet AlertPolicy approprié.

    "policy_name" : chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels" : objet, 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.
    "severity" : chaîne, niveau de gravité des incidents. Si ce champ n'est pas défini lors de la création de la règle d'alerte, Cloud Monitoring définit la gravité de la règle d'alerte sur no severity.
    "threshold_value" : la chaîne, qui correspond à la valeur seuil de cette condition, peut être vide si la condition n'est pas une condition de seuil.
  },
}

Règlement d'obsolescence

Le schéma de la charge utile est soumis au règlement Google Cloud sur l'abandon 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 être modifiés sans préavis. Par exemple, incident.summary, incident.documentation.content et incident.url sont censés inclure des données concernant leurs champs, mais le schéma ne comporte pas de contraintes 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 sur l'abandon, mais ne vous appuyez pas sur l'analyse des champs générés.

Google Chat

L'application Google Cloud Monitoring permet à vos espaces Google Chat de recevoir des notifications.

Avant de commencer

Si vous faites partie d'une organisation, vous devez disposer d'un accès à l'application Google Cloud Monitoring pour l'installer. Si vous n'y avez pas accès, demandez à un administrateur Google Workspace de procéder comme suit:

Installer l'application Google Cloud Monitoring

Vous devez suivre la procédure ci-dessous pour installer l'application Google Cloud Monitoring. L'installation à partir de la fiche Google Workspace Marketplace n'est pas prise en charge.

Pour installer l'application et configurer un espace en tant que canal de notification, procédez comme suit:

Dans Google Chat, ouvrez ou créez l'espace dans lequel vous souhaitez recevoir des notifications.
Installez l'application Google Cloud Monitoring:
1. Sélectionnez le nom de votre espace, puis Applications et intégrations.
2. Si l'application Google Cloud Monitoring n'apparaît pas dans la liste des applications, revenez à votre espace, saisissez @Google Cloud Monitoring, puis appuyez sur Entrée.
3. Cliquez sur Ajouter à l'espace.
Copiez l'ID de l'espace de discussion dans le presse-papiers.

Si vous avez installé l'application Google Cloud Monitoring, l'ID de l'espace de chat est inclus dans la confirmation d'installation. Sinon, vous pouvez trouver l'ID de l'espace Chat sous la forme d'une série de chiffres et de lettres qui suivent space/ à la fin de l'URL de l'espace Chat.
Ouvrez un nouvel onglet de navigateur, puis configurez le canal de notification:
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. Accédez à la section Google Chat, puis cliquez sur Ajouter.
4. Saisissez l'ID de votre salon Chat dans le champ ID du salon Chat, puis cliquez sur Enregistrer.

Créer un canal à 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:

Dans la boîte de dialogue de notification, cliquez sur Manage Notification Channels (Gérer les canaux de notification). La fenêtre Canaux de notification s'affiche dans un nouvel onglet du navigateur.
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.
Revenez à l'onglet d'origine, puis dans la boîte de dialogue de notification, cliquez sur Actualiser.
Sélectionnez le canal de notification dans la liste actualisée.

Recevoir une notification sur une chaîne non prise en charge

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

Tester un canal de notification

Cloud Monitoring ne propose pas d'option de test pour 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 à remplir.

Pour tester manuellement vos canaux de notification, vous pouvez créer une règle d'alerte qui surveille l'utilisation du processeur de l'une de vos instances de machine virtuelle (VM) :

Facultatif: Si vous ne disposez pas encore d'une VM dans votre projet Google Cloud ou si vous souhaitez utiliser une autre VM pour les tests, créez-en une:
1. Dans la console Google Cloud, accédez à la page Instances de VM :
  Accéder à la page Instances de VM
  
  Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
2. Sélectionnez Créer une instance, puis configurez votre VM. Pour en savoir plus sur la création de VM, consultez la section Créer une instance de VM à partir d'une image publique.
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.
Sélectionnez Créer une règle.
Utilisez le menu Sélectionner une métrique pour sélectionner la métrique Utilisation du processeur pour une instance de VM.
Cliquez sur Ajouter un filtre, puis ajoutez un filtre pour votre VM.
Mettez à jour les champs Configurer le déclencheur comme suit:
1. Sélectionnez En dessous du seuil pour le champ Position du seuil.
2. Sélectionnez une valeur supérieure à l'utilisation du processeur de votre instance. Par exemple, si le graphique indique que l'utilisation du processeur est d'environ 5%, définissez le seuil sur 10%.
  
  Ces paramètres configurent la condition à remplir lorsque l'utilisation du processeur d'une instance de VM 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 de VM, la condition de la règle d'alerte est remplie.
Ajoutez les canaux de notification à votre règle.
Développez Délai pour la fermeture automatique de l'incident, puis sélectionnez 30 min.
Saisissez un nom de règle, puis cliquez sur Créer une règle.
Une fois la condition remplie, vérifiez que vous avez reçu une notification sur chaque canal de notification.
Supprimez la règle d'alerte. L'incident est automatiquement fermé une fois la durée de fermeture automatique écoulée.
Si vous avez créé une instance de VM pour ce test, supprimez-la.

Si vous ne recevez pas les notifications attendues, vous pouvez rechercher dans l'explorateur de journaux des entrées de journal contenant des informations sur les notifications manquantes. Pour en savoir plus, consultez la section Les notifications ne sont pas reçues.

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:

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

Afficher les journaux des canaux de notification

Vous pouvez utiliser l'explorateur de journaux pour afficher les erreurs des canaux de notification:

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.
Saisissez et exécutez votre requête. Pour les requêtes spécifiques aux erreurs de canal de notification, consultez la section Requêtes Cloud Monitoring.

Étape suivante

Pour en savoir plus sur les incidents, consultez les documents suivants: