Gérer la surveillance synthétique

Ce document explique comment gérer la surveillance synthétique. Vous pouvez la liste de vos surveillances synthétiques. Pour chaque surveillance synthétique, peut consulter et modifier la configuration, afficher l'historique des exécutions et afficher les détails de chaque exécution. Vous pouvez gérer la surveillance synthétique en utilisant la console Google Cloud ou l'API Cloud Monitoring.

Pour savoir comment explorer les résultats de l'exécution et et journaux pour la surveillance synthétique, consultez Explorer les résultats de la surveillance synthétique

Avant de commencer

  • Pour obtenir les autorisations nécessaires pour afficher et modifier la surveillance synthétique à l'aide de la console Google Cloud, demandez à votre administrateur de vous accorder le les rôles IAM suivants 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.

  • Les instructions relatives aux API figurant sur cette page concernent APIs Explorer. Toutefois, vous pouvez également émettre une commande curl. APIs Explorer fournit la configuration syntax.

Répertorier les surveillances synthétiques

Console

Pour répertorier les surveillances synthétiques dans votre projet Google Cloud, procédez comme suit:

  1. Dans la console Google Cloud, accédez à Page Surveillance synthétique:

    Accéder à Surveillance synthétique

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

  2. Facultatif: Pour limiter les surveillances synthétiques répertoriées, ajoutez des filtres.

    Chaque filtre est composé d'un nom et d'une valeur. Vous pouvez définir la valeur comme étant une correspondance exacte d'un nom de surveillance synthétique ou une correspondance partielle. Les correspondances ne sont pas sensibles à la casse. Par exemple, pour répertorier tous les la surveillance synthétique dont le nom contient default, procédez comme suit:

    • Cliquez sur Filter table (Filtrer le tableau), puis sélectionnez Display name (Nom à afficher).
    • Saisissez default, puis appuyez sur la touche retour.

    Si vous avez plusieurs filtres, ils sont automatiquement reliés par un opérateur logique AND, sauf si vous insérez un filtre OR. L'exemple précédent utilise le filtre OR afin qu'un test de disponibilité soit affichée si son nom correspond à default ou Testing check.

La page Écrans synthétiques affiche les informations suivantes pour chaque surveillance synthétique:

  • État de la dernière exécution.
  • Lien vers des informations détaillées sur cette surveillance synthétique.
  • Taux de réussite et temps d'exécution moyen.
  • Nombre de règles d'alerte.
  • Pour modifier, copier ou supprimer la surveillance synthétique, ainsi que pour créer un règle d'alerte, utilisez la Menu Autres options.

gcloud

Pour répertorier vos tests de disponibilité et vos surveillances synthétiques, exécutez la commande suivante : la gcloud monitoring uptime list-configs :

gcloud monitoring uptime list-configs

Les données renvoyées incluent les éléments suivants:

  • Nom et nom à afficher.
  • Vérifiez l'identifiant.
  • Ressource surveillée.
  • Délai entre les vérifications.

Vous pouvez configurer la commande Google Cloud CLI pour filtrer et trier les résultats.

API

Pour répertorier les fonctionnalités de surveillance synthétique de votre projet Google Cloud, y compris tests de disponibilité, appelez Méthode projects.uptimeCheckConfigs.list:

  1. Cliquez sur projects.uptimeCheckConfigs.list.

  2. Utiliser APIs Explorer

    Définissez le parent de la méthode sur le nom du projet. utilisez le format suivant:

    projects/PROJECT_ID

    Dans l'expression précédente, PROJECT_ID correspond à l'ID de votre projet Google Cloud.

Pour la surveillance synthétique, le résultat contient un champ intitulé syntheticMonitor.

Afficher les détails d'une surveillance synthétique

Console

Pour afficher les détails d'une surveillance synthétique dans votre projet Google Cloud, procédez comme suit : effectuer les opérations suivantes:

  1. Dans la console Google Cloud, accédez à Page Surveillance synthétique:

    Accéder à Surveillance synthétique

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

  2. Pour ouvrir la page Détails de l'écran synthétique, recherchez l'icône la surveillance synthétique que vous souhaitez afficher, puis cliquez sur son nom.

    Si vous souhaitez afficher votre fonction Cloud Page Détails des fonctions fournies par Cloud Functions, sélectionnez l'onglet Code, puis cliquez sur le nom de la fonction. La page Functions details (Détails de la fonction) s'ouvre. dans une nouvelle fenêtre. Les onglets de cette page vous permettent de consulter les métriques et les journaux, et les informations de configuration.

gcloud

Pour répertorier les détails d'un test de disponibilité ou d'une surveillance synthétique, exécutez la commande gcloud monitoring uptime describe :

gcloud monitoring uptime describe CHECK_ID

Avant d'exécuter la commande précédente, remplacez CHECK_ID par l'identifiant du test de disponibilité ou de la surveillance synthétique. Vous trouverez à l'aide de la commande gcloud monitoring uptime list-configs. en examinant le champ name (nom). Pour en savoir plus, consultez Recherchez l'identifiant unique d'une surveillance synthétique.

Les données renvoyées pour le test de disponibilité incluent les éléments suivants:

  • Nom et nom à afficher.
  • Vérifiez l'identifiant.
  • Ressource surveillée.
  • Délai entre les vérifications.

API

Pour répertorier les détails d'une surveillance synthétique spécifique dans votre projet Google Cloud, procédez comme suit : appelle la méthode Méthode projects.uptimeCheckConfigs.get:

  1. Cliquez sur projects.uptimeCheckConfigs.get.

  2. Utiliser APIs Explorer

    Définissez le parent de la méthode sur l'identifiant de la surveillance synthétique. veillez à utiliser le format suivant:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Dans l'expression précédente, PROJECT_ID correspond à l'ID de votre projet Google Cloud. et CHECK_ID est l'ID de surveillance synthétique.

    Par exemple, la valeur du champ parent peut être:

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    Pour trouver la valeur de CHECK_ID, vous pouvez émettre le projects.uptimeCheckConfigs.list. Pour réduire le nombre de résultats renvoyés, ajoutez un filtre. Par exemple, ajoutez le filtre displayName="MySyntheticMonitor".

Modifier une surveillance synthétique ou une fonction Cloud

Console

Pour modifier une surveillance synthétique ou sa fonction Cloud, procédez comme suit : depuis la page Détails de l'écran synthétique, procédez comme suit:

  1. Dans la console Google Cloud, accédez à Page Surveillance synthétique:

    Accéder à Surveillance synthétique

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

  2. Recherchez la surveillance synthétique que vous souhaitez modifier, cliquez sur Autres options, puis sélectionnez Modifier.

  3. Facultatif: Pour modifier la fonction Cloud, cliquez sur Modifier la fonction. apportez les modifications souhaitées, puis cliquez sur Appliquer la fonction.

    Pour les vérificateurs de liens non fonctionnels, modifier l'URI d'origine ou les options définir les liens testés, modifier la fonction Cloud Mettez à jour l'objet options dans le fichier index.js. Pour en savoir plus sur les champs et la syntaxe de cet objet, consultez broken-links-ok/index.js.

  4. Pour conserver vos modifications, cliquez sur Enregistrer. Sinon, cliquez sur Annuler.

gcloud

Pour modifier un test de disponibilité ou la surveillance synthétique, exécutez la commande gcloud monitoring uptime update :

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS

Avant d'exécuter la commande précédente, procédez comme suit:

  • Remplacez CHECK_ID par l'identifiant du test de disponibilité ou la surveillance synthétique. Pour trouver cet identifiant, exécutez la commande Commande gcloud monitoring uptime list-configs et en examinant le champ name (nom). Pour en savoir plus, consultez Recherchez l'identifiant unique d'un test de disponibilité.

  • Définissez les champs que vous souhaitez modifier. Pour la surveillance synthétique, vous pouvez ne mettez à jour que les champs suivants:

    • Période
    • Nom à afficher
    • Délai avant expiration
    • Étiquettes utilisateur

Par exemple, pour définir la période d'une surveillance synthétique sur 10 minutes, exécutez la commande suivante:

gcloud monitoring uptime update CHECK_ID --period=10

API

Les règles et fonctions d'alerte ne sont pas contenues dans une surveillance synthétique. Ils ne peuvent donc pas être modifiés selon la procédure décrite dans la section suivante:

Pour modifier une surveillance synthétique, appelez la méthode Méthode projects.uptimeCheckConfigs.patch:

  1. Cliquez sur projects.uptimeCheckConfigs.patch.

  2. Utiliser APIs Explorer

    1. Définissez le parent de la méthode sur l'identifiant de la surveillance synthétique. veillez à utiliser le format suivant:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      Dans l'expression précédente, PROJECT_ID correspond à l'ID de votre projet Google Cloud. et CHECK_ID est l'ID de surveillance synthétique.

      Pour trouver la valeur de CHECK_ID, vous pouvez émettre le projects.uptimeCheckConfigs.list. Pour réduire le nombre de résultats renvoyés, ajoutez un filtre. Par exemple, ajoutez le filtre displayName="MySyntheticMonitor".

    2. Définissez le paramètre de requête de la méthode, updateMask, pour identifier les éléments les champs de l'objet sont en cours de modification. Par exemple, pour mettre à jour la valeur de displayName, le paramètre de requête est le suivant:

      updateMask=displayName

Copier une surveillance synthétique

Console

Pour copier une surveillance synthétique dans votre projet Google Cloud, procédez comme suit:

  1. Dans la console Google Cloud, accédez à Page Surveillance synthétique:

    Accéder à Surveillance synthétique

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

  2. Recherchez la surveillance synthétique que vous souhaitez modifier, cliquez sur Plus d'options, puis sélectionnez Copier.

    La boîte de dialogue Copy Synthetic Check (Copier la vérification synthétique) s'ouvre avec des champs préremplis. y compris une copie de la fonction Cloud.

  3. Cliquez sur Créer une fonction, mettez-la à jour si nécessaire, puis Cliquez sur Apply function (Appliquer la fonction).

  4. Pour conserver vos modifications, cliquez sur Créer. Sinon, cliquez sur Annuler.

    Lorsque vous cliquez sur Créer, votre fonction Cloud est créée et déployée, puis la surveillance synthétique est créée.

gcloud

Aucune méthode Google Cloud CLI ne vous permet de copier une surveillance synthétique.

API

Aucune méthode API ne vous permet de copier une surveillance synthétique. Cependant, vous pouvez effectuez une copie en procédant comme suit:

  1. Appelez la méthode projects.uptimeCheckConfigs.get. et enregistrez la réponse. Pour en savoir plus, consultez Affichez les détails d'une surveillance synthétique.
  2. Modifiez la réponse.
  3. Appelez la méthode projects.uptimeCheckConfigs.create. et transmettez à la méthode la réponse modifiée.

Supprimer une surveillance synthétique

Console

Pour supprimer une surveillance synthétique et les règles d'alerte associées, procédez comme suit : effectuer les opérations suivantes:

  1. Dans la console Google Cloud, accédez à Page Surveillance synthétique:

    Accéder à Surveillance synthétique

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

  2. Recherchez la surveillance synthétique que vous souhaitez supprimer, puis cliquez sur le bouton son nom.

  3. Facultatif: Si vous souhaitez supprimer la fonction Cloud, Sélectionnez l'onglet Code, puis cliquez sur le nom de la fonction. La page Functions details (Détails de la fonction) s'ouvre. dans une nouvelle fenêtre.

  4. Sur la page Détails de la surveillance synthétique, procédez comme suit : cliquez sur Supprimer, puis remplissez les champs de la boîte de dialogue.

    Vous venez de supprimer la surveillance synthétique.

  5. Pour supprimer la fonction Cloud, accédez à la page Détails de la fonction. cliquez sur Delete (Supprimer), puis remplissez les champs de la boîte de dialogue.

gcloud

Pour supprimer un test de disponibilité ou une surveillance synthétique, procédez comme suit : exécutez la commande gcloud monitoring uptime delete :

gcloud monitoring uptime delete CHECK_ID

Avant d'exécuter la commande précédente, remplacez CHECK_ID par l'identifiant du test de disponibilité ou de la surveillance synthétique. Vous trouverez à l'aide de la commande gcloud monitoring uptime list-configs. en examinant le champ name (nom). Pour en savoir plus, consultez Recherchez l'identifiant unique d'une surveillance synthétique.

API

Pour supprimer une surveillance synthétique et les règles d'alerte associées, appelez la méthode Méthode projects.uptimeCheckConfigs.delete:

  1. Cliquez sur projects.uptimeCheckConfigs.delete.

  2. Utiliser APIs Explorer

    Définissez le parent de la méthode sur l'identifiant de la surveillance synthétique. veillez à utiliser le format suivant:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Dans l'expression précédente, PROJECT_ID correspond à l'ID de votre projet Google Cloud. et CHECK_ID est l'ID de surveillance synthétique.

    Pour trouver la valeur de CHECK_ID, vous pouvez émettre le projects.uptimeCheckConfigs.list. Pour réduire le nombre de résultats renvoyés, ajoutez un filtre. Par exemple, ajoutez le filtre displayName="MySyntheticMonitor".

Trouver l'identifiant unique d'une surveillance synthétique

Lorsque la surveillance synthétique est créée, Monitoring lui attribue un identifiant. Cet identifiant est intégré Le nom de la ressource pour la surveillance synthétique se présente sous la forme suivante:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

Le CHECK_ID est inclus dans la réponse de la Google Cloud CLI. et les méthodes de l'API Cloud Monitoring qui créent ou répertorient des surveillances synthétiques.

Étape suivante