Configurer la surveillance des applications

Ce document explique comment configurer Google Cloud Observability afin de pouvoir afficher la télémétrie d'une application enregistrée auprès de App Hub. Vous pouvez déployer votre application, puis l'enregistrer dans App Hub, ou déployer vos applications à l'aide d'Application Design Center. La surveillance des applications peut vous aider à comprendre les performances de vos applications, services et charges de travail.

Avant de commencer

  • Identifiez le projet dont vous allez configurer la portée d'observabilité. Il s'agit de votre projet hôte App Hub ou du projet de gestion des dossiers compatibles avec les applications. Par exemple, si le nom à afficher du dossier est My Folder, le nom à afficher du projet de gestion est My Folder-mp.

  • Assurez-vous de disposer des rôles IAM (Identity and Access Management) nécessaires pour configurer le champ d'application de l'observabilité. Les rôles IAM requis dépendent de votre intention de créer un récepteur agrégé, qui vous permet de centraliser le stockage des données de journal.

    Configurer le récepteur et les champs d'application

    Pour obtenir les autorisations nécessaires pour configurer des champs d'application d'observabilité et créer un collecteur de journaux agrégé, demandez à votre administrateur de vous accorder le rôle IAM Administrateur de l'organisation (roles/resourcemanager.organizationAdmin) dans votre organisation. 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.

    Ne configurer que des champs d'application

    Pour obtenir les autorisations nécessaires pour configurer le champ d'application de l'observabilité, demandez à votre administrateur de vous accorder les rôles IAM suivants:

    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.

Configurer le champ d'application de l'observabilité

Le champ d'application de l'observabilité contrôle la façon dont les pages de l'explorateur et du tableau de bord recherchent les données à afficher. Chaque projet Google Cloud contient un seul champ d'application de l'observabilité. Vous ne configurez pas directement la portée d'observabilité d'un projet. À la place, vous devez configurer les éléments suivants pour votre projet:

  • Etendue des journaux par défaut

    Configurez cette portée afin que les données de journal de votre application s'affichent lorsque vous ouvrez la page Explorateur de journaux ou que vous consultez des tableaux de bord. Assurez-vous que ce champ d'application liste les projets et les vues de journaux qui stockent les données de journal de votre application.

  • Champ d'application des métriques

    Configurez cette portée afin que vos graphiques, par exemple ceux que vous créez à l'aide de la page Explorateur de métriques, et les règles d'alerte puissent afficher ou surveiller les données de métrique de votre application. Assurez-vous que ce champ d'application liste les projets qui stockent les données de métriques de votre application.

  • Champ d'application de la trace par défaut

    Configurez ce champ d'application de trace afin que les données de trace de votre application s'affichent lorsque vous ouvrez la page Explorateur Trace. Assurez-vous que cette portée liste les projets qui stockent les données de trace de votre application.

Le reste de cette section explique comment configurer ces champs d'application.

Configurer et définir la portée des journaux par défaut

Effectuez l'une des opérations suivantes :

  • Si vous disposez d'un récepteur agrégé au niveau de l'organisation qui achemine toutes les données de journal de votre organisation vers un bucket de journaux centralisé, nous vous recommandons les mesures suivantes:

    1. Créez une vue de journal sur le bucket de journaux centralisé pour les journaux de votre application.

    2. Dans le projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications, créez une portée de journal et ajoutez votre vue de journal, puis définissez cette portée comme portée de journal par défaut.

  • Si vous utilisez un dossier compatible avec les applications et que vous ne disposez pas d'un récepteur agrégé au niveau de l'organisation ni de dossiers imbriqués, nous vous recommandons de suivre les étapes ci-dessous:

    1. Créez un récepteur agrégé intercepteur pour votre dossier compatible avec les applications, puis acheminez ces journaux vers le bucket de journaux _Default du projet à partir duquel vous afficherez vos journaux.

    2. Dans le projet de gestion de votre dossier compatible avec les applications, assurez-vous que le champ d'application nommé _Default est défini comme champ d'application par défaut. Le champ d'application nommé _Default liste la vue _AllLogs sur le bucket de journaux _Default du projet, qui est l'emplacement de stockage centralisé de votre application.

  • Si vous n'utilisez pas de récepteur agrégé, configurez la portée des journaux par défaut pour votre projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications afin de lister les emplacements de stockage des données de journal de votre application. Au lieu d'ajouter des projets à votre champ d'application de journaux, nous vous recommandons d'ajouter des vues de journaux sur les buckets de journaux qui stockent vos données de journal.

Configurer le champ d'application des métriques

Assurez-vous que le champ d'application des métriques de votre projet hôte App Hub ou du projet de gestion de votre dossier compatible avec les applications répertorie tous les projets qui stockent les données de métriques de votre application:

  • Pour les dossiers compatibles avec les applications, Google Cloud Observability tente de synchroniser la liste des projets de votre dossier compatible avec les applications avec la liste des projets du champ d'application des métriques. Par exemple, si vous ajoutez un projet au dossier compatible avec les applications, une commande est émise pour ajouter ce projet au champ d'application des métriques.

    Lorsque le nombre de projets dans votre dossier compatible avec l'application ne dépasse pas votre quota de champ d'application des métriques, qui est défini par défaut sur 375 projets par champ d'application des métriques, Google Cloud Observability peut synchroniser la liste des projets du champ d'application des métriques avec la liste des projets de votre dossier compatible avec l'application. Par exemple, supposons que le quota soit de 375 projets par champ d'application des métriques. Si votre dossier compatible avec l'application contient 100 projets, le champ d'application des métriques liste tous les projets de votre dossier compatible avec l'application. Si vous ajoutez des projets à votre dossier compatible avec l'application, ils sont également ajoutés au champ d'application des métriques.

    Lorsque le nombre de projets de votre dossier compatible avec l'application dépasse votre quota de champ d'application des métriques, la liste des projets du champ d'application des métriques n'inclut pas tous les projets de votre dossier compatible avec l'application. Par exemple, supposons que le quota soit de 375 projets par champ d'application des métriques et que votre dossier compatible avec l'application contienne 380 projets. Une fois 375 projets ajoutés au champ d'application des métriques, le quota est épuisé et les tentatives d'ajout des cinq projets restants échouent. Par conséquent, certaines données d'application ne sont pas disponibles pour votre projet de gestion.

    Nous vous recommandons d'examiner votre utilisation du quota de portée des métriques et de déterminer si vous devez demander une mise à jour du quota ou modifier manuellement la portée des métriques. Pour en savoir plus sur ces étapes, consultez la section Champs d'application des métriques pour les dossiers compatibles avec les applications.

  • Pour les projets hôtes App Hub, vous devez configurer le champ d'application des métriques du projet hôte.

    Si vous modifiez l'ensemble de projets qui stockent vos données de métriques, vous devez également mettre à jour le champ d'application des métriques de votre projet hôte.

Configurer et définir la portée de suivi par défaut

Procédez comme suit :

  1. Dans le projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications, créez un champ d'application et ajoutez les projets qui stockent les données de trace de votre application. Si vous utilisez un dossier compatible avec les applications, ajoutez-y les projets.

  2. Définissez votre champ d'application de trace personnalisée comme champ d'application de trace par défaut.

Associer une règle d'alerte à une application App Hub

Pour afficher vos règles d'alerte dans le contexte de la surveillance des applications, vous devez les associer à un service ou à une charge de travail en ajoutant des libellés spécifiques à l'application à la règle d'alerte. Ces libellés définis par l'utilisateur sont également inclus dans tous les incidents créés pour une règle. Pour en savoir plus sur les libellés, consultez la section Annoter des incidents avec des libellés. Pour obtenir la liste des libellés App Hub, consultez Afficher la télémétrie de l'application.

Pour associer une règle d'alerte à une charge de travail ou à un service à l'aide de la console Google Cloud, 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 hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications.
  3. Recherchez la règle d'alerte, cliquez sur  Afficher plus, sélectionnez Modifier, puis accédez à la section Notifications et nom.
  4. Dans la section Étiquettes d'application, sélectionnez votre application, puis votre charge de travail ou votre service.
  5. Cliquez sur Enregistrer la règle.

Une fois ces étapes terminées, des libellés avec les clés suivantes sont associés à votre règle d'alerte. Ces libellés identifient votre application et votre service ou charge de travail:

  • apphub_application_location
  • apphub_application_id
  • apphub_service_id ou apphub_workload_id

Vous pouvez également ajouter des libellés utilisateur à une règle d'alerte à l'aide de Google Cloud CLI, de Terraform ou de l'API Cloud Monitoring. Toutefois, vous devez utiliser les clés d'étiquettes indiquées dans l'exemple précédent. Pour en savoir plus, consultez les ressources suivantes :

Accorder l'accès

IAM gère l'accès à vos données de journal, de métrique et de trace. Cette section récapitule les rôles que vous pouvez attribuer aux principaux:

  • Accès aux vues de journaux (roles/logging.viewAccessor) sur les vues de journaux listées dans le champ d'action de journaux par défaut de votre projet hôte App Hub ou du projet de gestion de votre dossier compatible avec les applications. Pour en savoir plus sur l'autorisation d'accès à une vue de journal, consultez la section Contrôler l'accès à une vue de journal.

  • Visionneuse de journaux (roles/logging.viewer) sur votre projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications, ainsi que sur tous les autres projets listés dans son champ d'application des journaux par défaut. Ce rôle accorde un accès à la plupart des entrées de journal du bucket de journaux _Default. Pour en savoir plus, consultez la section Rôles de journalisation.

  • Rôle Éditeur de surveillance (roles/monitoring.editor) sur votre projet hôte App Hub ou sur le projet de gestion de votre dossier compatible avec les applications. Pour les comptes principaux qui n'ont pas besoin de créer de règles d'alerte, envisagez d'attribuer le rôle Lecteur Monitoring (roles/monitoring.viewer).

  • Utilisateur Cloud Trace (roles/cloudtrace.user) sur votre projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications, ainsi que sur les projets listés dans son champ d'application de suivi par défaut.

  • Lecteur App Hub (roles/apphub.view) dans votre projet hôte App Hub ou le projet de gestion de votre dossier compatible avec les applications.

Étape suivante