Gérer les surveillances synthétiques

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 vos moniteurs synthétiques à l'aide de la console Google Cloud ou de l'API Cloud Monitoring.

Pour savoir comment explorer les résultats d'exécution, les métriques et les journaux d'un moniteur synthétique, consultez la section Explorer les résultats d'un moniteur 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 page Gérer l'accès aux projets, aux dossiers et aux organisations.

    Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

  • Les instructions de l'API sur cette page sont destinées à l'explorateur d'API. Toutefois, vous pouvez également émettre une commande curl. APIs Explorer fournit la configuration syntaxe.

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 ou une correspondance partielle d'un nom de moniteur synthétique. Les correspondances ne sont pas sensibles à la casse. Par exemple, pour répertorier tous les moniteurs synthétiques 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 l'exécution la plus récente.
  • 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 : le gcloud monitoring uptime list-configs commande:

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.
  • Période entre les vérifications.

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

API

Pour répertorier les moniteurs synthétiques de votre projet Google Cloud, y compris les vérifications de l'état de fonctionnement, appelez la 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, en vous assurant d'utiliser le format suivant :

    projects/PROJECT_ID

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

Pour une 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 :

  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 Run à partir du Page Détails des fonctions fournies par les fonctions Cloud Run, sélectionnez l'onglet Code, puis cliquez sur le nom de la fonction. La page Informations sur les fonctions s'ouvre dans une nouvelle fenêtre. Les onglets de cette page vous permettent d'afficher des métriques, des journaux et des informations de configuration.

gcloud

Pour afficher les détails d'un test de disponibilité ou d'un moniteur 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 du moniteur synthétique. Pour trouver l'identifiant, exécutez la commande gcloud monitoring uptime list-configs et examinez le champ name. Pour en savoir plus, consultez Recherchez l'identifiant unique d'une surveillance synthétique.

Les données renvoyées pour le contrôle de l'état de fonctionnement incluent les éléments suivants :

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

API

Pour afficher les détails d'un moniteur synthétique spécifique dans votre projet Google Cloud, appelez la 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, incluez un filtre. Par exemple, ajoutez le filtre displayName="MySyntheticMonitor".

Modifier une fonction de surveillance synthétique ou Cloud Run

Console

Pour modifier un moniteur synthétique ou sa fonction Cloud Run à l'aide de la page Informations sur le moniteur synthétique, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la 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 Run, cliquez sur Modifier la fonction. apportez les modifications souhaitées, puis cliquez sur Appliquer la fonction.

    Pour les outils de vérification des liens brisés, pour modifier l'URI d'origine ou les options qui définissent les liens à tester, modifiez la fonction Cloud Run, puis 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 un moniteur 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 les moniteurs synthétiques, vous ne pouvez modifier que les champs suivants :

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

Par exemple, pour définir la période d'un moniteur 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 un moniteur synthétique. Par conséquent, elles ne peuvent pas être modifiées par la procédure décrite dans cette section :

Pour modifier un moniteur synthétique, appelez la 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 à l'ID du moniteur 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, incluez 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 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 à la 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 le moniteur synthétique que vous souhaitez modifier, cliquez sur  Autres 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 Run.

  3. Cliquez sur Créer une fonction, mettez à jour la fonction si nécessaire, puis cliquez sur 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 Run 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 la section Afficher 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 à la 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 le moniteur synthétique que vous souhaitez supprimer, puis cliquez sur son nom.

  3. Facultatif: Si vous souhaitez supprimer la fonction Cloud Run, Sélectionnez l'onglet Code, puis cliquez sur le nom de la fonction. La page Informations sur les fonctions 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 avez maintenant supprimé la surveillance synthétique.

  5. Pour supprimer la fonction Cloud Run, accédez à la page Informations sur 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, exécutez la commande gcloud monitoring uptime delete commande:

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. Pour trouver l'identifiant, exécutez la commande gcloud monitoring uptime list-configs et examinez le champ name. 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. Utilisez 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 à l'ID du moniteur synthétique.

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

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

Lorsque votre surveillance synthétique est créée, Monitoring lui attribue un identifiant. Cet identifiant est intégré au nom de la ressource du moniteur synthétique et 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