Configurer Cloud Logging pour Python

Vous pouvez écrire des journaux dans Cloud Logging à partir d'applications Python à l'aide du gestionnaire de journalisation Python standard ou en utilisant directement la bibliothèque cliente de l'API Cloud Logging pour Python. Lorsque vous utilisez le gestionnaire de journalisation Python standard, vous devez associer un gestionnaire Cloud Logging au gestionnaire racine Python. Ce document illustre cette approche.

Avant de commencer

  1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  4. Activez Cloud Logging API.

    Activer l'API

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Vérifiez que la facturation est activée pour votre projet Google Cloud.

  7. Activez Cloud Logging API.

    Activer l'API

    8.
  8. Préparez l'environnement au développement de Python.

    Accéder au guide de configuration Python

Installer la bibliothèque

Pour installer la bibliothèque Cloud Logging pour Python, consultez la page Installer la bibliothèque cliente pour Python. Cette bibliothèque vous permet d'associer un gestionnaire Cloud Logging au gestionnaire racine Python standard. Vous pouvez également utiliser cette bibliothèque pour envoyer des requêtes API à Cloud Logging.

Pour plus d'informations sur l'installation, consultez la documentation de la bibliothèque Cloud Logging pour Python. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Écrire des journaux avec le gestionnaire de journalisation Python standard

Pour envoyer à Cloud Logging toutes les entrées de journal écrites avec le gestionnaire racine Python standard, procédez comme suit:

  1. Associez le gestionnaire Cloud Logging à l'enregistreur racine Python en appelant la méthode setup_logging:

    # Imports the Cloud Logging client library
import google.cloud.logging

# Instantiates a client
client = google.cloud.logging.Client()

# Retrieves a Cloud Logging handler based on the environment
# you're running in and integrates the handler with the
# Python logging module. By default this captures all logs
# at INFO level and higher
client.setup_logging()

    Pour en savoir plus sur la configuration du gestionnaire de journalisation, consultez la page Intégration à la bibliothèque Logging standard.

  2. Écrivez des données de journal à l'aide de l'enregistreur racine Python:

    # Imports Python standard library logging
import logging

# The data to log
text = "Hello, world!"

# Emits the data using the standard logging module
logging.warning(text)

    Par défaut, tout journal écrit par votre application dont le niveau de gravité est au moins égal à INFO est envoyé à Cloud Logging.

    Si des messages sont consignés dans Logging depuis App Engine ou Google Kubernetes Engine, le gestionnaire les envoie aux types de ressources respectifs de ces environnements. Sinon, les journaux sont répertoriés sous le journal python du type de ressource Global.

Écrire des journaux avec la bibliothèque cliente Cloud Logging

Pour savoir comment utiliser directement la bibliothèque cliente Cloud Logging pour Python, consultez la page Bibliothèques clientes Cloud Logging.

Exécuter sur Google Cloud

Pour qu'une application écrive des journaux à l'aide de la bibliothèque Cloud Logging pour Python, le compte de service de la ressource sous-jacente doit disposer du rôle IAM Rédacteur de journaux (roles/logging.logWriter). La plupart des environnements Google Cloud configurent automatiquement ce rôle pour le compte de service par défaut.

App Engine

Cloud Logging est automatiquement activé pour App Engine et le compte de service par défaut de votre application dispose des autorisations IAM par défaut permettant d'écrire des entrées de journal.

Pour en savoir plus, consultez la section Écrire et afficher des journaux.

Google Kubernetes Engine (GKE)

GKE attribue automatiquement le rôle IAM Rédacteur de journaux (roles/logging.logWriter) au compte de service par défaut. Si vous utilisez Workload Identity avec ce compte de service par défaut pour permettre aux charges de travail d'accéder à des API Google Cloud spécifiques, aucune configuration supplémentaire n'est requise. Toutefois, si vous utilisez Workload Identity avec un compte de service IAM personnalisé, assurez-vous que le compte de service personnalisé dispose du rôle Rédacteur de journaux (roles/logging.logWriter).

Si nécessaire, vous pouvez également utiliser la commande suivante pour ajouter le niveau d'accès logging.write lors de la création du cluster :

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Lorsque vous utilisez des instances de VM Compute Engine, ajoutez le niveau d'accès cloud-platform à chaque instance. Lorsque vous créez une instance via la console Google Cloud, vous pouvez le faire dans la section Identité et accès à l'API du panneau Créer une instance. Utilisez le compte de service par défaut de Compute Engine ou un autre compte de service de votre choix, puis sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud dans la section Identité et accès à l'API. Quel que soit le compte de service sélectionné, vérifiez qu'il dispose du rôle Rédacteur de journaux dans la section IAM et administration de la console Google Cloud.

Exécuter en local et depuis un autre emplacement

Pour utiliser la bibliothèque Cloud Logging pour Python en dehors de Google Cloud, y compris en l'exécutant sur votre propre poste de travail, sur les ordinateurs de votre centre de données ou sur les instances de VM d'un autre fournisseur cloud, vous devez fournir votre ID de projet Google Cloud ainsi que les identifiants de compte de service appropriés directement dans la bibliothèque Cloud Logging pour Python.

Pour les comptes de service existants, procédez comme suit:

  1. Accordez au compte de service le rôle IAM Rédacteur de journaux (roles/logging.logWriter). Pour en savoir plus sur les rôles IAM, consultez la page Contrôle des accès.

  2. Configurez les identifiants par défaut de l'application.

Si vous n'avez pas de compte de service, créez-en un. Pour en savoir plus sur ce processus, consultez la section Créer des comptes de service.

Pour obtenir des informations générales sur les méthodes que vous pouvez utiliser pour l'authentification, consultez la page Terminologie: comptes de service.

Afficher les journaux

Dans la console Google Cloud, accédez à la page Explorateur de journaux :

Accéder à l'explorateur de journaux

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

Dans l'explorateur de journaux, vous devez spécifier une ou plusieurs ressources, mais leur sélection peut ne pas être évidente. Voici quelques conseils pour vous aider à faire vos premiers pas :

  • Si vous déployez votre application sur App Engine ou utilisez les bibliothèques propres à App Engine, définissez votre ressource sur Application GAE.

  • Si vous déployez votre application sur Compute Engine, définissez la ressource sur Instance de VM GCE.

  • Si vous déployez votre application sur Google Kubernetes Engine, la configuration de la journalisation de votre cluster détermine le type de ressource des entrées de journal. Pour en savoir plus sur les anciennes solutions d'observabilité Google Cloud et les solutions Kubernetes Monitoring pour l'observabilité Google Cloud, ainsi que sur la manière dont ces options affectent le type de ressource, consultez la page Migrer vers Google Cloud Observability Kubernetes Monitoring.

  • Si votre application utilise directement l'API Cloud Logging, la ressource dépend de l'API et de votre configuration. Par exemple, dans votre application, vous pouvez spécifier une ressource ou utiliser une ressource par défaut.

  • Si aucun journal ne s'affiche dans l'explorateur de journaux, passez en mode de requête avancée et utilisez une requête vide pour voir toutes les entrées de journal.

    1. Pour passer en mode de requête avancée, cliquez sur le menu (▾) en haut de l'explorateur de journaux, puis sélectionnez Convertir en filtre avancé.
    2. Effacez le contenu qui apparaît dans le champ de filtre.
    3. Cliquez sur Envoyer le filtre.

    Vous pouvez examiner les entrées individuelles pour identifier vos ressources.

Pour en savoir plus, consultez la page Utiliser l'explorateur de journaux.