Créer et gérer des rappels

Ce document explique comment créer et gérer vos reports. Une mise en veille empêche Cloud Monitoring de créer des incidents et d'envoyer des notifications pendant une période spécifique. Chaque mise en veille spécifie les ressources auxquelles elle s'applique.

Pour obtenir une présentation conceptuelle, consultez Mettre en veille les notifications et les incidents.

Pour créer et gérer vos mises en veille, vous devez utiliser la console Google Cloud ou l'API Cloud Monitoring.

Cette fonctionnalité n'est disponible que pour les projets Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

Avant de commencer

Dans le projet Google Cloud qui stocke votre règle d'alerte, procédez comme suit :

  1. Assurez-vous de disposer des autorisations requises :

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

  2. Si vous souhaitez utiliser les exemples de l'API Cloud Monitoring de ce document, procédez comme suit :

    1. Créez une variable d'environnement, PROJECT_ID, pour contenir l'ID de votre projetGoogle Cloud  :

      PROJECT_ID=PROJECT_ID

    2. Authentifiez-vous sur Google Cloud CLI :

      gcloud auth login

    3. Définissez le projet Google Cloud par défaut :

      gcloud config set project ${PROJECT_ID}

    4. Créez un jeton d'autorisation :

      ACCESS_TOKEN=`gcloud auth print-access-token`

      Vous devez actualiser régulièrement le jeton d'accès. Si des commandes auparavant fonctionnelles indiquent soudainement que vous n'êtes pas authentifié, exécutez à nouveau cette commande.

Créer une mise en veille

Pour empêcher les règles d'alerte de créer des incidents et d'envoyer des notifications, créez une mise en veille. Si vous souhaitez ajouter un filtre basé sur un libellé à une mise en veille, celle-ci doit s'appliquer à une seule règle d'alerte. Une fois la mise en veille créée, vous ne pouvez plus modifier le filtre basé sur les libellés ni la liste des règles auxquelles la mise en veille s'applique.

Vous pouvez créer une mise en veille à l'aide de la console Google Cloud , de gcloud CLI ou de l'API Cloud Monitoring.

Console

Dans la console Google Cloud , vous pouvez créer une mise en veille à partir d'un incident ouvert ou de la page Alertes. Vous ne pouvez créer une mise en veille avec un filtre qu'à l'aide de la page "Détails de l'incident".

Pour créer une mise en veille à partir d'un incident ouvert :

  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. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  3. Dans le volet Incidents de la page "Alertes", recherchez votre incident, puis cliquez sur Résumé de l'incident.
  4. Sur la page Détails de l'incident, cliquez sur Mettre en veille, puis sélectionnez la durée de mise en veille.

  5. Facultatif : Pour ajouter un filtre basé sur les libellés à votre mise en veille, accédez à la section Libellés et sélectionnez un ou plusieurs libellés. Un filtre basé sur des libellés peut inclure des libellés de ressources et de métriques. Lorsque la règle d'alerte n'est pas basée sur PromQL, le filtre peut également inclure des libellés de métadonnées.

    Normalement, les mises en veille s'appliquent à tous les incidents créés par une règle d'alerte. Les filtres vous permettent de mettre en veille les incidents dont les libellés correspondent à ceux du filtre.

  6. Cliquez sur Mettre en veille. La mise en veille s'applique désormais à la règle d'alerte qui a créé l'incident.

Pour créer une mise en veille depuis la page Alertes :

  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. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  3. Sur la page Alertes, cliquez sur Créer une mise en veille.
  4. Attribuez un nom descriptif à la mise en veille. Ce nom s'affiche sur la page Alertes.
  5. Sélectionnez une heure de début. Vous pouvez saisir une heure précise ou commencer la mise en veille au moment de sa création.
  6. Saisissez la durée. La valeur de ce champ détermine la durée de la mise en veille.

  7. Remplissez la section Critères de mise en veille. Vous pouvez utiliser le menu Règles d'alerte pour sélectionner les règles d'alerte auxquelles s'applique la mise en veille.

    Vous pouvez ajouter jusqu'à 16 règles d'alerte à une mise en veille.

    Une fois la mise en veille créée, ses critères ne peuvent plus être modifiés.

    Une fois la section Critères de mise en veille remplie, le volet Créer une mise en veille liste les incidents passés qui correspondent aux critères.

  8. Cliquez sur Créer.

API Cloud Monitoring

Pour créer une mise en veille, appelez la méthode snoozes.create en envoyant une requête POST au point de terminaison Snooze. Vous devez fournir un objet snooze :

curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

Dans l'expression précédente, PROJECT_ID est une variable d'environnement qui stocke l'ID de votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

La méthode renvoie un objet snooze. Le champ "name", qui inclut l'ID de mise en veille généré par Monitoring, est la seule différence entre l'objet renvoyé et le contenu de my-snooze.json :

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/001122"
    ]
  },
  "interval": {
    "startTime": "2022-11-12T19:00:20Z",
    "endTime": "2022-11-12T19:05:20Z"
  },
  "displayName": "Snooze2"
}

CLI gcloud

Pour créer une mise en veille, exécutez la commande gcloud monitoring snoozes create :

gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME --project=PROJECT_ID --criteria-filter=FILTER

Avant d'exécuter la commande précédente, remplacez les éléments suivants :

  • LIST_OF_POLICIES : règles auxquelles la mise en veille s'applique. Si vous spécifiez plusieurs projets, séparez-les par une virgule.
  • PROJECT_ID : identifiant du projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  • DISPLAY_NAME : nom à afficher dans la console Google Cloud .
  • START_TIME : heure de début.

  • END_TIME : heure de fin. La valeur doit être au moins une minute après l'heure de début.

    Pour les heures de début et de fin, vous devez respecter les règles de mise en forme ISO 8601. Toutefois, vous pouvez spécifier des heures absolues ou relatives. L'exemple suivant spécifie des heures absolues. Pour programmer un report de 30 minutes à partir de l'heure actuelle, utilisez --start-time="+PTM30M".

  • FILTER : facultatif. Un filtre basé sur un libellé peut être défini lorsque la mise en veille s'applique à une règle d'alerte. Le filtre, qui peut inclure des libellés de ressources, de métriques et de métadonnées, applique la mise en veille aux incidents comportant des libellés correspondants. Lorsque la règle d'alerte est basée sur PromQL, le filtre ne peut pas utiliser de libellés de métadonnées. Pour en savoir plus, consultez la page de référence sur gcloud monitoring snoozes create.

Par exemple, la commande suivante crée une mise en veille pour une règle d'alerte dont l'ID est "12345". La période de report correspond à l'intervalle du 1er mars 2025 au 7 mars 2025.

gcloud monitoring snoozes create --display-name="Maintenance Week" \
    --criteria-policies="projects/my-project/alertPolicies/12345" \
    --start-time="2025-03-01T03:00:00.0-0500" \
    --end-time="2025-03-07T23:59:59.5-0500" \
    --project=PROJECT_ID

L'exemple précédent crée la mise en veille suivante dans my-project :

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Maintenance Week"
}

Si l'opération réussit, la réponse à cette commande est semblable à ce qui suit :

Created snooze [projects/my-project/snoozes/778899]

Le nom d'une règle d'alerte ne s'affiche pas dans la console Google Cloud . Pour déterminer le nom d'une règle d'alerte, procédez comme suit :

  • Exécutez la commande gcloud alpha monitoring policies list. Les données de réponse de cette commande incluent le nom de vos règles d'alerte.
  • Affichez la représentation JSON d'une règle d'alerte. Vous pouvez télécharger la représentation JSON sur votre système local à l'aide d'une option de la page Détails de la règle.

Créer des mises en veille récurrentes

Pour créer des reports qui se produisent à intervalles récurrents, vous pouvez écrire un script qui crée un report pour une règle d'alerte. Ensuite, utilisez un planificateur de tâches tel que cron ou Cloud Scheduler pour exécuter le script selon la planification requise.

Lister les mises en veille

Lorsque vous créez une mise en veille, elle est ajoutée à l'historique des mises en veille de votre projet. Cet enregistrement affiche les reports expirés, actifs et à venir. Vous ne pouvez pas supprimer d'entrées de cet enregistrement, c'est-à-dire que vous ne pouvez pas supprimer une mise en veille. Toutefois, dans cette vue, vous pouvez afficher les détails d'une mise en veille et effectuer des actions telles que la modifier ou la copier.

Console

Pour afficher la liste des mises en veille :

  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. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

  3. Cliquez sur Afficher toutes les mises en veille dans le volet Mettre en veille.

    La page Mettre en veille affiche une liste des mises en veille et une chronologie qui représente graphiquement vos mises en veille passées, à venir et actives.

    • Pour modifier, copier, annuler ou mettre fin à une période de report, utilisez le menu Plus d'options correspondant. L'état de mise en veille détermine les options disponibles.
    • Pour lister toutes les répétitions, activez Afficher les répétitions passées. Par défaut, seules les mises en veille actives et à venir sont listées.
    • Pour modifier la période d'affichage du tableau Chronologie, utilisez le menu Période. Par défaut, le tableau affiche les données pour l'heure suivante. Toutefois, vous pouvez modifier ce champ pour spécifier des périodes passées ou futures. Les rappels expirés sont conservés pendant 13 mois.
    • Pour afficher les détails d'une mise en veille spécifique, cliquez sur Afficher les détails.
    • Pour afficher un récapitulatif des mises en veille actives, placez le pointeur sur la zone ombrée de la ligne Actif dans le tableau Chronologie. L'info-bulle affiche les informations récapitulatives.
    • Pour afficher une représentation graphique des mises en veille actives, développez la ligne Actif du tableau Chronologie.

API Cloud Monitoring

Pour lister toutes les mises en veille appartenant à un projet Google Cloud , appelez la méthode snoozes.list :

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

Dans l'expression précédente, PROJECT_ID est une variable d'environnement qui stocke l'ID de votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

La méthode renvoie une liste d'objets snooze. Par exemple, lorsqu'un projet est mis en veille, la réponse à la commande snoozes.list est semblable à ce qui suit :

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

Pour obtenir des informations sur une mise en veille spécifique, appelez la méthode snoozes.get et spécifiez l'ID du projet et l'ID de la mise en veille. Dans la réponse précédente, l'ID de la mise en veille est 2986663705844383744 :

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}

La méthode renvoie un seul objet snooze :

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

CLI gcloud

Pour lister les mises en veille de votre projet actuel, exécutez la commande gcloud monitoring snoozes list :

gcloud monitoring snoozes list --project=PROJECT_ID OPTIONAL_FLAGS

Avant d'exécuter la commande précédente, remplacez les éléments suivants :

  • PROJECT_ID : identifiant du projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  • OPTIONAL_FLAGS : pour en savoir plus sur les indicateurs facultatifs, consultez la page de référence gcloud monitoring snoozes list.

La réponse à cette commande est une liste des noms des mises en veille du projet, au format YAML. Par exemple, la réponse à cette commande pour le projetGoogle Cloud avec l'ID my-project est une seule entrée :

criteria:
  policies:
  - projects/my-project/alertPolicies/12345
  - projects/my-project/alertPolicies/23451
displayName: Maintenance Week
interval:
  endTime: '2023-03-08T04:59:59Z'
  startTime: '2023-03-01T08:00:00Z'
name: projects/my-project/snoozes/778899

Pour afficher les détails d'une mise en veille spécifique, exécutez la commande gcloud monitoring snoozes describe :

gcloud monitoring snoozes describe NAME --project=PROJECT_ID

Par exemple, pour afficher les détails de la mise en veille nommée projects/my-project/snoozes/778899, exécutez la commande suivante :

gcloud monitoring snoozes describe projects/my-project/snoozes/778899 --project=PROJECT_ID

Si vous fournissez un NAME non valide à une commande describe, la réponse contient un code d'erreur 500 et le message suivant :

Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.

Modifier une répétition

Vous pouvez modifier le nom et la période d'une future mise en veille, ainsi que le nom et l'heure de fin d'une mise en veille active. Par exemple, lorsqu'un intervalle de maintenance est reprogrammé, vous devrez peut-être modifier une mise en veille.

Vous ne pouvez pas modifier une mise en veille passée ni les critères d'une mise en veille. Toutefois, si vous souhaitez planifier une mise en veille passée pour une période future, copiez-la et apportez les modifications à la copie avant de sélectionner Créer.

Console

Pour modifier une mise en veille :

  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. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  3. Cliquez sur Afficher toutes les mises en veille dans le volet Mettre en veille.
  4. Dans la liste des mises en veille, recherchez celle que vous souhaitez modifier, puis sélectionnez Modifier la mise en veille dans le menu Plus d'options.
  5. Une fois les modifications terminées, cliquez sur Enregistrer.

API Cloud Monitoring

Pour modifier une mise en veille existante, appelez la méthode snoozes.patch en envoyant une requête PATCH au point de terminaison Snooze. Vous devez fournir l'objet snooze révisé et inclure des paramètres de requête qui identifient les champs modifiés. Lorsque vous utilisez curl, les paramètres de requête doivent être encodés au format URL.

Pour les rappels à venir, vous pouvez modifier le nom et la période. Pour les mises en veille actives, vous pouvez modifier le nom et l'heure de fin. Vous ne pouvez pas modifier les reports passés.

Pour mettre à jour le displayName d'une mise en veille, créez un fichier JSON, my-updated-snooze.json, qui décrit l'objet de mise en veille et met à jour le nom à afficher. Exécutez ensuite la commande suivante :

curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName

Dans l'expression précédente :

  • PROJECT_ID est une variable d'environnement qui stocke l'ID de votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

  • SNOOZE_ID est une variable d'environnement qui stocke l'ID de la mise en veille.

La méthode renvoie un objet snooze identique au contenu du fichier my-updated-snooze.json :

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

CLI gcloud

Pour modifier une mise en veille, exécutez la commande gcloud monitoring snoozes update. Vous pouvez modifier le nom à afficher, l'heure de début et l'heure de fin :

gcloud monitoring snoozes update NAME --project=PROJECT_ID OPTIONAL_FLAGS

Avant d'exécuter la commande précédente, remplacez les éléments suivants :

  • NAME : nom de la mise en veille.
  • PROJECT_ID : identifiant du projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  • OPTIONAL_FLAGS : pour en savoir plus sur les indicateurs facultatifs, consultez la page de référence gcloud monitoring snoozes update.

Par exemple, pour modifier le nom à afficher du report portant le nom projects/my-project/snoozes/778899, exécutez la commande suivante :

gcloud monitoring snoozes update projects/my-project/snoozes/778899 --display-name="Maintenance Week" --project=PROJECT_ID

Mettre fin à la répétition ou l'annuler

Si vous souhaitez recevoir des notifications pour les ressources qui correspondent aux critères spécifiés dans une mise en veille active, mettez fin à la mise en veille. Par exemple, si une maintenance planifiée se termine plus rapidement que prévu, vous pouvez mettre fin à une mise en veille.

Si vous avez une alarme différée que vous ne souhaitez plus, annulez-la. L'opération d'annulation définit la durée sur zéro et entraîne le passage de la mise en veille à l'état Passé.

Console

Pour mettre fin à une période de report active ou annuler une période de report à venir :

  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. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  3. Cliquez sur Afficher toutes les mises en veille dans le volet Mettre en veille.

  4. Dans la liste des reports, recherchez celui que vous souhaitez terminer ou annuler, puis effectuez l'une des opérations suivantes :

    • Pour mettre fin à une mise en veille active, sélectionnez Mettre fin maintenant dans le menu Plus d'options.
    • Pour annuler une prochaine mise en veille, sélectionnez Annuler la mise en veille dans le menu Plus d'options.

API Cloud Monitoring

Pour mettre fin à une mise en veille active, modifiez-la et définissez l'heure de fin sur l'heure actuelle. Pour en savoir plus, consultez Modifier une mise en veille.

Pour annuler une mise en veille à venir, modifiez-la et définissez l'heure de fin sur l'heure de début. L'heure de début doit être située dans le futur. Pour en savoir plus, consultez Modifier une mise en veille.

CLI gcloud

Pour mettre fin à une mise en veille active ou annuler une mise en veille à venir, exécutez la commande gcloud monitoring snoozes cancel :

gcloud monitoring snoozes cancel NAME --project=PROJECT_ID

Avant d'exécuter la commande précédente, remplacez les éléments suivants :

  • NAME : nom de la mise en veille.
  • PROJECT_ID : identifiant du projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

Par exemple, pour annuler la mise en veille nommée projects/my-project/snoozes/778899, exécutez la commande suivante :

gcloud monitoring snoozes cancel projects/my-project/snoozes/778899 --project=PROJECT_ID

Copier une mise en veille

Si vous souhaitez utiliser une mise en veille existante comme modèle pour une autre, faites-en une copie. Lorsque vous copiez une période de report, l'éditeur de report s'ouvre avec tous les champs définis sur les valeurs de la période de report d'origine, à l'exception de l'heure de début. Vous pouvez modifier tous les champs avant de cliquer sur Créer.

Pour copier une mise en veille à l'aide de la console, procédez comme suit :

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

    Accéder à l'interface des alertes

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
  3. Cliquez sur Afficher toutes les mises en veille dans le volet Mettre en veille.
  4. Dans la liste des reports, recherchez celui que vous souhaitez modifier, puis sélectionnez Copier le report dans le menu Plus d'options.
  5. Appliquez vos modifications à la copie, puis cliquez sur Créer.

Étapes suivantes