Configuration de Cloud Logging pour PHP

Vous pouvez écrire des journaux dans Cloud Logging à partir d'applications PHP en utilisant directement la bibliothèque Cloud Logging pour PHP.

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. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  3. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activez Cloud Logging API.

    Activer l'API

  5. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

    Accéder au sélecteur de projet

  6. Assurez-vous que la facturation est activée pour votre projet Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  7. Activez Cloud Logging API.

    Activer l'API

Installation de la bibliothèque Cloud Logging pour PHP

La bibliothèque Cloud Logging pour PHP fournit une simple implémentation de l'enregistreur PSR-3 pour les frameworks Web PHP.

Pour écrire des journaux à partir de votre application, ajoutez la bibliothèque Cloud Logging pour PHP à votre fichier composer.json :

composer require google/cloud-logging

Créer un enregistreur PSR-3

Utilisez le code suivant pour créer un enregistreur PSR-3 :

use Google\Cloud\Logging\LoggingClient;
$logging = new LoggingClient([
    'projectId' => $projectId
]);
$logger = $logging->psrLogger('app');

Activer l'option de traitement par lots

L'enregistreur PSR-3 écrit dans les journaux en mode synchrone. Chaque écriture dans le journal rajoute de la latence RPC à la requête de l'utilisateur. S'il y en a plusieurs dans la même requête, la latence induite devient non négligeable, phénomène que vous voudrez probablement éviter.

Le code suivant crée un enregistreur PSR-3 qui va regrouper plusieurs journaux en un seul appel RPC :

$logger = LoggingClient::psrBatchLogger('app');

Par défaut, cet enregistreur regroupe les journaux dans un seul processus. Dans l'environnement flexible App Engine, vous pouvez configurer la bibliothèque Cloud Logging pour PHP pour un débit encore plus élevé et une latence plus faible. Pour plus d'informations, consultez la section Configurer le daemon de journalisation.

Configuration de la bibliothèque Cloud Logging pour PHP

Vous pouvez personnaliser le comportement de la bibliothèque Cloud Logging pour PHP. Consultez ce document sur la configuration pour obtenir la liste des options de configuration possibles.

Utiliser l'enregistreur PSR-3

Une fois que l'enregistreur est créé, vous pouvez l'utiliser dans votre application :

$logger->info('Hello World');
$logger->error('Oh no');

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

Utiliser directement la bibliothèque cliente Cloud

Pour plus d'informations sur l'utilisation directe de la bibliothèque cliente Cloud Logging pour PHP, consultez la documentation de référence sur les bibliothèques clientes Cloud Logging.

Exécuter sur Google Cloud

Le rôle Rédacteur de journaux d'IAM sur Google Cloud est nécessaire pour utiliser la bibliothèque Cloud Logging pour PHP. La plupart des environnements Google Cloud fournissent ce rôle par défaut.

App Engine

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

Pour écrire des entrées de journal depuis votre application, nous vous recommandons d'utiliser Bunyan ou Winston, comme décrit sur cette page. Pour en savoir plus, consultez la section Écrire et afficher des journaux depuis App Engine.

Cependant, nous vous recommandons d'utiliser l'enregistreur PSR-3 qui ajoute automatiquement des métadonnées à vos journaux, afin que ceux de votre application soient corrélés aux journaux de la requête.

Configurer le daemon pour l'environnement flexible App Engine

Dans l'environnement flexible App Engine, vous pouvez configurer la bibliothèque Cloud Logging pour PHP afin qu'elle utilise un programme daemon externe pour optimiser le débit des journaux et minimiser la latence de l'application. Pour activer cette fonctionnalité, ajoutez la ligne suivante à la section runtime_config dans app.yaml :

enable_stackdriver_integration: true

Google Kubernetes Engine (GKE)

Par défaut, GKE attribue le rôle Rédacteur de journaux.

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 Google Cloud Console, 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 Cloud Console.

Exécuter en local et ailleurs

Pour utiliser la bibliothèque Cloud Logging en dehors de Google Cloud, y compris l'exécution de la bibliothèque 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 de cloud, vous devez fournir directement à la bibliothèque Cloud Logging pour PHP votre ID de projet Google Cloud ainsi qu'un compte de service approprié.

Vous pouvez créer et obtenir manuellement des identifiants pour le compte de service. Lorsque vous spécifiez le champ Rôle, utilisez le rôle Rédacteur de journaux. Pour en savoir plus sur les rôles Cloud IAM (Cloud Identity and Access Management), consultez le Guide du contrôle des accès.

Afficher les journaux

Après le déploiement, vous pouvez afficher les journaux dans l'explorateur de journaux.

Accéder à l'explorateur de journaux

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 l'ancienne suite d'opérations Google Cloud et sur les solutions Kubernetes Monitoring de la suite d'opérations Google Cloud, ainsi que sur l'incidence de ces options sur le type de ressource, consultez la page Migrer vers les solutions Kubernetes Monitoring de la suite d'opérations Google Cloud.

  • 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 obtenir plus d'informations, consultez les sections Afficher les journaux et Requêtes de journaux avancées.