CopixLog

CopixLog

CopixLog est une classe qui vous permet de sauvegarder tout ce qui se passe sur votre site. Vous pouvez demander à Copix de loguer les éléments en base de données, dans des fichiers, simplement en session ou à l'écran.

Cette classe est donc très pratique en développement (pour déboguer vos applications) et en production (pour monitorer les erreurs qui surviennent sur votre site).

Configurer les logs

Configurer les logs se réalise via l'interface d'administration, dans la partie Administration des logs".

Une interface vous permet alors de créer vos profils de log.

Lorsque vous ajoutez un profil de log, il vous sera demandé plusieurs informations :

• Nom : Le nom que vous voulez donner à votre profil de log.
• Stratégie : La façon dont vous voulez que vos logs soient sauvegardés. En standard, 5 stratégies sont disponibles
  • Fichier (qui sauvegarde les données dans un fichier)
  • Base de données (dans la table CopixLog)
  • System (qui utilise la fonction PHP error_log)
  • Session (qui place les données en session)
  • Page courante (qui affiche directement les éléments sur la page).
  • Si aucune de ces stratégie vous convient, Copix vous laisse la possibilité de spécifier votre propre stratégie, auquel cas il vous faut spécifier un sélecteur Copix pour votre classe, qui doit implémenter ICopixLogStrategy.
• Les messages interceptés. Si vous ne voulez loguer que certains types de messages (vous pouvez spécifier des types de message lorsque vous envoyez un log).
• A partir de quel niveau vous souhaitez que le message soit logué (Information, avertissements, exceptions, erreurs, ...)
• et enfin si le log est actif ou non.

Utilisation

Ajouter un log

• $message correspond au message que vous voulez logger
• $type est une désignation du type de log afin de l'identifier parmis les autres messages (par exemple les requêtes sont loguées en tant que type "query").
• $niveau est le niveau d'importance du log, il en existe 6 :
  • CopixLog::INFORMATION
  • CopixLog::NOTICE
  • CopixLog::WARNING
  • CopixLog::EXCEPTION
  • CopixLog::ERROR
  • CopixLog::FATAL_ERROR
• arInfos ( facultatif ) permet de logger des informations supplémentaires ( 'file', 'line', 'function', 'class', 'user'). Veuillez noter que même si ces informations ne sont pas présentes, Copix tentera de les déterminer de lui même.

Note : Il existe une fonction raccourcis _log pour CopixLog::log ();

Lire les logs

Bien qu'il existe une interface (dans le module admin) pour vous permettre de parcourir les logs, il vous est possible d'utiliser du code pour se faire avec la méthode getLog.

• $profil définit quel est le profil à récupérer.
• $niveau ( facultatif ), définit quel est le niveau à récupérer.

Vider un profil de log

Pour supprimer le contenu d'un profil de log, il vous suffit d'utiliser la méthode deleteProfil en spécifiant le nom du profil à supprimer.