Créer et gérer des portées de journaux

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Ce document explique comment créer et gérer des champs d'application de journal, qui vous permettent de trouver efficacement les entrées de journal que vous souhaitez afficher ou analyser. Si vous souhaitez uniquement afficher et analyser les entrées de journal provenant d'un projet, d'un dossier ou d'une organisation, ce document n'est pas fait pour vous. Toutefois, si vous utilisez des récepteurs de journaux pour acheminer des journaux vers d'autres projets ou vers des buckets de journaux définis par l'utilisateur, ou si vous utilisez des vues de journaux, les informations de ce document peuvent vous aider à trouver efficacement des entrées de journal spécifiques.

Ce document n'explique pas comment afficher vos journaux. Pour en savoir plus sur ce sujet, consultez la section Afficher les journaux à l'aide de l'explorateur de journaux.

À propos des champs d'application des journaux

Les champs d'application des journaux sont des ressources persistantes au niveau du projet qui listent un ensemble de ressources. Il peut s'agir de projets, de dossiers, d'organisations et de vues de journaux. Par exemple, vous pouvez définir un champ d'action de journaux qui liste les projets contenant des ressources utilisées pour la production ou qui liste les vues de journaux qui incluent des entrées de journal pour un type de ressource spécifique.

Lorsque vous créez un projet, un dossier ou une ressource d'organisation Google Cloud, la journalisation crée un champ d'application des journaux nommé _Default. Ce champ d'application inclut le projet, le dossier ou l'organisation créés. Lorsque la ressource recherchée est un projet, un dossier ou une organisation Google Cloud, les résultats incluent les entrées de journal provenant de la ressource, puis stockées dans un bucket de journaux. Lorsqu'un projet est recherché, les résultats incluent également les entrées de journal qui sont acheminées vers le projet par un récepteur dans un autre projet, puis stockées dans un bucket de journaux.

Vous pouvez créer des champs d'application des journaux. Vous pouvez également modifier et supprimer les portées de journal que vous créez. Toutefois, vous ne pouvez pas modifier ni supprimer le champ d'application des journaux nommé _Default.

Vous utilisez un champ d'action des journaux pour contrôler les ressources pour lesquelles la page Explorateur de journaux recherche des données de journal. Lorsque vous ouvrez cette page et sélectionnez un champ d'application de journal, la page recherche les ressources listées dans ce champ d'application, puis actualise l'affichage.

Vous pouvez également utiliser une portée de journal pour contrôler les ressources pour lesquelles un panneau de journaux recherche des données de journal. Un panneau de journaux est un widget de tableau de bord personnalisé qui affiche les données de journal. Chaque panneau de journaux a sa propre configuration, ce qui vous permet de créer un tableau de bord contenant plusieurs panneaux de journaux, chacun affichant des données de journal différentes. Pour en savoir plus, consultez la section Afficher les journaux et les erreurs dans un tableau de bord personnalisé.

Pour les projets, le champ d'application des journaux par défaut détermine l'ensemble de ressources que la page Explorateur de journaux recherche lors de son ouverture. Toutefois, vos rôles IAM (Identity and Access Management) sur les ressources recherchées et le paramètre de période déterminent les entrées de journal extraites du stockage. Lorsque des projets sont créés, le champ d'application des journaux nommé _Default est désigné comme champ d'application des journaux par défaut. Vous pouvez définir le champ d'action des journaux par défaut.

Différences entre les portées de journal et le stockage centralisé des journaux

Le stockage centralisé des journaux et les portées de journaux vous permettent de consulter les données de journaux provenant de différents projets.

Lorsque vous configurez un bucket de journaux centralisé, les entrées de journal reçues par Google Cloudsont acheminées vers un seul emplacement de stockage. Le stockage centralisé permet de rechercher des données de journal à un seul et même endroit, ce qui simplifie vos requêtes lorsque vous recherchez des tendances ou que vous étudiez des problèmes. Du point de vue de la sécurité, vous disposez également d'un seul emplacement de stockage, ce qui peut simplifier les tâches de vos analystes de sécurité.

Lorsqu'une requête est envoyée aux ressources listées dans le champ d'application d'un journal, les résultats de la requête individuelle sont combinés. Un champ d'action de journal facilite l'agrégation des données de journal au moment de la lecture, qui peuvent être stockées à différents endroits. Toutefois, une portée de journal peut également être utilisée pour fournir un accès en lecture à une ou plusieurs vues de journaux sur un bucket de journaux centralisé.

Lorsque la page Explorateur de journaux s'ouvre, elle émet des requêtes aux ressources listées dans le champ d'action des journaux par défaut. Par conséquent, configurez la portée par défaut afin que la page affiche les données que vous souhaitez généralement consulter. 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.

Bonnes pratiques

Étant donné que les portées de journalisation vous permettent de définir et d'enregistrer une configuration pour une utilisation ultérieure, nous vous recommandons de créer des portées de journalisation pour les configurations de recherche complexes.

Par exemple, supposons que vous résolvez un problème et que vous souhaitiez afficher les entrées de journal de toutes les instances de machine virtuelle (VM) appartenant à votre équipe. Pour ce faire, vous pouvez procéder comme suit:

1. Vous déterminez que les entrées de journal que vous souhaitez afficher sont stockées dans plusieurs buckets de journaux et dans plusieurs projets. Pour la plupart des buckets de journaux, une vue de journal existe et inclut les entrées de journal que vous souhaitez analyser. Si aucune vue de journal n'existe, vous pouvez en créer une.

2. Vous décidez de créer une portée de journalisation, car vous prévoyez d'avoir une tâche de dépannage similaire à l'avenir.

3. Vous ouvrez la page Explorateur de journaux dans la console Google Cloud, puis utilisez le menu Affiner la portée pour sélectionner votre nouvelle portée de journal.

4. Vous examinez les entrées de journal et trouvez les informations dont vous avez besoin pour résoudre le problème que vous examiniez.

5. Une fois le problème résolu, vous partagez la cause de l'échec avec vos collègues. Vous indiquez également que vous vous attendez à voir des échecs similaires à l'avenir. Vous avez donc créé une portée de journal qui vous permettra, ou à toute personne qui enquêtera sur l'échec, de trouver rapidement les entrées de journal pertinentes.

Applications App Hub et portées des journaux

Vos applications App Hub peuvent écrire des données de journal dans plusieurs projets. Vos données de journal peuvent être stockées dans le projet d'où elles proviennent, ou un administrateur de l'organisation peut avoir configuré un stockage centralisé. Pour afficher les données de journal de votre application, créez une portée de journal pour votre projet hôte App Hub et configurez-la pour lister les projets ou les vues de journal qui stockent les données de journal de votre application. Nous vous recommandons de définir votre champ d'application de journal personnalisé comme champ d'application de journal par défaut. Une fois ces étapes effectuées, la page Explorer des journaux affiche automatiquement les données écrites par votre application, même si elles sont stockées dans différents projets ou dans un bucket de journaux centralisé.

Limites

• Vous ne pouvez pas supprimer ni modifier le champ d'application de journal nommé _Default.
• Seuls les projets Google Cloud acceptent un champ d'application de journal par défaut.
• Vous ne pouvez pas ajouter de dossiers ni d'organisations à une portée de journal définie par l'utilisateur.
• Les portées de journalisation sont créées dans l'emplacement global.

Avant de commencer

• Pour obtenir les autorisations nécessaires pour créer et afficher des portées de journal, et pour définir la portée de journal par défaut, demandez à votre administrateur de vous accorder les rôles IAM suivants:

  • Pour créer et afficher des champs d'action de journaux, ou pour obtenir le champ d'action des journaux par défaut : Rédacteur de configuration des journaux (roles/logging.configWriter) sur votre projet, votre dossier ou votre organisation
  • Pour définir ou obtenir le champ d'application des journaux par défaut : Éditeur d'observabilité (roles/observability.editor) sur votre projet, votre dossier ou 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.

  Ces rôles prédéfinis contiennent les autorisations requises pour créer et afficher des portées de journalisation, et pour définir la portée de journalisation par défaut. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

  Autorisations requises

  Vous devez disposer des autorisations suivantes pour créer et afficher des portées de journalisation, et pour définir la portée de journalisation par défaut:

  • Pour définir la portée des journaux par défaut : observability.scopes.{get, update}
  • Pour créer et gérer des portées de journaux : logging.logScopes.{create, delete, get, list, update}

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

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

  Terraform

  Pour utiliser les exemples Terraform de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez le service Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

  1. Install the Google Cloud CLI.

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

  3. To initialize the gcloud CLI, run the following command:

     gcloud init

  4. If you're using a local shell, then create local authentication credentials for your user account:

     gcloud auth application-default login

     You don't need to do this if you're using Cloud Shell.

     If an authentication error is returned, confirm that you have configured the gcloud CLI to use Workforce Identity Federation.

  Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local dans la documentation sur l'authentification Google Cloud.

  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 champs d'application de journaux

 gcloud logging scopes list --project=PROJECT_ID

 gcloud logging scopes describe LOG_SCOPE --project=PROJECT_ID

Définir le champ d'action des journaux par défaut

Cette section ne s'applique pas aux dossiers ni aux organisations. Pour les dossiers et les organisations, lorsque la page Explorateur de journaux s'ouvre, elle recherche les entrées de journal provenant du dossier ou de l'organisation.

Lorsqu'un projet est créé, un champ d'application des journaux nommé _Default est créé. Ce champ d'application liste une seule ressource, à savoir votre projet, et est désigné comme champ d'application des journaux par défaut. Si vous créez un projet et que vous ne modifiez pas le champ d'action des journaux par défaut, la page Explorateur de journaux recherche toutes les entrées de journal provenant du projet lorsqu'elle s'ouvre.

Vous pouvez créer votre propre champ d'application des journaux et le désigner comme champ d'application des journaux par défaut. Cette fonctionnalité vous permet de configurer les ressources pour lesquelles la page Explorateur de journaux recherche des entrées de journal.

Créer un champ d'application de journal

Vous pouvez créer 100 champs d'application des journaux par projet. Un champ d'application des journaux peut inclure un total de 100 vues de journal et de projets. Toutefois, il ne peut inclure que cinq projets. Vous ne pouvez pas ajouter de dossiers ni d'organisations à une portée de journal.

 gcloud logging scopes create LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

Modifier ou supprimer une portée de journal

 gcloud logging scopes update LOG_SCOPE --project=PROJECT_ID \
   --description=DESCRIPTION \
   --resource-names=RESOURCE_NAMES

 gcloud logging scopes delete LOG_SCOPE --project=PROJECT_ID

Étape suivante

• Afficher les journaux à l'aide de l'explorateur de journaux
• Configurer des vues de journaux sur un bucket de journaux