Créer et gérer des mises en attente

Ce document explique comment créer et gérer vos mises en attente. Une mise en pause empêche Cloud Monitoring la création d'incidents et l'envoi de notifications au cours d'une pour une période spécifique. Chaque mise en pause spécifie les ressources auxquelles elle s'applique.

Pour obtenir une présentation des concepts, consultez Suspendre les notifications et les incidents

Pour créer et gérer vos mises en attente, utilisez la console Google Cloud ou l'application API Cloud Monitoring.

Avant de commencer

  1. Assurez-vous de disposer des autorisations requises:

    • Pour obtenir les autorisations nécessaires pour afficher et modifier les mises en attente à 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, consultez Contrôler les accès avec Identity and Access Management.

  2. Si vous souhaitez utiliser les exemples de l'API Cloud Monitoring présentés dans ce document, effectuer les opérations suivantes:

    1. Créez une variable d'environnement, PROJECT_ID, destinée à contenir l'ID de votre Projet Google Cloud:

      PROJECT_ID=PROJECT_ID

    2. Authentifiez-vous dans la 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 attente

Pour empêcher les règles d'alerte de créer des incidents et d'envoyer des notifications, créer une mise en attente.

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

Console

  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. Pour mettre en attente un incident en cours, procédez comme suit: <ph type="x-smartling-placeholder">
      </ph>
    1. Dans le volet Incidents de la page "Alertes", recherchez votre incident. et cliquez sur Résumé de l'incident.
    2. Sur la page Détails de l'incident, cliquez sur Mettre en attente, puis sélectionnez la durée de la mise en pause. Vous ne pouvez pas configurer d'autres champs.

  3. Sinon, procédez comme suit :

    1. Sur la page Alertes, cliquez sur Créer une mise en attente.
    2. Saisissez un nom descriptif pour la mise en attente. Ce nom apparaît sur la Alertes.
    3. Sélectionnez une heure de début. Vous pouvez saisir une heure spécifique ou lancer la mettre en attente lorsque la mise en attente est créée.
    4. Indiquez la durée. La valeur de ce champ détermine la durée la mise en attente dure.

    5. Remplissez la section Critères de mise en attente. Vous pouvez utiliser Règles d'alerte pour sélectionner les règles d'alerte auxquelles mise en attente.

      Vous pouvez ajouter jusqu'à 16 règles d'alerte à une mettre en attente.

      Une fois que vous avez rempli la section Critères de la mise en attente, la section Créer une mise en attente répertorie les incidents antérieurs correspondant aux critères.

    6. Cliquez sur Créer.

API Cloud Monitoring

Pour créer une mise en attente, appelez la fonction 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

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

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

CLI gcloud

Pour créer une mise en attente, 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

Dans la commande précédente, end-time doit être retardé d'au moins une minute que start-time. 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 en une heure absolue. Pour lancer une mise en pause de 30 minutes à partir de l'heure actuelle, utilisez --start-time="+PTM30M".

Si vous spécifiez plusieurs projets, séparez-les par une virgule.

Par exemple, la commande suivante crée une mise en pause avec le nom à afficher « Semaine de la maintenance ». La mise en pause s'applique à deux règles d'alerte et s'applique intervalle de temps entre le 1er et le 7 mars:

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

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

{
 "name": "projects/my-project/snoozes/98765",
 "displayName": "Maintenance Week",
 "interval": {
   "startTime": "2023-03-01T08:00:00Z",
   "endTime": "2023-03-08T04:59:59Z"
 },
 "criteria": {
   "policies": [
     "projects/my-project/alertPolicies/12345",
     "projects/my-project/alertPolicies/23451",
   ]
 }
}

Si l'opération réussit, la réponse à cette commande est semblable à celle-ci:

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

Le nom d'une règle d'alerte ne s'affiche pas dans la console Google Cloud. À déterminez le nom d'une règle d'alerte, effectuez l'une des opérations suivantes:

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

Créer des mises en attente récurrentes

Pour créer des mises en attente à intervalles réguliers, vous pouvez écrire un script qui crée une mise en pause pour une règle d'alerte. Ensuite, utilisez un planificateur de tâches tel que cron ou Cloud Scheduler pour exécuter le script sur l'environnement programmation.

Répertorier les mises en attente

Lorsque vous créez une mise en attente, elle est ajoutée à l'historique des mises en attente pour votre projet. Cet enregistrement indique les événements expirés, actifs et à venir mises en attente. Vous ne pouvez pas supprimer des entrées de cet enregistrement. Autrement dit, vous ne pouvez pas supprimer faire une sieste. Toutefois, cette vue vous permet d'afficher les détails d'une mise en attente et vous pouvez effectuer des actions comme modifier ou copier la mise en attente.

Console

Pour afficher la liste des mises en attente, procédez comme suit:

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

    Accéder à l'interface des alertes

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

  2. Cliquez sur Voir toutes les mises en attente dans le volet En attente.

    La page Mettre en attente affiche la liste des mises en attente et une chronologie affiche sous forme de graphique les mises en attente passées, à venir et actives.

    • Pour modifier, copier, annuler une mise en attente ou y mettre fin, utilisez l'icône Menu Autres options pour la mettre en attente. L'état de mise en attente détermine les options disponibles.
    • Pour répertorier toutes les mises en attente, activez l'option Afficher les mises en attente précédentes. Par défaut, seuls les mises en attente actives et à venir sont répertoriées.
    • Pour modifier la période d'affichage du tableau Timeline, utilisez le Menu Période. Par défaut, le tableau affiche les données pour l’heure suivante ; vous pouvez modifier ce champ pour indiquer des périodes passées ou futures. Les mises en attente expirées sont conservées pendant 13 mois.
    • Pour afficher les détails d'une mise en attente spécifique, cliquez sur Afficher les détails.
    • Pour afficher un récapitulatif des mises en attente actives, placez votre curseur sur la zone ombrée de la ligne Active dans le tableau Timeline. Info-bulle affiche les informations récapitulatives.
    • Pour afficher une représentation graphique des mises en attente actives, procédez comme suit : Développez la ligne Actif du tableau Vos trajets.

API Cloud Monitoring

Pour répertorier toutes les mises en attente appartenant à un projet Google Cloud, appelez la méthode Méthode snoozes.list:

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

La méthode renvoie une liste d'objets snooze. Par exemple : Lorsqu'un projet comporte une mise en attente, la réponse à la commande snoozes.list ressemble à ceci:

{
  "snoozes": [
    {
      "name": "projects/my-project/snoozes/2986663705844383744",
      "criteria": {
        "policies": [
          "projects/my-project/alertPolicies/787884840895011889"
        ]
      },
      "interval": {
        "startTime": "2022-11-08T19:00:20Z",
        "endTime": "2022-11-08T19:05:20Z"
      },
      "displayName": "Snooze1"
    }
  ]
}

Pour obtenir des informations sur une mise en attente spécifique, appelez la méthode Méthode snoozes.get et spécifiez l'ID du projet et l'ID de la mise en attente. Dans la réponse précédente, l'ID de la mise en attente 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/2986663705844383744",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/787884840895011889"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T19:00:20Z",
    "endTime": "2022-11-08T19:05:20Z"
  },
  "displayName": "Snooze1"
}

CLI gcloud

Pour répertorier les mises en attente dans votre projet actuel, exécutez la Commande gcloud monitoring snoozes list:

gcloud monitoring snoozes list OPTIONAL_FLAGS

Pour en savoir plus sur les options facultatives, consultez la gcloud monitoring snoozes list.

La réponse à cette commande est une liste de noms de répétitions dans le projet, au format YAML. Par exemple, la réponse à cette commande Le projet Google Cloud portant l'ID my-project est une entrée unique:

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/98765

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

gcloud monitoring snoozes describe NAME

Par exemple, pour afficher les détails de la mise en attente avec un nom projects/my-project/snoozes/98765, exécutez la commande suivante:

gcloud monitoring snoozes describe projects/my-project/snoozes/98765

Si vous indiquez un NAME non valide pour une commande describe, contient le 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 mise en attente

Vous pouvez modifier le nom et la période d'une mise en attente à venir, et vous pouvez modifier le le nom et l'heure de fin d'une mise en pause active. Par exemple, lorsqu'un intervalle de maintenance a été reprogrammée, vous devrez peut-être modifier une mise en attente.

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

Console

Pour modifier une mise en attente, procédez comme suit:

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

    Accéder à l'interface des alertes

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

  2. Cliquez sur Voir toutes les mises en attente dans le volet En attente.
  3. Dans la liste des mises en attente, recherchez celle que vous souhaitez modifier, puis sélectionnez Modifier la mise en attente dans le menu Plus d'options .
  4. Cliquez sur Enregistrer une fois les modifications effectuées.

API Cloud Monitoring

Pour modifier une mise en attente existante, appelez la 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 en URL.

Pour les mises en attente à venir, vous pouvez modifier le nom et la durée des règles. Pour les campagnes mises en attente, vous pouvez modifier le nom et l'heure de fin. Vous ne pouvez pas modifier mises en attente passées.

Pour mettre à jour l'élément displayName d'une mise en pause, créez un fichier JSON. my-updated-snooze.json, qui décrit l'objet de mise en attente 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

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

{
  "name": "projects/my-project/snoozes/2986665388391530496",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/7164333552684403347"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T22:26:05Z",
    "endTime": "2022-11-08T22:31:05Z"
  },
  "displayName": "Updated snooze name"
}

CLI gcloud

Pour modifier une mise en pause, exécutez la gcloud monitoring snoozes update. Vous pouvez mettre à jour le nom à afficher, les heures de début et de fin:

gcloud monitoring snoozes update NAME OPTIONAL_FLAGS

Pour obtenir la liste des options de la commande update, consultez les page de référence gcloud monitoring snoozes update.

Par exemple, pour remplacer le nom à afficher de la mise en attente projects/my-project/snoozes/98765, exécutez la commande suivante:

gcloud monitoring snoozes update projects/my-project/snoozes/98765  --display-name="March Maintenance"

Mettre fin à une mise en pause ou l'annuler

Si vous souhaitez recevoir des notifications pour les ressources qui correspondent aux critères spécifié dans une mise en pause active, puis mettez fin à celle-ci. Par exemple, lors de la planification s'effectue plus rapidement que prévu, vous pouvez mettre en attente.

Si vous souhaitez désactiver une mise en attente à venir, vous pouvez l'annuler. L'opération d'annulation définit la durée sur zéro et entraîne la mise en attente en passant à l'état Past.

Console

Pour mettre fin à une mise en pause active ou annuler une mise en pause à venir, procédez comme suit:

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

    Accéder à l'interface des alertes

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

  2. Cliquez sur Voir toutes les mises en attente dans le volet En attente.

  3. Dans la liste des mises en attente, recherchez celle que vous voulez arrêter ou annuler. puis effectuez l'une des opérations suivantes:

    • Pour mettre fin à une mise en pause active, sélectionnez Arrêter maintenant dans Menu Autres options.
    • Pour annuler une mise en attente à venir, sélectionnez Annuler la mise en attente dans les Menu Autres options.

API Cloud Monitoring

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

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

CLI gcloud

Pour mettre fin à une mise en pause active ou annuler une mise en pause à venir, exécutez l' Commande gcloud monitoring snoozes cancel:

gcloud monitoring snoozes cancel NAME

Par exemple, pour annuler la mise en pause avec le nom projects/my-project/snoozes/98765, exécutez la commande suivante:

gcloud monitoring snoozes cancel projects/my-project/snoozes/98765

Copier une mise en attente

Lorsque vous souhaitez utiliser une mise en attente existante pour une autre mise en attente, faites-en une copie. Lorsque vous copiez une mise en attente, l'éditeur de mise en attente s'ouvre avec tous les champs, à l'exception de l'heure de début défini sur les valeurs de la mise en attente d'origine. Vous pouvez modifier tous les champs avant de cliquer sur Créer.

Pour copier une mise en pause à 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. Cliquez sur Voir toutes les mises en attente dans le volet En attente.
  3. Dans la liste des mises en attente, recherchez celle que vous souhaitez modifier, puis sélectionnez Copier la mise en attente dans le menu Plus d'options .
  4. Appliquez vos modifications à la copie, puis cliquez sur Créer.

Étape suivante