Quando si sviluppa un’applicazione moderna, la registrazione (o logging) dovrebbe essere in cima alla lista delle priorit\u00e0.<\/p>\n
Il logging fornisce un modo per visualizzare la vostra applicazione sia in fase di sviluppo che di produzione, consentendo trasparenza e visibilit\u00e0. Grazie a una corretta strutturazione dei registri, le applicazioni moderne possono diventare pi\u00f9 facili da mantenere, in quanto possiamo identificare in modo proattivo i punti di guasto e i colli di bottiglia delle prestazioni della nostra applicazione.<\/p>\n
Il framework Laravel \u00e8 dotato di un robusto sistema di registrazione che gestisce tutti gli ostacoli legati alla configurazione di un sistema di logging correttamente strutturato. Il nuovo sistema di registrazione introdotto in Laravel 6.5 \u00e8 molto potente e lo esploreremo in questo articolo.<\/p>\n\n
In questo articolo analizziamo le basi del logging di Laravel e i motivi per cui dovreste usarlo nel vostro prossimo progetto. Parleremo in dettaglio del logging strutturato e del logging centralizzato. Inoltre, impareremo come implementare il logging in Laravel costruendo un’applicazione Todo.<\/p>\n
Potrete trarre maggiori benefici da questo articolo se avete gi\u00e0 acquisito le seguenti nozioni:<\/p>\n
Il logging di Laravel riguarda il modo in cui Laravel gestisce la registrazione, ovvero la segnalazione automatica dei problemi, utilizzando un sistema di registrazione PHP virale chiamato Monolog. Tuttavia, grazie alla filosofia di Laravel di usare le librerie esistenti pi\u00f9 diffuse per implementare le diverse funzionalit\u00e0 del framework, Laravel impiega Monolog per tutte le sue esigenze di logging.<\/p>\n
Monolog<\/a> \u00e8 una libreria di registrazione PHP molto flessibile e popolare che possiamo configurare per inviare i log a file, socket, database e altri servizi web. Monolog fornisce un’interfaccia familiare per scrivere log da file di testo standard a servizi avanzati di gestione dei log di terze parti. Laravel di solito imposta Monolog in modo da utilizzare un file di configurazione di log standard.<\/p>\n Per maggiori informazioni su Monolog e le sue caratteristiche, consultate la documentazione ufficiale<\/a>, poich\u00e9 va oltre lo scopo di questo articolo.<\/p>\n Prima di immergerci nella configurazione e nell’implementazione dei registri di Laravel con Monolog, vediamo i motivi per cui usare i log di Laravel e le sue diverse tipologie.<\/p>\n Perch\u00e9 i registri sono necessari?<\/p>\n Il manifesto della Twelve-Factor App<\/a> considera il logging come uno dei punti critici di un’applicazione moderna, in quanto \u00e8 fondamentale per le prestazioni e il monitoraggio.<\/p>\n I registri<\/a> aiutano a comprendere nel dettaglio gli errori che si verificano in produzione e la loro origine. Inoltre, con una struttura di registrazione adeguata, possono mostrare l’utente specifico, l’azione che ha causato l’errore e la possibile soluzione per una pi\u00f9 rapida correzione dei bug e per la manutenzione.<\/p>\n I registri strutturati sono un salvavita nelle applicazioni di produzione perch\u00e9 aiutano a risolvere i difetti e a risolvere i problemi in produzione. Inoltre, potete monitorare e raccogliere tutti i messaggi di log in tempo reale usando strumenti di log specializzati per l’analisi e la reportistica in tempo reale.<\/p>\n Per questi motivi, dovete fare del logging strutturato una priorit\u00e0 assoluta nel vostro prossimo progetto di applicazione moderna.<\/p>\n Vediamo una panoramica dei diversi stili di log disponibili.<\/p>\n Imparare le basi del logging vi aiuter\u00e0 a capire come Laravel gestisce la registrazione e come potete migliorare le vostre pratiche di logging strutturato.<\/p>\n Esaminiamo due concetti essenziali del logging per capire meglio come implementare le nostre procedure di logging.<\/p>\n Nello sviluppo del software, il logging strutturato consiste nell’implementare un formato di messaggio predeterminato e coerente per i log delle applicazioni. Questo formato permette di trattare i messaggi come dati che possono essere monitorati, manipolati e visualizzati molto meglio del normale formato di testo.<\/p>\n \u00c8 necessario implementare un approccio strutturato ai log nello sviluppo di un’applicazione moderna perch\u00e9 i file di log sono un patrimonio essenziale per gli sviluppatori quando accade qualcosa di sbagliato all’applicazione in produzione.<\/p>\n Dal momento che Laravel usa Monolog, potete implementare rapidamente un logging strutturato configurando il logger per ricevere specifici tipi di informazioni, memorizzando i file di log in diversi formati e inviando i log a vari servizi di gestione dei log di terze parti per la visualizzazione.<\/p>\n Un sistema di logging centralizzato prevede l’invio dei log da pi\u00f9 fonti a soluzioni di Centralized Log Management (CLM) per facilitarne il consolidamento e la visualizzazione. Tuttavia, il CLM \u00e8 una soluzione di logger specializzata che raccoglie i messaggi di log da diverse fonti e consolida i dati per facilitarne l’elaborazione e la visualizzazione.<\/p>\n Oltre alla raccolta dei dati, il CLM deve anche supportare l’analisi dei dati di log e una chiara presentazione dei dati dopo l’analisi.<\/p>\n Esaminiamo la differenza tra il logging strutturato e il logging di base (non strutturato) e perch\u00e9 dovreste usare il logging strutturato nel vostro progetto Laravel.<\/p>\n Nel logging di base, i file di log sono archiviati in un formato grezzo con dati limitati per interrogare e identificare i singoli log.<\/p>\n Quando usano il logging di base, gli sviluppatori<\/a> non potranno servirsi di strumenti analitici di terze parti per leggere, visualizzare e analizzare i log, a meno che non sviluppino uno strumento personalizzato o utilizzino uno strumento limitato che supporti il formato dei log.<\/p>\n Ci sono tre grandi ragioni per evitare di usare il logging di base:<\/p>\n Il logging strutturato fa risparmiare tempo agli sviluppatori grazie all’utilizzo di strumenti di analisi dei log di terze parti open-source che supportano la struttura standard dei log per leggere, visualizzare e analizzare i log.<\/p>\n I log sono utili se contengono i dati corretti elencati di seguito, ed \u00e8 questo l’obiettivo del logging strutturato. Possiamo usare i dati inclusi nel log strutturato per creare dashboard, grafici, diagrammi e qualsiasi altra visualizzazione utile per determinare lo stato di salute dell’applicazione.<\/p>\n Questi sono esempi di base delle informazioni che possiamo includere nei messaggi di log strutturati. Inoltre, potete personalizzare completamente i dati in base alle vostre esigenze.<\/p>\n Ecco alcuni esempi di dati che potete raccogliere con i log strutturati:<\/p>\n I log devono contenere dati sufficienti per visualizzare facilmente la soluzione o il motivo dell’evento di log. Inoltre, tenete presente che non dovreste memorizzare nei log tutti i tipi di informazioni, come le password o i dati sensibili.<\/p>\n Ora che abbiamo dato un’occhiata alle caratteristiche del logging di Laravel, passiamo all’implementazione del logging di Laravel costruendo un’applicazione dove il logging \u00e8 in primo piano.<\/p>\n Ora applicheremo quanto appreso finora creando un nuovo progetto Laravel e implementando il logging Laravel.<\/p>\n Se non avete mai usato Laravel prima d’ora, potete prima leggere cos’\u00e8 Laravel<\/a> o dare un’occhiata al nostro elenco di eccellenti tutorial su Laravel<\/a> per iniziare.<\/p>\n Per prima cosa, creeremo una nuova istanza di Laravel utilizzando il comando seguente. Potete consultare la documentazione ufficiale<\/a> per saperne di pi\u00f9.<\/p>\n Aprite la vostra console e navigate fino al punto in cui memorizzate i vostri progetti PHP prima di eseguire i comandi qui sotto. Assicuratevi che Composer<\/a> sia installato e configurato correttamente.<\/p>\n Ora configureremo il nostro database, creeremo un nuovo modello Aprite il vostro client di database e create un nuovo database. Faremo lo stesso con il nome Ora eseguiamo il seguente comando per creare contemporaneamente la migrazione e il modello Aprite la migrazione appena creata che si trova in database\/migrations\/xxx-create-todos-xxx.php<\/strong> e incollate i seguenti codici:<\/p>\n Potete creare i vostro todos con i dati di Faker imparando a creare i database<\/a> in Laravel con Faker.<\/p>\n Con Laravel Monolog, potete trasmettere e inviare log strutturati a diversi canali come email, Slack, file, socket, caselle di posta, database e vari servizi web. In Laravel, potete configurare i log da un unico file di configurazione situato in config\/logging.php<\/strong>.<\/p>\n Il file di configurazione contiene dei driver di log predefiniti tra cui scegliere; il driver predefinito \u00e8 Dimostreremo il log strutturato usando un paio di driver di log di Laravel<\/a>.<\/p>\n Laravel mette a disposizione una serie di metodi<\/a> per interagire con i log, come dimostrato a breve nel file del controller TodosController.php<\/strong>.<\/p>\n Aprite il file del controller TodosController.php<\/strong> appena creato che si trova nella cartella app\/Http\/Controllers<\/strong> e incollate i seguenti codici:<\/p>\n All’interno di ogni metodo di Supponiamo che vi sentiate a vostro agio con il sito In questo caso, potete creare facilmente un oggetto formattatore personalizzato che si adatti al vostro caso d’uso e usarlo in tutta l’applicazione.<\/p>\n La documentazione ufficiale di Monolog fornisce un elenco completo dei formattatori disponibili<\/a> e potete facilmente crearne uno personalizzato.<\/p>\nPerch\u00e9 Usare i Registri di Laravel?<\/h2>\n
Le Basi del Logging in Laravel<\/h2>\n
Logging Strutturato in Laravel<\/h3>\n
Logging Centralizzato di Laravel<\/h3>\n
Logging Strutturato vs. Logging di Base<\/h3>\n
Logging di Base<\/h4>\n
\n
Logging Strutturato<\/h4>\n
\n
Come Implementare il Logging in Laravel con Todo App<\/h2>\n
Impostazione di 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>\nConfigurazione e Seeding del Database<\/h3>\n
Todo<\/code> e inseriremo 200 dati falsi per i test.<\/p>\nlaravel_logging_app_db<\/code> e poi riempiremo il nostro file .env<\/strong> con le credenziali del database:<\/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>\nPanoramica di Monolog<\/h3>\n
stack<\/code> che utilizza il canale single<\/code> per registrare in un file laravel.log<\/strong> che si trova nella cartella storage\/logs<\/strong>.<\/p>\nScrivere i Messaggi di Log nel Controller<\/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>, abbiamo aggiunto la facciata Log<\/code> con un livello di log specifico per definire il tipo di errore che vogliamo inviare. Di seguito \u00e8 riportato un esempio di utilizzo della facciata Log nel metodo store<\/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>\nFormattazione dei Messaggi di Log<\/h3>\n
LineFormatter<\/code> utilizzato da Laravel, che fa un ottimo lavoro nel fornire messaggi leggibili e utili.<\/p>\n