From 0d916d3d0db502c05d0fc703315de012c2275a4a Mon Sep 17 00:00:00 2001 From: Benjamin Renard Date: Fri, 8 May 2020 16:47:27 +0200 Subject: [PATCH] Update doc about LSlog new features --- doc/conf/LSlog.docbook | 187 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 183 insertions(+), 4 deletions(-) diff --git a/doc/conf/LSlog.docbook b/doc/conf/LSlog.docbook index a30a69e5..74251a01 100644 --- a/doc/conf/LSlog.docbook +++ b/doc/conf/LSlog.docbook @@ -15,16 +15,31 @@ de l'application. array ( 'handler' => [handler 2], 'level' => '[niveau]', - // Autres paramètres propre à cet handler + 'loggers' => array('logger1', [...]), + 'excluded_loggers' => array('logger2', [...]), + 'format' => '[LSformat]', + 'cli_format' => '[LSformat]', + 'datetime_prefix' => [booléen], + 'datetime_format' => '[format date()]', + // Autres paramètres propre à ce handler [...] ), [...] ), + 'loggers' => array ( + 'logger1' => array ( + 'level' => 'DEBUG', + ), + 'logger2' => array ( + 'enabled' => false, + ), + [...] + ); );]]> ... - + Paramètres de configuration @@ -73,6 +88,12 @@ de l'application. [type], 'level' => '[niveau]', + 'loggers' => array('logger1', [...]), + 'excluded_loggers' => array('logger2', [...]), + 'format' => '[LSformat]', + 'cli_format' => '[LSformat]', + 'datetime_prefix' => [booléen], + 'datetime_format' => '[format date()]', // Autres paramètres propre à ce handler [...] )]]> @@ -100,8 +121,128 @@ de l'application. + + loggers + + Liste exhautive des composants dont les messages doivent être traités + par ce handler (paramètre facultatif, par défaut : tous les composants). + + + + + excluded_loggers + + Liste exhautive des composants dont les messages ne doivent pas être + traités par ce handler (paramètre facultatif, par défaut : aucun composant). + + + + + + format + + &LSformat; des messages de cet journalisé par ce handler. Ce format + est composé à partir des informations décritent ci-dessous. Par défaut : + %{requesturi} - %{remoteaddr} - %{ldapservername} - %{authuser} - %{logger} - %{level} - %{message} + + + + + + level + + Le niveau du message. + + + + + message + + Le message. + + + + + logger + + Le composant ayant déchenché cette journalisation. + + + + + clibinpath + + Le nom du script ayant déclenché cette jounalisation (uniquement en cas d'exécution en ligne de commande). + + + + + requesturi + + L'URL de la page courante (uniquement dans un contexte Web). + + + + + remoteaddr + + L'adresse IP du client (uniquement dans un contexte Web). + + + + + ldapservername + + Le nom du serveur LDAP courant. + + + + + authuser + + Le DN de l'utilisateur connecté (uniquement dans un contexte Web). + + + - + + + + + cli_format + + &LSformat; des messages de cet journalisé par ce handler dans le + cas d'une exécution en ligne de commande. Ce format est composé à partir des + même informations que le paramètre format (voir ci-dessus). + Par défaut : %{clibinpath} - %{logger} - %{level} - %{message} + + + + + + datetime_format + + Booléen permettant de définir si le message doit être préfixé de la + date et heure courante. La valeur par défaut dépends de l'handler (en règle + général, toujours actif sauf lorsque le canal de journalisation l'ajoute déjà). + + + + + + datetime_format + + Format de la date et heure lorsque celle-ci est ajoutée en préfixe + du message (voir paramètre datetime_format). Le format + correspond à celui attendu par la function date() de &php; + . Consultez la documentation officielle + pour plus de détails (Par défaut : Y/m/d H:i:s). + + + + + + Il existe plusieurs types d'handlers gérés par l'application : @@ -121,7 +262,7 @@ de l'application. syslog Journalisation via le service syslog. - Il est possible de configurer une priorité systématique pour les + Il est possible de configurer une priorité systématique pour les messages journalisés. À défaut, la priorité sera déterminée automatiquement en fonction du niveau du message. Les valeurs possibles de ce paramètre sont : EMERG, ALERT, CRITICAL, @@ -158,6 +299,44 @@ de l'application. + + loggers + + Tableau permettant de configurer la journalisation composant par composant. + Chaque composant peut avoir son propre logger ce qui permet + alors, par exemple, de configurer le niveau de log spécifiquement pour ce + composant. + + Le nom des composant correspond en général au nom de la classe &php; + correspondante, ou bien encore le nom d'une commande (lors d'une exécution en + ligne de commande). + + Par défaut, le nom du composant ayant déclenché un message + journalisé est affiché juste avant le niveau de log. + + + Paramètres de configuration d'un logger + + + enabled + + Booléen permettant de désactiver complètement les logs du composant + (par défaut: True). + + + + + level + + Niveau de log spécifique pour ce composant (par défaut: le niveau + de log global). + + + + + + +