Configurer Stackdriver Logging pour PHP

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

Avant de commencer

  1. Connectez-vous à votre compte Google.

    Si vous n'en possédez pas déjà un, vous devez en créer un.

  2. Sélectionnez ou créez un projet Google Cloud Platform.

    Accéder à la page "Gérer les ressources"

  3. Assurez-vous que la facturation est activée pour votre projet Google Cloud Platform.

    Découvrir comment activer la facturation

  4. Activez API Stackdriver Logging.

    Activez API

Installer la bibliothèque Stackdriver Logging pour PHP

La bibliothèque Stackdriver Logging pour PHP fournit une mise en œuvre simple de l'enregistreur PSR-3 pour les frameworks Web PHP.

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

composer require google/cloud-logging

Créer un enregistreur PSR-3

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

$logging = new LoggingClient([
    'projectId' => $projectId
]);
$logger = $logging->psrLogger('app');

Activer l'option de traitement par lots

L'enregistreur PSR-3 envoie les journaux de manière synchrone. Ainsi, à chaque fois que vous émettez un journal, l'enregistreur ajoute de la latence RPC à la requête de l'utilisateur. Cette latence ajoutée sera d'autant plus importante si vous émettez plusieurs journaux dans une seule requête, 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 d'App Engine, vous pouvez configurer la bibliothèque Stackdriver 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.

Configurer la bibliothèque Stackdriver Logging pour PHP

Vous pouvez personnaliser le comportement de la bibliothèque Stackdriver Logging pour PHP. Consultez le document de 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 en savoir plus sur l'installation, consultez la documentation relative à la bibliothèque Stackdriver 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 savoir comment utiliser directement la bibliothèque cliente cloud Stackdriver Logging pour PHP, consultez la page Bibliothèques clientes Stackdriver Logging.

Exécuter sur Google Cloud Platform

Pour utiliser la bibliothèque Stackdriver Logging pour PHP, vous devez détenir le rôle Rédacteur de journaux Cloud IAM sur GCP. La plupart des environnements GCP fournissent par défaut ce rôle.

App Engine

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

La bibliothèque Stackdriver Logging pour PHP peut s'utiliser sans avoir à fournir explicitement des identifiants.

Stackdriver Logging est automatiquement activé dans les applications App Engine. Aucune configuration supplémentaire n'est requise.

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 d'App Engine, vous pouvez configurer la bibliothèque Stackdriver Logging pour PHP afin qu'elle utilise un programme daemon externe pour optimiser le débit de journalisation 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

Sur Google Kubernetes Engine, vous devez 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. Si vous souhaitez créer une instance via la console Google Cloud Platform, vous pouvez le faire depuis 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 GCP.

Exécuter en local et depuis un autre emplacement

Pour utiliser la bibliothèque Stackdriver Logging pour PHP en dehors de Google Cloud Platform, 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 saisir votre ID de projet GCP, ainsi que les identifiants du compte de service appropriés directement dans la bibliothèque Stackdriver Logging pour PHP.

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 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 la visionneuse de journaux de la console GCP.

Accéder à la visionneuse de journaux

Dans la visionneuse de journaux, vous devez spécifier une ou plusieurs ressources, mais la sélection de ces dernières 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 solutions Stackdriver Kubernetes Monitoring et de l'ancien Stackdriver, ainsi que sur l'incidence de ces options sur le type de ressource, consultez la section Migrer vers Stackdriver Kubernetes Monitoring.

  • Si votre application utilise directement l'API Stackdriver 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 la visionneuse de journaux, pour voir toutes les entrées de journal, passez en mode de filtre avancé et utilisez un filtre vide.

    1. Pour passer en mode de filtre avancé, cliquez sur le menu (▾) en haut de la visionneuse 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 pages Afficher les journaux et Filtres de journaux avancés.

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Stackdriver Logging
Besoin d'aide ? Consultez notre page d'assistance.