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 en utilisant la console Google Cloud. Cloud Monitoring utilise ces canaux pour vous avertir, ou votre équipe d'astreinte, lorsqu'une règle d'alerte se déclenche. Lorsque vous créez un d'alerte, vous choisissez qui sera averti en effectuant une sélection 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 sujet Pub/Sub et avertir le canal Slack pour l'équipe d'astreinte.

Pour en savoir plus, consultez les sections Latence de notification et Notifications par incident

Ce document explique comment utiliser la console Google Cloud. Si vous utilisez les API Cloud Monitoring, puis consultez Créer et gérer des canaux de notification par API

Avant de commencer

Pour obtenir les autorisations nécessaires pour afficher et configurer les canaux de notification à l'aide de la console Google Cloud, demandez à votre administrateur de vous accorder le Éditeur Monitoring (roles/monitoring.editor) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez la 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, voir Contrôlez 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 configuré le canal de notification 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 plus d'informations, consultez l'article Créer une chaîne à la demande.

Pour créer un canal de notification à l'aide de la console Google Cloud : suivez les instructions spécifiques à chaque chaîne figurant dans le tableau suivant:

Adresse 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 adresse e-mail unique 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 messagerie lors de la création d'une alerte . Pour en savoir plus, consultez Créer une chaîne à la demande

Application mobile

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

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

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

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

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

Installez l'application mobile de la console Google Cloud 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 comme canal de notification pour une alerte : d'alerte, dans la section Notifications d'alerte, sélectionnez Console Google Cloud (mobile), puis sélectionnez votre appareil mobile dans la liste.

PagerDuty

L'intégration à 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 unidirectionnelle et que vous résolvez l'incident dans dans PagerDuty, l'état de l'incident dans PagerDuty est découplé l'état de l'incident dans Monitoring. En effet, si vous résoudre un incident dans PagerDuty, l'incident est définitivement fermé dans PagerDuty et ne peuvent pas être rouverts.

Si vous utilisez la synchronisation bidirectionnelle, Monitoring contrôle l'état affiché par PagerDuty. Si vous résolvez l'incident dans PagerDuty Si l'incident est ouvert dans Monitoring, l'incident est rouvert dans PagerDuty.

Pour configurer les notifications PagerDuty, effectuer les opérations suivantes:

Dans votre compte PagerDuty, configurez l'intégration dans un nouveau service ou ajouter l'intégration à 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 (Intégrations) du service, recherchez la liste de vos une nouvelle intégration, développez son menu, puis copiez la clé d'intégration.
Dans Cloud Monitoring, ajoutez le canal de notification PagerDuty: <ph type="x-smartling-placeholder">
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 au du service PagerDuty dans lequel vous avez configuré votre nouveau l'intégration à l'étape 1.
5. Saisissez la clé d'intégration copiée à l'étape 1 dans le champ Service Key (Clé de service).
6. Cliquez sur Enregistrer.
Facultatif: si vous souhaitez configurer la synchronisation bidirectionnelle, effectuer les opérations suivantes: <ph type="x-smartling-placeholder">
1. Accédez à votre compte PagerDuty.
2. Sélectionnez Services, puis le nom de service que vous avez saisi lors de la configuration de l'intégration.
3. Sélectionnez le panneau Integrations (Intégrations) de votre service.
4. Accédez à la section Paramètres d'alerte et d'incident, puis cliquez sur Modifier.
5. Sélectionnez Créer à la fois des incidents et des alertes, puis enregistrez vos des modifications.

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

Le paquet JSON pour 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, procédez comme suit : développer les sections suivantes.

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format 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 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": et l'identifiant généré pour cet incident.
    "scoping_project_id": chaîne, l'ID du projet qui héberge le champ d'application des métriques.
    "scoping_project_number": le numéro du projet effectuant une surveillance.
    "url": l'URL de la console Google Cloud pour cet incident.
    "started_at": Nombre et heure (en secondes epoch Unix) d'ouverture de l'incident.
    "ended_at": Nombre et heure (en secondes epoch Unix) de clôture de l'incident. Renseigné uniquement 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": et un résumé textuel généré de l'incident.
    "apigee_url": chaîne, Apigee URL pour cet incident, uniquement pour Apigee types de ressources Environment et Proxy*.
    "observed_value": la 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 qui fait l'objet d'une alerte, par exemple gce_instance; voir Liste des ressources surveillées.
      "labels": et des paires 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é de cette ressource surveillée ; est constitué de 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 qui fait l'objet d'une alerte, par exemple compute.googleapis.com/instance/cpu/utilization; consultez la section Liste des métriques.
      "displayName": chaîne, nom à afficher du type de métrique.
      "labels": et des paires clé/valeur pour les étiquettes associées à la métrique.
    },
    "metadata": {
      "system_labels": et des paires clé/valeur pour les étiquettes de métadonnées système.
      "user_labels": et des paires clé/valeur pour les étiquettes de métadonnées utilisateur.
    },

    Informations sur la règle et la condition d'alerte qui ont ouvert/résolu l'incident.
    Les valeurs sont tirées des <ph type="x-smartling-placeholder"></ph> AlertPolicy.

    "policy_name": chaîne, nom à afficher pour la règle d'alerte.
    "policy_user_labels": et des paires clé/valeur pour tous les libellés utilisateur associés à la stratégie.
    "documentation": objet, une structure intégrée sous la forme <ph type="x-smartling-placeholder"></ph> Documentation.
    "condition": objet, une structure intégrée sous la forme <ph type="x-smartling-placeholder"></ph> Condition.
    "condition_name": chaîne, nom à afficher de la condition, même valeur que condition.displayName
    "severity": et le 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 alors la gravité de la règle d'alerte sur No Severity.
    "threshold_value": chaîne, la valeur de 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 charge utile est soumis au règlement d'obsolescence de Google Cloud décrit à 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 des champs générés, et 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 relatives à leurs champs, mais le schéma présentent des contraintes pour garantir une analyse précise de ces champs. Vous pouvez consommer la valeur dans son ensemble et s'attendre à ce qu'elle respecte mais ne vous fiez pas à l'analyse des champs générés.

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 Ajouter.
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 Ajouter pour ouvrir la Page de connexion à Slack:
1. Sélectionnez votre espace de travail Slack.
2. Cliquez sur Autoriser pour activer Cloud Monitoring. à votre espace de travail Slack. Cette action vous renvoie à la page de configuration Monitoring de votre canal de notification.
3. Dans le champ Nom du canal Slack, saisissez le nom du Canal Slack que vous souhaitez utiliser pour les notifications.
4. Dans le champ Cloud Alerting Display Name (Nom à afficher pour les alertes Cloud), saisissez une courte déclaration descriptive. Monitoring affiche la valeur de ce champ sur la page Canal de notifications.
5. (Facultatif) Pour tester la connexion entre Cloud Monitoring et votre espace de travail Slack, cliquez sur Envoyez une notification de test. Si la connexion est établie, le message This is a test alert notification... s'affiche dans Canal de notification Slack que vous avez spécifié. Consultez le canal de notification pour confirmer la réception.
Si le canal Slack que vous souhaitez utiliser pour les notifications est un chaîne privée, vous devez inviter manuellement Application de surveillance au canal:
1. Ouvrez Slack.
2. Accédez au canal que vous avez spécifié en tant que canal de notification Monitoring.
3. Invitez l'application Monitoring sur le canal en en saisissant et en envoyant le message suivant dans le canal:
```
/invite @Google Cloud Monitoring
```
  Veillez à inviter l'application Monitoring à accéder au que vous avez spécifié lors de la création du canal de notification Surveillance. Inviter l'application Monitoring vers des canaux publics est facultative.
Lorsque vous créez une règle d'alerte, sélectionnez Slack dans la section Notifications et choisissez votre configuration Slack.

Webhooks

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 Add new (Ajouter).
Complétez la boîte de dialogue.
Cliquez sur Tester la connexion pour envoyer une charge utile de test au webhook. point de terminaison unique. Vous pouvez accéder au point de terminaison de réception pour vérifier la distribution.
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 1.2:

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format 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 du point de terminaison et une clé que le s'attend à être secret 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 de l'authentification est plus efficace lorsqu'elle est utilisée avec SSL/TLS pour chiffrer la requête HTTP et empêcher les pirates d'apprendre 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 notifications Pub/Sub canaux de distribution. À des fins de redondance, nous vous recommandons de créer plusieurs instances canaux de notification. Associer Pub/Sub à l'application mobile de la console Google Cloud Nous vous recommandons d'utiliser PagerDuty, Webhooks ou Slack, car Pub/Sub utilise un mécanisme de distribution différent.

Pour configurer un canal de notification Pub/Sub:

Activer les API requises et créer un sujet
Configurer le canal de notification pour un sujet
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 accordez-lui rôle de roles/pubsub.subscriber.

Avant de commencer

Lorsque vous ajoutez le premier canal de notification Pub/Sub à une projet Google Cloud, Cloud Monitoring crée un compte de service pour ce projet. Il attribue aussi le rôle Identity and Access Management Agent de service Monitoring Notification au compte de service. Ce compte de service permet à Monitoring d'envoyer des notifications vers les 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 des notifications inclut un numéro de projet Google Cloud unique ; Vous trouverez le nom, l'ID et le numéro du projet sur le tableau de bord du projet dans la console Google Cloud vous pouvez 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 du la console Google Cloud ou la 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 Pub/Sub, procédez comme suit:

Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

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

Go to project selector

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Pub/Sub and Cloud Monitoring.

Activer les API

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

Go to project selector

Vérifiez que la facturation est activée pour votre projet Google Cloud.

Activer les API Pub/Sub and Cloud Monitoring.

Activer les API

Créer un sujet Pub/Sub Pour savoir comment créer un sujet, consultez Créez un sujet. Par exemple, pour créer un sujet appelé notificationTopic, à l'aide de la 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 le l'API Monitoring, la Google Cloud CLI ou console Google Cloud. Après avoir créé la notification d'autorisation, autorisez le compte de service des notifications chaque sujet que vous utilisez comme canal de notification.

Pour en savoir plus sur l'utilisation de l'API Monitoring ou Google Cloud CLI pour créer le canal de notification, consultez Créer des chaînes

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

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 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 Created Pub/Sub Channel (Canal Pub/Sub créé) affiche le nom compte de service sur lequel Monitoring créé.
Autorisez le compte de service. Votre compte de service peut publier Tous les thèmes ou sujets spécifiques:
- Pour publier tous les sujets, sélectionnez Gérer les rôles. et ajoutez le rôle Éditeur Pub/Sub.
  
  Après avoir suivi les étapes de configuration de la notification passez à la section suivante, intitulée Autorisez le compte de service, puis passez à Définissez le canal de notification dans une règle d'alerte.
- Pour publier des sujets spécifiques, passez à l'étape suivante et autoriser le compte de service à publier des sujets spécifiques terminer la configuration du canal de notification. Instructions pour autoriser le compte de service, consultez Autorisez le compte de service.
Saisissez un nom à afficher pour votre chaîne, puis le Nom du sujet Pub/Sub.
(Facultatif) Pour vérifier que le canal est correctement configuré, procédez comme suit : cliquez sur Envoyer une notification test.
Sélectionnez Ajouter un canal.

Autorisez ensuite le compte de service.

Autoriser le compte de service

L'autorisation permet au compte de service des notifications publier chaque sujet Pub/Sub que vous utilisez en tant que canal de notification. Cette section décrit 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 en utilisant la console Google Cloud, procédez comme suit:

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

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 de la notification. de service géré. Le compte de service porte les noms suivants : convention:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Sélectionnez le rôle Éditeur Pub/Sub, puis sélectionnez Enregistrer.

Pour autoriser votre compte de service pour un sujet spécifique en utilisant la Google Cloud CLI, accordez le rôle pubsub.publisher rôle IAM pour le sujet au compte de service. 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

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

 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 les pubsub topics add-iam-policy-binding page de référence.

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 indiqué 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 lorsque le compte de service ne figure pas dans la liste.
Sélectionnez Modifier pour le 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 éléments suivants : .

Exemples JSON

Par défaut, le backend d'alerte tente de générer un paquet JSON au format 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.

Règlement d'obsolescence

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 pouvez installer l'application Google Cloud Monitoring, vous devez avoir accès au Application Google Cloud Monitoring Si vous n'y avez pas accès, demandez à un administrateur Google Workspace d'effectuer les opérations suivantes:

Installer l'application Google Cloud Monitoring

Vous devez suivre la procédure suivante pour installer Application Google Cloud Monitoring Installation à partir de la Fiche Google Workspace Marketplace n'est pas pris 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, puis revenez à votre espace, saisissez @Google Cloud Monitoring, puis appuyez sur Entrée.
3. Cliquez sur Ajouter à l'espace.
Copiez l'ID de l'espace Chat dans le presse-papiers.

Si vous avez installé l'application Google Cloud Monitoring, l'espace Chat L'ID 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 suivant space/ à la fin de l'URL de votre 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 espace Chat dans le champ ID de l'espace Chat, puis cliquez sur Enregistrer.

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 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'ouvre dans une nouvelle 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 et, 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 concernant une chaîne non acceptée

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 Créer des notifications personnalisées avec Cloud Monitoring et Cloud Run Pour obtenir d'autres exemples, consultez les 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. Cependant, vous pouvez vérifier qu'un canal de notification est correctement configuré en créer une règle d'alerte et configurer la condition à remplir.

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

(Facultatif) Si vous n'avez pas encore de VM dans votre projet Google Cloud ou si vous souhaitez pour utiliser une autre VM à des fins de test, puis créez une VM:
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 plus sur la création de VM, consultez Créez 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 choisir 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 Inférieur au seuil pour le champ Position du seuil.
2. Sélectionnez une valeur supérieure à l'utilisation du processeur pour votre Compute Engine. Par exemple, si le graphique affiche l'utilisation du processeur soit d'environ 5%, puis 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é. Parce que vous sélectionné un seuil supérieur à l'utilisation du processeur 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 et 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 le la durée de la fermeture automatique est arrivée à expiration.
Si vous avez créé une instance de VM pour ce test, supprimez-la.

Si vous ne recevez pas les notifications attendues, vous pouvez Recherchez dans l'explorateur de journaux des entrées de journal contenant des informations sur les des notifications. Pour en savoir plus, consultez Vous ne recevez pas les notifications.

Modifier et supprimer des canaux de notification

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

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 concernant les erreurs du canal de notification, consultez la page Requêtes Cloud Monitoring.

Étape suivante

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