Présentation des périmètres d'observabilité

Ce document explique comment configurer un projet Google Cloud pour surveiller ou afficher les données de télémétrie de plusieurs projets Google Cloud. Si vous souhaitez uniquement surveiller ou afficher les données stockées dans un seul projet Google Cloud, vous n'avez pas besoin d'effectuer de configuration, car les outils de visualisation et d'analyse sont configurés pour utiliser les données stockées dans le projet Google Cloud sélectionné par le sélecteur de projet. Toutefois, si les données de télémétrie que vous souhaitez afficher ou analyser proviennent de plusieurs projets, vous devez effectuer certaines activités de configuration pour obtenir une vue agrégée de ces données.

À propos des périmètres d'observabilité

Les outils d'analyse et de visualisation de Google Cloud Observability s'appuient sur des portées spécifiques au type de données pour déterminer les données à afficher ou à analyser. Un champ d'application définit les ressources pour lesquelles un type de données particulier est recherché. À l'exception des données de métrique, vos rôles IAM (Identity and Access Management) sur les projets et les vues de journaux recherchés déterminent les données affichées.

Vous pouvez configurer les champs d'application suivants:

Portée de l'observabilité

Ce champ d'application 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é, qui liste le champ d'application des journaux par défaut, le champ d'application des métriques et le champ d'application des traces par défaut.

Nous vous recommandons de configurer les composants de la portée d'observabilité dans les scénarios suivants:

  • Vous enregistrez les applications auprès d'App Hub. Il peut s'agir d'applications que vous enregistrez vous-même ou de celles que vous avez déployées à l'aide de l'Application Design Center.
  • Lorsque vous souhaitez obtenir une vue unifiée des données de télémétrie stockées dans différents projets Google Cloud.

Si vous ne configurez pas les composants du champ d'action de l'observabilité pour un projet, la page Explorateur de journaux affiche les données de journal provenant du projet. Les pages Explorateur de métriques et Explorateur de traces ne peuvent afficher que les données stockées dans le projet. De plus, les règles d'alerte ne peuvent surveiller que les données stockées dans le projet.

Champs d'application de journaux

Configurez le champ d'application des journaux par défaut d'un projet afin que les données que vous souhaitez généralement afficher s'affichent lorsque vous ouvrez la page Explorateur de journaux. Un champ d'action des journaux peut lister des projets, des dossiers, des organisations et des vues de journaux. Par exemple, vous pouvez définir la portée des journaux par défaut pour afficher une vue de journal qui, lorsqu'elle est interrogée, renvoie les données de journal d'une application App Hub.

Vous pouvez créer plusieurs champs d'application des journaux. Lorsque vous utilisez la page Explorateur de journaux, vous pouvez sélectionner un champ d'application des journaux différent. La page recherche alors les ressources listées dans le champ d'application sélectionné, puis actualise l'affichage.

Nous vous recommandons de configurer la portée des journaux par défaut dans les scénarios suivants:

  • Vous acheminez les données de journal vers un bucket de journaux centralisé.
  • Vous acheminez les données de journal vers d'autres projets ou vers des buckets de journaux stockés par un autre projet.
  • Vous utilisez des vues de journaux.

Pour en savoir plus, consultez la section Créer et gérer des champs d'action de journaux.

Champ d'application des métriques

Configurez le champ d'application des métriques pour lister tous les projets qui stockent des données de métriques, afin que vos graphiques et vos règles d'alerte puissent afficher ou surveiller une vue agrégée de vos données de métriques.

Chaque projet Google Cloud ne contient qu'un seul champ d'application des métriques, et ce champ n'affiche par défaut que le projet.

Nous vous recommandons de configurer l'étendue des métriques si l'une des conditions suivantes est remplie:

  • Vous souhaitez créer un graphique avec des données stockées dans différents projets.
  • Vous souhaitez créer une règle d'alerte pour surveiller les données stockées dans différents projets.
  • Vous enregistrez les applications auprès d'App Hub. Pour en savoir plus sur ce scénario, consultez la section Champs d'application des métriques pour les projets de gestion.

Pour en savoir plus, consultez la section Présentation des champs d'application des métriques.

Champs d'application des traces

Configurez le champ d'application de trace par défaut pour lister tous les projets qui stockent des données de trace. Ainsi, lorsque vous ouvrez la page Explorateur Trace, vous obtenez une vue agrégée de vos données de trace.

Vous pouvez créer plusieurs champs d'application de la trace. Lorsque vous utilisez la page Explorateur Trace, vous pouvez sélectionner un champ d'application de trace différent. La page recherche alors les projets listés dans le champ d'application sélectionné, puis actualise l'affichage.

Nous vous recommandons de configurer les champs d'action de traçage lorsque vous souhaitez obtenir une vue unifiée des données de traçage stockées dans différents projets.

Pour en savoir plus, consultez la section Créer et gérer des champs d'action de trace.

Avant de commencer

Pour obtenir les autorisations nécessaires pour créer et afficher des champs d'application, demandez à votre administrateur de vous accorder les rôles IAM suivants:

  • Pour créer et afficher des champs d'action de journaux, et pour obtenir le champ d'action des journaux par défaut : Rédacteur de configuration des journaux (roles/logging.configWriter) sur votre projet
  • Pour modifier un champ d'application de métriques : Administrateur Monitoring (roles/monitoring.admin) sur votre projet et sur chaque projet que vous souhaitez ajouter aux champs d'application de métriques
  • Pour créer et afficher des champs d'application de trace, et pour obtenir le champ d'application de trace par défaut : Utilisateur Cloud Trace (roles/cloudtrace.user) sur votre projet
  • Pour obtenir et définir les champs d'application par défaut : Éditeur d'observabilité (roles/observability.editor) 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.

Ces rôles prédéfinis contiennent les autorisations requises pour créer et afficher des champs d'application. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour créer et afficher des champs d'application:

  • Pour configurer des champs d'application des journaux : logging.logScopes.{create, delete, get, list, update}
  • Pour configurer un champ d'application des métriques : monitoring.metricsscopes.{link, get, list}
  • Pour configurer des portées de trace : cloudtrace.traceScopes.{create, delete, get, list, update}
  • Pour obtenir et définir les champs d'application par défaut : observability.scopes.{get, update}

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

Configurer le champ d'application de l'observabilité

Cette section ne s'applique pas aux dossiers ni aux organisations.

Si vous ne configurez pas les composants du champ d'action de l'observabilité d'un projet, la page Explorateur de journaux affiche les données de journal provenant du projet. Les pages Explorateur de métriques et Explorateur de traces ne peuvent afficher que les données stockées dans le projet. De plus, les règles d'alerte ne peuvent surveiller que les données stockées dans votre projet.

Pour les données de journal et de trace, vos rôles IAM (Identity and Access Management) sur le projet que vous consultez, ainsi que les projets et les vues de journaux recherchés, déterminent les données affichées. Votre rôle IAM sur le projet que vous consultez détermine si vous pouvez afficher les données de métriques.

Console

Pour configurer le champ d'application de l'observabilité, vous devez configurer ses composants, à savoir le champ d'application des journaux par défaut, le champ d'application des métriques et le champ d'application des traces par défaut:

  1. Enable the Observability API.

    Enable the API

    Avant d'activer l'API, assurez-vous d'avoir sélectionné le bon 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.

  2. Accédez à la page  Paramètres dans la console Google Cloud.

    Accéder aux paramètres

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

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

  4. Configurez le champ d'action des journaux par défaut:

    1. Sélectionnez l'onglet Champ d'application des journaux.

      Les champs d'application de journal existants sont listés. L'entrée avec l'icône "Par défaut", , correspond au champ d'action des journaux par défaut. Si vous souhaitez créer un niveau d'accès aux journaux, cliquez sur Créer un niveau d'accès aux journaux, puis remplissez la boîte de dialogue. Pour en savoir plus, consultez la section Créer et gérer des champs d'action de journaux.

    2. Recherchez l'entrée que vous souhaitez désigner comme par défaut, cliquez sur  Plus, puis sélectionnez Définir comme valeur par défaut.

  5. Configurez le champ d'application des métriques:

    1. Sélectionnez l'onglet "Champ d'application des métriques".
    2. Dans le volet Projets Google Cloud, cliquez sur Ajouter des projets, puis renseignez la boîte de dialogue. Pour en savoir plus, consultez la section Configurer les champs d'application des métriques.

  6. Configurez le champ d'application de trace par défaut:

    1. Sélectionnez l'onglet Champ d'application de la trace, puis procédez comme suit:

      Les champs d'application de trace existants sont listés. L'entrée avec l'icône "Par défaut", , correspond au champ d'action de la trace par défaut. Si vous souhaitez créer un champ d'application de suivi, cliquez sur Créer un champ d'application de journal, puis remplissez la boîte de dialogue. Pour en savoir plus, consultez la section Créer et gérer des champs d'action de trace.

    2. Recherchez l'entrée que vous souhaitez désigner comme valeur par défaut, cliquez sur  Plus, puis sélectionnez Définir comme valeur par défaut.

REST

Impossible de définir le champ d'application de la trace par défaut.

Pour utiliser l'API Observability afin d'obtenir ou de définir la portée de journalisation par défaut, procédez comme suit:

  1. Assurez-vous que l'API Observabilité est activée:

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

    2. Définissez le projet par défaut pour la Google Cloud CLI:

      gcloud config set 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.

    3. Enable the Observability API: 

      gcloud services enable observability.googleapis.com

  2. Effectuez l'une des opérations suivantes :

    • Pour obtenir le champ d'application des journaux par défaut d'un projet, envoyez une requête au point de terminaison projects.locations.scopes.get. Vous devez spécifier un paramètre de chemin d'accès. La réponse est un objet Scope, qui liste la portée de journalisation par défaut.

    • Pour mettre à jour le champ d'application des journaux par défaut d'un projet, envoyez une requête au point de terminaison projects.locations.scopes.patch. Vous devez spécifier un paramètre de chemin, des paramètres de requête et fournir un objet Scope. Les paramètres de requête identifient les champs modifiés. La réponse est un objet Scope.

      Le paramètre de chemin d'accès des deux points de terminaison se présente sous la forme suivante:

      projects/PROJECT_ID/locations/LOCATION/scopes/OBSERVABILITY_SCOPE_ID

      Les champs de l'expression précédente ont la signification suivante:

      • 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.
      • LOCATION: le champ d'emplacement doit être défini sur global.
      • OBSERVABILITY_SCOPE_ID: nom d'un objet Scope. Ce champ doit être défini sur _Default. L'objet Scope portant le nom _Default stocke des informations sur la portée des journaux par défaut et est créé automatiquement.