Gérer les moniteurs synthétiques

Ce document explique comment gérer vos vérifications synthétiques. Vous pouvez afficher la liste de vos moniteurs synthétiques. Pour chacun d'eux, vous pouvez afficher et modifier la configuration, consulter l'historique des exécutions et afficher des informations détaillées sur chaque exécution. Vous pouvez gérer vos contrôles 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'une surveillance synthétique, consultez Explorer les résultats de la surveillance synthétique.

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 contrôleur synthétique, procédez comme suit :

  • Pour obtenir les autorisations nécessaires pour afficher et modifier des synthétiques à l'aide de la console Google Cloud , demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

    Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

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

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

  • Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

      In the Google Cloud console, activate Cloud Shell.

      Activate Cloud Shell

      At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

      REST

      Pour utiliser les exemples d'API REST de cette page dans un environnement de développement local, vous devez utiliser les identifiants que vous fournissez à gcloud CLI.

        After installing the Google Cloud CLI, initialize it by running the following command:

        gcloud init

        If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

      Pour en savoir plus, consultez la section S'authentifier pour utiliser REST dans la documentation sur l'authentification Google Cloud .

Lister les surveillances synthétiques

Console

Pour lister les synthétiques 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. 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. Facultatif : Pour restreindre les moniteurs synthétiques répertoriés, 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 contrôleur synthétique. Les correspondances ne sont pas sensibles à la casse. Par exemple, pour répertorier tous les contrôles 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 de sorte qu'un test de disponibilité soit répertorié si son nom correspond à default ou Testing check.

La page Surveillance synthétique 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 ce contrôleur synthétique.
  • Taux de réussite et temps d'exécution moyen.
  • Nombre de règles d'alerte.
  • Pour modifier, copier ou supprimer le test synthétique, et pour créer une règle d'alerte, utilisez le menu Plus d'options.

gcloud

Pour lister vos tests de disponibilité et vos moniteurs synthétiques, exécutez la commande gcloud monitoring uptime list-configs :

gcloud monitoring uptime list-configs --project=PROJECT_ID

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.

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.

REST

Pour lister les monitors synthétiques de votre projet Google Cloud , y compris les tests de disponibilité, appelez la méthode projects.uptimeCheckConfigs.list :

  1. Cliquez sur projects.uptimeCheckConfigs.list.
  2. Utilisez l'APIs Explorer.

    Définissez le parent de la méthode sur le nom du projet en veillant à utiliser le format suivant :

    projects/PROJECT_ID
    

    Dans l'expression précédente, PROJECT_ID correspond à l'ID de 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.

Pour un contrôleur synthétique, le résultat contient un champ intitulé syntheticMonitor.

Afficher les détails d'un moniteur synthétique

Console

Pour afficher les détails d'un monitor 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. 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. Pour ouvrir la page Détails du test synthétique, recherchez le test synthétique que vous souhaitez afficher, puis cliquez sur son nom.

    Si vous souhaitez afficher votre fonction Cloud Run sur la page Informations sur la fonction fournie par Cloud Run Functions, 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 les métriques et les journaux, ainsi que les informations de configuration.

gcloud

Pour lister les détails d'un test de disponibilité ou d'un monitor synthétique, exécutez la commande gcloud monitoring uptime describe :

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

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.
  • CHECK_ID : identifiant du test de disponibilité ou du contrôleur synthétique. Vous pouvez trouver l'identifiant en exécutant la commande gcloud monitoring uptime list-configs et en examinant le champ name. Pour en savoir plus, consultez Trouver l'identifiant unique d'un monitor 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.
  • Période entre les vérifications.

REST

Pour lister 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. Utilisez l'APIs Explorer.

    Définissez le parent de la méthode sur l'identifiant du contrôleur synthétique, en veillant à utiliser le format suivant :

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
    

    Dans l'expression précédente :

    • PROJECT_ID est l'ID de 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.
    • CHECK_ID est l'ID du contrôleur synthétique.

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

    projects/my-project/uptimeCheckConfigs/10863117100295372627
    

    Pour trouver la valeur de CHECK_ID, vous pouvez exécuter 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".

Modifier un moniteur synthétique ou une fonction Cloud Run

Console

Pour modifier une surveillance synthétique ou sa fonction Cloud Run à l'aide de la page Informations sur la surveillance 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. 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. Localisez le monitor synthétique que vous souhaitez modifier, cliquez sur Plus d'options, puis sélectionnez Modifier.
  4. Facultatif : Pour modifier la fonction Cloud Run, cliquez sur Modifier la fonction, apportez vos modifications, puis cliquez sur Appliquer la fonction.

    Pour les vérificateurs de liens rompus, afin de 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.

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

gcloud

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

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

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.
  • CHECK_ID : identifiant du test de disponibilité ou du moniteur synthétique. Vous pouvez trouver l'identifiant en exécutant la commande gcloud monitoring uptime list-configs et en examinant le champ name. Pour en savoir plus, consultez Trouver l'identifiant unique d'un test de disponibilité.

  • Définissez les champs que vous souhaitez modifier. Pour les moniteurs synthétiques, vous ne pouvez mettre à jour 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 --project=PROJECT_ID

REST

Les règles et fonctions d'alerte ne sont pas contenues dans un moniteur synthétique. Vous ne pouvez donc pas les modifier à l'aide de 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. Utilisez l'APIs Explorer.

    1. Définissez le parent de la méthode sur l'identifiant du contrôleur synthétique. L'identifiant apparaît au format suivant :

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
      

      Dans l'expression précédente :

      • PROJECT_ID est 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.
      • CHECK_ID est l'ID du contrôleur synthétique.

      Pour trouver la valeur de CHECK_ID, vous pouvez exécuter 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".

    2. Définissez le paramètre de requête updateMask de la méthode pour identifier les champs de l'objet qui sont modifiés. Par exemple, pour mettre à jour la valeur du paramètre de requête displayName, procédez comme suit :

      updateMask=displayName
      

Copier une surveillance synthétique

Console

Pour copier un test synthétique dans votre projet Google Cloud  :

  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. 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. Localisez le monitor synthétique que vous souhaitez modifier, cliquez sur Plus d'options, puis sélectionnez Copier.

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

  4. Cliquez sur Créer une fonction, modifiez la fonction si nécessaire, puis cliquez sur Appliquer la fonction.

  5. 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 le monitor synthétique est créé.

gcloud

Il n'existe aucune méthode Google Cloud CLI permettant de copier un monitor synthétique.

REST

Il n'existe aucune méthode d'API permettant de copier un moniteur synthétique. Toutefois, vous pouvez en créer 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 Afficher les détails d'une surveillance synthétique.
  2. Modifiez la réponse.
  3. Appelez la méthode projects.uptimeCheckConfigs.create et transmettez-lui la réponse modifiée.

Supprimer une surveillance synthétique

Console

Pour supprimer un contrôleur synthétique et les règles d'alerte associées :

  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. 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. Recherchez le monitor synthétique que vous souhaitez supprimer, puis cliquez sur son nom.

  4. 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.

  5. Sur la page Détails du test synthétique, cliquez sur Supprimer, puis suivez les instructions de la boîte de dialogue.

    Vous avez maintenant supprimé la surveillance synthétique.

  6. Pour supprimer la fonction Cloud Run, accédez à la page Informations sur la fonction, cliquez sur Supprimer, puis suivez les instructions de la boîte de dialogue.

gcloud

Pour supprimer un test de disponibilité ou un monitor synthétique, exécutez la commande gcloud monitoring uptime delete :

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

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.
  • CHECK_ID : identifiant du test de disponibilité ou du contrôleur synthétique. Vous pouvez trouver l'identifiant en exécutant la commande gcloud monitoring uptime list-configs et en examinant le champ name. Pour en savoir plus, consultez Trouver l'identifiant unique d'un monitor synthétique.

REST

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

  1. Cliquez sur projects.uptimeCheckConfigs.delete.
  2. Utilisez l'APIs Explorer.

    Définissez le parent de la méthode sur l'identifiant du contrôleur synthétique, en veillant à utiliser le format suivant :

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
    

    Dans l'expression précédente :

    • PROJECT_ID est 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.
    • CHECK_ID est l'ID du contrôleur synthétique.

    Pour trouver la valeur de CHECK_ID, vous pouvez exécuter 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'un monitor synthétique

Lorsque votre surveillance synthétique est créée, Monitoring lui attribue un identifiant. Cet identifiant est intégré au nom de ressource du contrôleur 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 des méthodes Google Cloud CLI et de l'API Cloud Monitoring qui créent ou listent les synthétiques.

Étapes suivantes