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.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

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.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

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

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

Remarque :Cette étape est facultative.

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

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

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

Exécuter sur Google Cloud

Pour qu'une application puisse écrire des journaux à l'aide de la bibliothèque Cloud Logging pour PHP, 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 le compte de service par défaut pour lui attribuer ce rôle.

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.

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)

GKE attribue automatiquement au compte de service par défaut le rôle IAM Rédacteur de journaux (roles/logging.logWriter). 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 ce compte 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

Remarque :Pour utiliser la bibliothèque Cloud Logging pour PHP sur une instance de VM Compute Engine, il n'est pas nécessaire d'installer l'agent Cloud Logging.

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 PHP 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 saisir l'ID de projet Google Cloud ainsi que les identifiants du compte de service appropriés directement dans la bibliothèque Cloud Logging pour PHP.

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

1. Attribuez au compte de service IAM 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 page 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 le panneau de navigation de la console Google Cloud, sélectionnez Logging, puis 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 observabilité Google Cloud et les solutions Kubernetes Monitoring de l'observabilité Google Cloud, et sur la manière dont ces options affectent le type de ressource, consultez la page Migrer vers l'observabilité Google Cloud Monitoring pour Kubernetes.

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