Lors du d\u00e9veloppement d’une application moderne, la journalisation doit figurer en t\u00eate de liste des priorit\u00e9s.<\/p>\n
La journalisation fournit un moyen de visualiser votre application tant en d\u00e9veloppement qu’en production, ce qui permet la transparence et la visibilit\u00e9. Avec une journalisation correctement structur\u00e9e, les applications modernes peuvent devenir plus faciles \u00e0 maintenir, car nous pouvons identifier de mani\u00e8re proactive les points de d\u00e9faillance et les goulots d’\u00e9tranglement dans notre application.<\/p>\n
Le framework Laravel est livr\u00e9 avec un syst\u00e8me de journalisation robuste qui prend en charge tous les probl\u00e8mes li\u00e9s \u00e0 la configuration d’un syst\u00e8me de journalisation correctement structur\u00e9. Ce nouveau syst\u00e8me de journalisation introduit dans Laravel 6.5 est puissant, et nous allons l’explorer dans cet article.<\/p>\n\n
Cet article explorera les bases de la journalisation Laravel et les raisons pour lesquelles vous devriez utiliser la journalisation Laravel dans votre prochain projet. Nous aborderons en d\u00e9tail la journalisation structur\u00e9e et la journalisation centralis\u00e9e. En outre, nous apprendrons comment mettre en \u0153uvre la journalisation Laravel en construisant une application Todo.<\/p>\n
Vous tirerez davantage profit de cet article si vous avez d\u00e9j\u00e0 acquis les connaissances suivantes :<\/p>\n
La journalisation Laravel concerne la fa\u00e7on dont Laravel g\u00e8re la journalisation, ou le signalement automatique des probl\u00e8mes, en utilisant un syst\u00e8me de journalisation PHP viral appel\u00e9 Monolog. Cependant, en raison de la philosophie de Laravel qui consiste \u00e0 utiliser des biblioth\u00e8ques existantes populaires pour impl\u00e9menter diff\u00e9rentes fonctionnalit\u00e9s du framework, Laravel utilise Monolog pour tous ses besoins de journalisation.<\/p>\n
Monolog<\/a> est une biblioth\u00e8que de journalisation PHP tr\u00e8s flexible et populaire que nous pouvons configurer pour envoyer vos journaux vers des fichiers, des sockets, des bases de donn\u00e9es et d’autres services w eb. Monolog fournit une interface famili\u00e8re pour l’\u00e9criture de journaux \u00e0 partir de fichiers texte standard jusqu’\u00e0 des services tiers avanc\u00e9s de gestion de journaux. Laravel configure g\u00e9n\u00e9ralement Monolog pour utiliser un fichier de configuration de journalisation standard.<\/p>\n Pour plus d’informations sur Monolog et ses fonctionnalit\u00e9s, consultez la documentation officielle<\/a>, car cela d\u00e9passe le cadre de cet article.<\/p>\n Avant de nous plonger dans la configuration et la mise en \u0153uvre de la journalisation Laravel \u00e0 l’aide de Monolog, explorons d’autres raisons d’utiliser la journalisation Laravel et les diff\u00e9rents types.<\/p>\n Pourquoi la journalisation est-elle n\u00e9cessaire ?<\/p>\n Le manifeste Twelve-Factor App<\/a> traite la journalisation comme l’une des pr\u00e9occupations essentielles d’une application moderne, car la journalisation est une cl\u00e9 de la performance et de la surveillance.<\/p>\n Les journaux<\/a> aident \u00e0 comprendre en d\u00e9tail les erreurs qui se produisent en production et leur origine. De plus, avec des structures de journal appropri\u00e9es, ils peuvent montrer l’utilisateur particulier, l’action qui a caus\u00e9 l’erreur, et la solution possible pour une correction et une maintenance plus rapides.<\/p>\n La journalisation structur\u00e9e est une bou\u00e9e de sauvetage dans les applications de production en aidant \u00e0 d\u00e9pister les d\u00e9fauts et \u00e0 r\u00e9soudre les probl\u00e8mes en production. En outre, vous pouvez surveiller et collecter tous vos messages de journalisation en temps r\u00e9el \u00e0 l’aide d’outils de journalisation sp\u00e9cialis\u00e9s pour une analyse et des rapports en direct.<\/p>\n Pour ces raisons, vous devez faire de la journalisation structur\u00e9e une priorit\u00e9 absolue dans votre prochain projet d’application moderne.<\/p>\n Voyons ensemble les diff\u00e9rents styles de journalisation disponibles.<\/p>\n Apprendre les bases de la journalisation vous aidera \u00e0 comprendre comment Laravel g\u00e8re la journalisation et comment vous pouvez am\u00e9liorer vos pratiques de journalisation structur\u00e9e.<\/p>\n Examinons deux concepts essentiels de la journalisation pour mieux comprendre comment mettre en \u0153uvre nos proc\u00e9dures de journalisation.<\/p>\n Dans le d\u00e9veloppement de logiciels, la journalisation structur\u00e9e consiste \u00e0 mettre en \u0153uvre un format de message pr\u00e9d\u00e9termin\u00e9 et coh\u00e9rent pour les journaux d’application. Ce format permet de traiter les messages comme des donn\u00e9es qui peuvent \u00eatre surveill\u00e9es, manipul\u00e9es et visualis\u00e9es bien mieux que le format texte ordinaire.<\/p>\n Vous devez mettre en \u0153uvre une approche de journalisation structur\u00e9e dans le d\u00e9veloppement de vos applications modernes car les fichiers journaux sont les atouts essentiels des d\u00e9veloppeurs lorsque quelque chose d’anormal arrive \u00e0 votre application en production.<\/p>\n Comme Laravel utilise Monolog, les d\u00e9veloppeurs peuvent rapidement mettre en \u0153uvre une journalisation structur\u00e9e en configurant l’outil de journalisation pour qu’il re\u00e7oive des types d’informations sp\u00e9cifiques, en stockant les fichiers journaux dans diff\u00e9rents formats et en envoyant les journaux \u00e0 divers services tiers de gestion des journaux pour les visualiser.<\/p>\n Dans un syst\u00e8me de journalisation centralis\u00e9e, les journaux sont envoy\u00e9s \u00e0 des solutions de gestion centralis\u00e9e des journaux (Centralized Log Management ou CLM) \u00e0 partir de plusieurs sources pour \u00eatre facilement consolid\u00e9s et visualis\u00e9s. Cependant, la CLM est une solution de journalisation sp\u00e9cialis\u00e9e qui collecte les messages de journalisation de diff\u00e9rentes sources et consolide les donn\u00e9es pour un traitement et une visualisation faciles.<\/p>\n Outre la collecte de donn\u00e9es, la CLM est \u00e9galement cens\u00e9e prendre en charge l’analyse des donn\u00e9es de journalisation et la pr\u00e9sentation claire des donn\u00e9es apr\u00e8s analyse.<\/p>\n Examinons la diff\u00e9rence entre la journalisation structur\u00e9e et la journalisation de base (non structur\u00e9e) et pourquoi vous devriez utiliser la journalisation structur\u00e9e dans votre projet Laravel.<\/p>\n Dans la journalisation de base, les fichiers journaux sont stock\u00e9s dans un format brut avec des donn\u00e9es limit\u00e9es pour interroger et identifier les journaux individuels.<\/p>\n Lorsqu’ils utilisent la journalisation de base, les d\u00e9veloppeurs<\/a> ne pourront pas utiliser d’outils d’analyse tiers pour lire, visualiser et analyser les journaux, \u00e0 moins qu’ils ne d\u00e9veloppent un outil personnalis\u00e9 ou qu’ils s’en tiennent \u00e0 un outil limit\u00e9 qui prend en charge leur format de journal.<\/p>\n Il y a trois grandes raisons d’\u00e9viter d’utiliser la journalisation de base :<\/p>\n La journalisation structur\u00e9e permet aux d\u00e9veloppeurs de gagner du temps en utilisant des outils d’analyse de journaux tiers \u00e0 code open source qui prennent en charge la structure standard des journaux pour lire, visualiser et analyser les journaux.<\/p>\n Les journaux sont utiles s’ils contiennent les donn\u00e9es correctes \u00e9num\u00e9r\u00e9es ci-dessous, ce qui est l’objectif de la journalisation structur\u00e9e. Nous pouvons utiliser les donn\u00e9es incluses dans la journalisation structur\u00e9e pour cr\u00e9er des tableaux de bord, des graphiques, des diagrammes et toute autre visualisation utile pour d\u00e9terminer la sant\u00e9 de l’application.<\/p>\n Ce sont des exemples de base des informations que nous pouvons inclure dans les messages de journalisation structur\u00e9e. En outre, vous pouvez enti\u00e8rement personnaliser les donn\u00e9es en fonction de vos besoins.<\/p>\n Voici quelques exemples de donn\u00e9es que vous pouvez collecter avec la journalisation structur\u00e9e :<\/p>\n Les journaux doivent contenir suffisamment de donn\u00e9es pour permettre de visualiser facilement la solution ou la raison de l’\u00e9v\u00e9nement de journal. Notez \u00e9galement que vous ne devez pas stocker tous les types d’informations, comme les mots de passe ou les donn\u00e9es sensibles dans les journaux.<\/p>\n Maintenant que nous avons eu un aper\u00e7u de ce qu’est la journalisation Laravel, passons \u00e0 la mise en \u0153uvre de la journalisation Laravel en construisant une application avec la journalisation comme citoyen de premi\u00e8re classe.<\/p>\n Nous allons maintenant appliquer ce que nous avons appris jusqu’\u00e0 pr\u00e9sent en cr\u00e9ant un nouveau projet Laravel et en impl\u00e9mentant la journalisation Laravel.<\/p>\n Si vous n’avez jamais utilis\u00e9 Laravel auparavant, vous pouvez lire ce qu’est Laravel<\/a> ou jeter un coup d’\u0153il \u00e0 notre liste d’excellents tutoriels Laravel<\/a> pour commencer.<\/p>\n Tout d’abord, nous allons cr\u00e9er une nouvelle instance de Laravel \u00e0 l’aide de la commande ci-dessous. Vous pouvez consulter la documentation officielle<\/a> pour en savoir plus.<\/p>\n Ouvrez votre console et allez jusqu’\u00e0 l’endroit o\u00f9 vous stockez vos projets PHP avant d’ex\u00e9cuter les commandes ci-dessous. Assurez-vous que Composer<\/a> est install\u00e9 et configur\u00e9 correctement.<\/p>\n Ensuite, nous allons configurer notre base de donn\u00e9es, cr\u00e9er un nouveau mod\u00e8le Ouvrez votre client de base de donn\u00e9es et cr\u00e9ez une nouvelle base de donn\u00e9es. Nous ferons de m\u00eame avec le nom Ensuite, nous allons ex\u00e9cuter la commande suivante pour cr\u00e9er simultan\u00e9ment la migration et le mod\u00e8le Ouvrez la migration nouvellement cr\u00e9\u00e9e trouv\u00e9e database\/migrations\/xxx-create-todos-xxx.php<\/strong> et collez les codes suivants :<\/p>\n Vous pouvez ensemencer vos todos avec des donn\u00e9es Faker en apprenant \u00e0 ensemencer vos bases de donn\u00e9es<\/a> dans Laravel \u00e0 l’aide de Faker.<\/p>\n Avec Laravel Monolog, vous pouvez diffuser et envoyer des journaux structur\u00e9s vers diff\u00e9rents canaux tels que des e-mails, Slack, des fichiers, des sockets, des bo\u00eetes de r\u00e9ception, des bases de donn\u00e9es et divers services web. Dans Laravel, vous pouvez configurer la journalisation \u00e0 partir d’un seul fichier de configuration situ\u00e9 dans config\/logging.php<\/strong>.<\/p>\n Le fichier de configuration contient des pilotes de journalisation pr\u00e9d\u00e9finis parmi lesquels vous pouvez choisir, et le pilote par d\u00e9faut est un Laravel fournit quelques m\u00e9thodes<\/a> pour interagir avec les journaux, comme nous allons le d\u00e9montrer de mani\u00e8re g\u00e9n\u00e9rale dans le fichier contr\u00f4leur TodosController.php<\/strong> sous peu.<\/p>\n Ouvrez le fichier contr\u00f4leur TodosController.php<\/strong> nouvellement cr\u00e9\u00e9 qui se trouve dans le dossier app\/Http\/Controllers<\/strong> et collez les codes suivants :<\/p>\n Dans chacune des m\u00e9thodes du site facade Log dans la m\u00e9thode Supposons que vous ne soyez pas \u00e0 l’aise avec le site Dans ce cas, vous pouvez facilement cr\u00e9er un objet formateur personnalis\u00e9 pour r\u00e9pondre \u00e0 votre cas d’utilisation et l’utiliser dans toute l’application.<\/p>\n La documentation officielle de Monolog donne une liste compl\u00e8te des formateurs disponibles<\/a> et permet de cr\u00e9er facilement un formateur personnalis\u00e9.<\/p>\nPourquoi utiliser la journalisation Laravel ?<\/h2>\n
Les bases de la journalisation Laravel<\/h2>\n
Journalisation structur\u00e9e de Laravel<\/h3>\n
Journalisation centralis\u00e9e de Laravel<\/h3>\n
Journalisation structur\u00e9e vs journalisation de base<\/h3>\n
Journalisation de base<\/h4>\n
\n
La journalisation structur\u00e9e<\/h4>\n
\n
Comment mettre en \u0153uvre la journalisation Laravel avec Todo App<\/h2>\n
Configuration de Laravel<\/h3>\n
composer create-project laravel\/laravel laravel-logging-app\ncd laravel-logging-app \/\/ Change directory to current Laravel installation\nphp artisan serve \/\/ Start Laravel development server<\/code><\/pre>\nConfiguration et ensemencement de la base de donn\u00e9es<\/h3>\n
Todo<\/code>, et ensemencer 200 donn\u00e9es factices pour les tests.<\/p>\nlaravel_logging_app_db<\/code>, puis nous remplirons notre fichier .env<\/strong> avec les informations d’identification de la base de donn\u00e9es :<\/p>\nDB_CONNECTION=mysql\nDB_HOST=127.0.0.1\nDB_PORT=3306\nDB_DATABASE=laravel_logging_app_db\nDB_USERNAME=\/\/DB USERNAME HERE\nDB_PASSWORD=\/\/DB PASSWORD HERE<\/code><\/pre>\nTodo<\/code>:<\/p>\nphp artisan make:model Todo -mc<\/code><\/pre>\n<?php\nuse IlluminateSupportFacadesSchema;\nuse IlluminateDatabaseSchemaBlueprint;\nuse IlluminateDatabaseMigrationsMigration;\nclass CreateTodosTable extends Migration\n{\n \/**\n * Run the migrations.\n *\n * @return void\n *\/\n public function up()\n {\n Schema::create('todos', function (Blueprint $table) {\n $table->id();\n $table->string('title');\n $table->text('description')->nullable();\n $table->boolean('is_completed')->default(false);\n $table->timestamps();\n });\n }\n \/**\n * Reverse the migrations.\n *\n * @return void\n *\/\n public function down()\n {\n Schema::dropIfExists('todos');\n }\n}<\/code><\/pre>\nAper\u00e7u de Monolog<\/h3>\n
stack<\/code> qui utilise le canal single<\/code> pour journaliser vers un fichier laravel.log<\/strong> situ\u00e9 dans le dossier storage\/logs<\/strong>. Nous allons faire la d\u00e9monstration de la journalisation structur\u00e9e en utilisant quelques-uns des pilotes de journalisation de Laravel<\/a>.<\/p>\n\u00c9criture de messages de journal dans le contr\u00f4leur<\/h3>\n
\n<?php\nnamespace AppHttpControllers;\nuse AppModelsTodo;\nuse IlluminateHttpRequest;\nuse AppHttpControllersController;\nuse IlluminateSupportFacadesAuth;\nuse IlluminateSupportFacadesLog;\nclass TodosController extends Controller\n{\n public function index(Request $request)\n {\n $todos = Todo::all();\n Log::warning('User is accessing all the Todos', ['user' => Auth::user()->id]);\n return view('dashboard')->with(['todos' => $todos]);\n }\n public function byUserId(Request $request)\n {\n $todos = Todo::where('user_id', Auth::user()->id)->get();\n Log::info('User is accessing all his todos', ['user' => Auth::user()->id]);\n return view('dashboard')->with(['todos' => $todos]);\n }\n public function show(Request $request, $id)\n {\n $todo = Todo::find($id);\n Log::info('User is accessing a single todo', ['user' => Auth::user()->id, 'todo' => $todo->id]);\n return view('show')->with(['todo' => $todo]);\n }\n public function update(Request $request, $id)\n {\n # Validations before updating\n $todo = Todo::where('user_id', Auth::user()->id)->where('id', $id)->first();\n Log::warning('Todo found for updating by user', ['user' => Auth::user()->id, 'todo' => $todo]);\n if ($todo) {\n $todo->title = $request->title;\n $todo->desc = $request->desc;\n $todo->status = $request->status == 'on' ? 1 : 0;\n if ($todo->save()) {\n Log::info('Todo updated by user successfully', ['user' => Auth::user()->id, 'todo' => $todo->id]);\n return view('show', ['todo' => $todo]);\n }\n Log::warning('Todo could not be updated caused by invalid todo data', ['user' => Auth::user()->id, 'todo' => $todo->id, 'data' => $request->except('password')]);\n return; \/\/ 422\n }\n Log::error('Todo not found by user', ['user' => Auth::user()->id, 'todo' => $id]);\n return; \/\/ 401\n }\n public function store(Request $request)\n {\n Log::warning('User is trying to create a single todo', ['user' => Auth::user()->id, 'data' => $request->except('password')]);\n # Validations before updating\n $todo = new Todo;\n $todo->title = $request->title;\n $todo->desc = $request->desc;\n $todo->user_id = Auth::user()->id;\n if ($todo->save()) {\n Log::info('User create a single todo successfully', ['user' => Auth::user()->id, 'todo' => $todo->id]);\n return view('show', ['todo' => $todo]);\n }\n Log::warning('Todo could not be created caused by invalid todo data', ['user' => Auth::user()->id, 'data' => $request->except('password')]);\n return; \/\/ 422\n }\n public function delete(Request $request, $id)\n {\n Log::warning('User is trying to delete a single todo', ['user' => Auth::user()->id, 'todo' => $id]);\n $todo = Todo::where('user_id', Auth::user()->id)->where('id', $id)->first();\n if ($todo) {\n Log::info('User deleted a single todo successfully', ['user' => Auth::user()->id, 'todo' => $id]);\n $todo->delete();\n return view('index');\n }\n Log::error('Todo not found by user for deleting', ['user' => Auth::user()->id, 'todo' => $id]);\n return; \/\/ 404\n }\n}<\/code><\/pre>\nTodoController<\/code>, nous avons ajout\u00e9 la fa\u00e7ade Log<\/code> avec un niveau de journal sp\u00e9cifique pour d\u00e9finir le type d’erreur que nous voulons envoyer. Vous trouverez ci-dessous un exemple d’utilisation de la<\/p>\nstore<\/code>.<\/p>\npublic function store(Request $request)\n{\n Log::warning('User is trying to create a single todo', ['user' => Auth::user()->id, 'data' => $request->except('password')]);\n # Validations before updating\n $todo = new Todo;\n $todo->title = $request->title;\n $todo->desc = $request->desc;\n $todo->user_id = Auth::user()->id;\n if ($todo->save()) {\n Log::info('User create a single todo successfully', ['user' => Auth::user()->id, 'todo' => $todo->id]);\n return view('show', ['todo' => $todo]);\n }\n Log::warning('Todo could not be created caused by invalid todo data', ['user' => Auth::user()->id, 'data' => $request->except('password')]);\n return; \/\/ 422\n}<\/code><\/pre>\nFormatage des messages du journal<\/h3>\n
LineFormatter<\/code> utilis\u00e9 par d\u00e9faut par Laravel, qui fait un excellent travail en fournissant des messages lisibles et utiles.<\/p>\n