Ce document explique comment créer et gérer des champs d'application de journaux, que vous pouvez utiliser pour trouver efficacement les entrées de journal que vous souhaitez à consulter 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. Cependant, si vous comptez sur récepteurs de journaux pour les acheminer 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 peut 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 sur ce sujet, consultez Affichez les journaux à l'aide de l'explorateur de journaux.
À propos des champs d'application des journaux
Les champs d'application de journaux sont des ressources persistantes au niveau du projet qui répertorient un ensemble de ressources pour rechercher des entrées de journal. Un champ d'application de journal peut inclure projets, dossiers, organisations et 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 de journal nommé _Default.
Ce champ d'application inclut le projet, le dossier ou l'organisation créés.
Les résultats de la recherche de ces ressources incluent les entrées de journal qui
proviennent de la ressource, puis sont stockés dans un bucket de journaux.
Pour les projets, les résultats de recherche incluent également les entrées de journal 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 de journaux. Vous pouvez également modifier et supprimer
des champs d'application de journaux que vous créez. Toutefois, vous ne pouvez pas modifier ni supprimer le champ d'application des journaux nommé _Default.
Pour les projets, le champ d'application de journal par défaut détermine l'ensemble des ressources
que la page Explorateur de journaux recherche à 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.
Bonnes pratiques
Les champs d'application de journaux vous permettent de définir et d'enregistrer pour une utilisation ultérieure, nous vous recommandons créer des champs d'application de journaux pour des configurations de recherche complexes.
Supposons que vous dépannez un problème et que vous souhaitiez consulter les les entrées de journal de toutes les instances de machines virtuelles (VM) appartenant à votre équipe. Pour ce faire, vous pouvez procéder comme suit :
Vous déterminez que les entrées de journal que vous souhaitez afficher sont stockées dans 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.
Vous décidez de créer une portée de journalisation, car vous prévoyez de devoir effectuer une tâche de dépannage similaire à l'avenir.
Ouvrez la page Explorateur de journaux dans la console Google Cloud. Utilisez ensuite le menu Affiner le champ d'application pour sélectionner d'un champ d'application de journal.
Vous examinez les entrées de journal et trouvez les informations dont vous avez besoin pour résoudre le problème que vous examiniez.
Une fois le problème résolu, partagez la cause de l'échec avec votre collègues. Vous indiquez également que vous vous attendez à voir des défaillances similaires dans le Vous avez donc créé un champ d'application de journal qui vous permet, enquête sur l'échec, trouver rapidement les entrées de journal pertinentes.
Limites
- Vous ne pouvez pas supprimer ni modifier le champ d'application de journal nommé
_Default. - Seuls les projets Google Cloud sont compatibles avec 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.
- La CLI Google Cloud ne permet pas de créer ni de gérer des portées de journaux.
- 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 portées de journal ou pour obtenir la portée de journal par défaut : Rédacteur de configuration des journaux (
roles/logging.configWriter) sur votre projet, votre dossier ou votre organisation -
Pour définir le champ d'application de journal par défaut:
Éditeur de l'observabilité (
roles/observability.editor) sur votre projet, dossier ou 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 les champs d'application de journaux, et pour définir le champ d'application de journal 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 champs d'action des journaux, et pour définir le champ d'action des journaux par défaut :
-
Pour obtenir et définir le champ d'application de journal 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.
Lister les champs d'application de journaux
Console
Pour répertorier les champs d'application de journaux, procédez comme suit:
-
Accédez à la page settings Paramètres dans la console Google Cloud.
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
Sélectionnez l'onglet Champ d'application des journaux.
Le tableau répertorie les champs d'application de journaux. Après avoir sélectionné un projet Google Cloud, une entrée du tableau s'affiche avec la mention icône,
, qui indique que
le champ d'application de journal liste les ressources que l'explorateur de journaux
lors de l'ouverture de cette page.
Terraform
Non compatible
API
L'API Cloud Logging contient des commandes qui listent les portées de journal dans une ressource ou qui indiquent les détails d'une portée de journal spécifique. Pour obtenir la liste complète des commandes, consultez la documentation de référence de l'API.
Pour les projets Google Cloud, utilisez les commandes suivantes :
Dans la commande d'API, définissez le champ locations sur global.
Définir le champ d'action des journaux par défaut
Le champ d'application de journal par défaut liste les ressources recherchées par le Explorateur de journaux lorsque cette page s'ouvre. Si un champ d'application de journal par défaut n'existe pas ou n'est pas accessible, cette page recherche automatiquement les entrées de journal provenant du projet, du dossier ou de l'organisation sélectionnés. Les entrées de journal affichées par la page Explorateur de journaux dépendent des ressources recherchées, du paramètre de période et de vos rôles IAM sur les ressources recherchées.
Lorsque des projets sont créés, le champ d'application des journaux nommé _Default est créé et désigné comme champ d'application des journaux par défaut. Toutefois, vous pouvez créer votre propre champ d'application des journaux et le désigner comme champ d'application des journaux par défaut.
Console
Pour définir le champ d'application de journal par défaut, procédez comme suit:
-
Accédez à la page settings Paramètres dans la console Google Cloud.
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Sélectionnez l'onglet Champs d'application de journal.
Recherchez la portée de journal que vous souhaitez désigner comme portée de journal par défaut, cliquez sur more_vert Plus, puis sélectionnez Définir comme valeur par défaut.
Le champ d'application de journal que vous avez sélectionné s'affiche avec la mention "Par défaut" icône,
Terraform
Non compatible
API
Non compatible
Créer un champ d'application de journal
Vous pouvez créer 100 champs d'application de journaux par projet. Un champ d'application de journal peut inclure un total de 100 les vues de journaux et les projets, Toutefois, il ne peut inclure 50 projets. Vous ne pouvez pas ajouter de dossiers ni d'organisations à un champ d'application de journal.
Console
Pour créer un champ d'application de journal, procédez comme suit:
-
Accédez à la page settings Paramètres dans la console Google Cloud.
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Sélectionnez l'onglet Champs d'application de journal, puis cliquez sur Créer un champ d'application de journal.
Pour ajouter un ou plusieurs projets, cliquez sur Ajouter des projets, puis effectuez les .
Une fois que vous avez ajouté un projet, vos rôles IAM sur ce projet déterminent les entrées de journal que vous pouvez afficher. Par exemple, votre peut vous permettre d'afficher uniquement les entrées de journal sont accessibles par une vue de journal spécifique d'un bucket de journaux. Pour en savoir plus sur les rôles, consultez la section Rôles de journalisation.
Pour ajouter une ou plusieurs vues de journaux, cliquez sur Ajouter des vues de journaux, puis remplissez la boîte de dialogue.
La boîte de dialogue liste toutes les vues de journal contenant des entrées de journal provenant de le projet en cours, ou qui ont été acheminées vers le projet actuel par un dans un autre projet. Par exemple, si vous n'avez configuré aucun récepteur, cette boîte de dialogue liste les vues de journaux de votre projet actuel.
Pour afficher les vues de journaux stockées dans un autre projet Google Cloud, cliquez sur add_circle Importer un projet, puis sélectionnez le projet Google Cloud.
Une fois que vous avez ajouté une vue de journal, vos rôles IAM sur la vue de journal ou le projet qui la stocke déterminer les entrées de journal auxquelles vous pouvez accéder. Pour en savoir plus, consultez Contrôlez l'accès à une vue de journal.
Dans la section Nommer la portée des journaux, saisissez le nom et la description que vous souhaitez afficher dans l'onglet Portées des journaux.
Le nom d'un champ d'application de journal ne peut pas être modifié et doit être unique dans le projet.
Cliquez sur Créer un champ d'application de journal.
Terraform
Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base. Pour en savoir plus, consultez la documentation de référence du fournisseur Terraform.
Pour créer une portée de journal dans un projet, un dossier ou une organisation à l'aide de Terraform, utilisez la ressource Terraform google_logging_log_scope.
Dans la commande, définissez les champs suivants :
parent: nom complet de votre projet, dossier ou organisation. Par exemple, vous pouvez définir ce champ sur"projects/PROJECT_ID", où PROJECT_ID correspond à l'ID de votre projet Google Cloud.- Définissez
locationssur"global". name: défini sur le nom complet de la portée du journal. Pour les projets, le format de ce champ est le suivant :"projects/PROJECT_ID/locations/global/logScopes/LOG_SCOPE"Dans l'expression précédente, LOG_SCOPE est le nom d'un champ d'application de journal, tel que "production".
resource_names: tableau de projets et de vues de journaux, où chaque projet et chaque vue de journal est spécifié à l'aide de son nom complet.description: brève description Par exemple : "Portée des ressources de production".
API
L'API Cloud Logging permet également de créer des champs d'application de journaux dans un dossier ou une organisation. Pour en savoir plus, consultez la documentation de référence sur les API.
Pour les projets Google Cloud, utilisez la commande suivante :
Dans la commande d'API, définissez le champ locations sur global.
Modifier ou supprimer un champ d'application de journal
Console
Pour modifier ou supprimer une portée de journal que vous ou un collègue avez créée, procédez comme suit :
-
Accédez à la page settings Paramètres dans la console Google Cloud.
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Sélectionnez l'onglet Champs d'application de journal.
Recherchez les champs d'application de journal que vous souhaitez modifier ou supprimer. cliquez sur more_vert Plus, puis effectuez l'une des opérations suivantes:
- Pour le modifier, sélectionnez Modifier le champ d'application, puis remplissez la boîte de dialogue.
- Pour supprimer la portée, sélectionnez Delete scope (Supprimer la portée), puis remplissez la boîte de dialogue.
Terraform
Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base. Pour en savoir plus, consultez la documentation de référence du fournisseur Terraform.
Modifier un champ d'application de journal dans un projet, un dossier ou une organisation
à l'aide de Terraform, utilisez la ressource Terraform
google_logging_log_scope
API
L'API Cloud Logging contient des commandes permettant de modifier ou de supprimer d'un champ d'application de journal. Pour obtenir la liste complète des commandes, consultez la documentation de référence sur les API.
Pour les projets Google Cloud, utilisez les commandes suivantes :
Dans la commande d'API, définissez le champ locations sur global.
Étape suivante
- Afficher les journaux à l'aide de l'explorateur de journaux
- Configurer des vues de journaux sur un bucket de journaux