N\u00e5r man udvikler en moderne applikation, b\u00f8r logning st\u00e5 \u00f8verst p\u00e5 prioriteringslisten.<\/p>\n
Logning giver mulighed for at visualisere din app i b\u00e5de udvikling og produktion, hvilket muligg\u00f8r gennemsigtighed og synlighed. Med korrekt struktureret logning kan moderne applikationer blive nemmere at vedligeholde, da vi proaktivt kan identificere fejlpunkter og performance-flaskehalse i vores app.<\/p>\n
Laravel-rammen leveres med et robust logningssystem, der h\u00e5ndterer alle de forhindringer, der er involveret i konfigurationen af et korrekt struktureret logningssystem ud af boksen. Dette nye logningssystem, der blev introduceret i Laravel 6.5, er kraftfuldt, og vi vil udforske det i denne artikel.<\/p>\n\n
Denne artikel vil udforske det grundl\u00e6ggende i Laravel-logning og hvorfor du b\u00f8r bruge Laravel-logning i dit n\u00e6ste projekt. Vi vil diskutere struktureret logning og centraliseret logning i detaljer. Derudover vil vi l\u00e6re hvordan man implementerer Laravel logning ved at bygge en Todo-applikation.<\/p>\n
Du vil f\u00e5 mere ud af denne artikel, hvis du allerede har har godt styr p\u00e5 f\u00f8lgende:<\/p>\n
Laravel logging handler om, hvordan Laravel h\u00e5ndterer logning eller automatisk problemrapportering ved hj\u00e6lp af et viralt PHP-logningssystem kaldet Monolog. Men p\u00e5 grund af Laravels filosofi om at bruge popul\u00e6re eksisterende biblioteker til at implementere forskellige framework-funktioner anvender Laravel Monolog til alle logningsbehov.<\/p>\n
Monolog<\/a> er et meget fleksibelt og popul\u00e6rt PHP-logbibliotek, som vi kan konfigurere til at sende dine logs til filer, sockets, databaser og andre webtjenester. Monolog giver en velkendt gr\u00e6nseflade til at skrive logs fra standard tekstfiler til avancerede logh\u00e5ndteringstjenester fra tredjeparter. Laravel konfigurerer typisk Monolog til at bruge en standardkonfigurationsfil til logning.<\/p>\n For flere oplysninger om Monolog og dens funktioner skal du tjekke den officielle dokumentation<\/a>, da det ligger uden for denne artikels r\u00e6kkevidde.<\/p>\n F\u00f8r vi dykker ned i konfigurering og implementering af Laravel-logning ved hj\u00e6lp af Monolog, skal vi unders\u00f8ge flere grunde til at bruge Laravel-logning og de forskellige typer.<\/p>\n Hvorfor er logning n\u00f8dvendig?<\/p>\n Twelve-Factor App<\/a>-manifestet behandler logning som en af de kritiske bekymringer for en moderne applikation, da logning er en n\u00f8gle til ydeevne og overv\u00e5gning.<\/p>\n Logs<\/a> hj\u00e6lper med den detaljerede forst\u00e5else af fejl, der sker i produktionen, og hvor de stammer fra. Desuden kan logstrukturer med de rette logstrukturer vise den p\u00e5g\u00e6ldende bruger, den handling, der for\u00e5rsagede fejlen, og den mulige l\u00f8sning for hurtigere fejlrettelse og vedligeholdelse.<\/p>\n Struktureret logning er en livredder i produktionsapplikationer ved at hj\u00e6lpe med at fejlfinde fejl og l\u00f8se problemer i produktionen. Derudover kan du overv\u00e5ge og indsamle alle dine logmeddelelser i realtid ved hj\u00e6lp af specialiserede logningsv\u00e6rkt\u00f8jer til live-analyse og rapportering.<\/p>\n Af disse grunde skal du g\u00f8re struktureret logning til en topprioritet i dit n\u00e6ste moderne applikationsprojekt.<\/p>\n Lad os se p\u00e5 oversigten over de forskellige logf\u00f8ringsstile, der er tilg\u00e6ngelige.<\/p>\n Hvis du l\u00e6rer det grundl\u00e6ggende om logning, vil du forst\u00e5, hvordan Laravel h\u00e5ndterer logning, og hvordan du kan forbedre din strukturerede logningspraksis.<\/p>\n Lad os unders\u00f8ge to v\u00e6sentlige koncepter inden for logning for bedre at forst\u00e5, hvordan vi skal implementere vores logningsprocedurer.<\/p>\n Inden for softwareudvikling er struktureret logning implementering af et forudbestemt og konsistent beskedformat for programlogfiler. Dette format g\u00f8r det muligt at behandle meddelelserne som data, der kan overv\u00e5ges, manipuleres og visualiseres meget bedre end det almindelige tekstformat.<\/p>\n Du skal implementere en struktureret logningstilgang i din moderne applikationsudvikling, fordi logfiler er v\u00e6sentlige aktiver for udviklerne, n\u00e5r der sker noget forkert med din applikation i produktionen.<\/p>\n Da Laravel bruger Monolog, kan udviklere hurtigt implementere struktureret logning ved at konfigurere loggeren til at modtage bestemte typer oplysninger, gemme logfilerne i forskellige formater og sende logfilerne til forskellige logh\u00e5ndteringstjenester fra tredjeparter med henblik p\u00e5 visualisering.<\/p>\n Et centraliseret logningssystem er et system, hvor logs sendes til CLM-l\u00f8sninger (Centralized Log Management) fra flere kilder med henblik p\u00e5 nem konsolidering og visualisering. CLM er imidlertid en specialiseret log-l\u00f8sning, der indsamler logmeddelelser fra forskellige kilder og konsoliderer dataene for nem behandling og visualisering.<\/p>\n Ud over dataindsamling forventes CLM ogs\u00e5 at underst\u00f8tte analysen af logdata og en klar pr\u00e6sentation af dataene efter analysen.<\/p>\n Lad os unders\u00f8ge forskellen mellem struktureret logning og grundl\u00e6ggende (ustruktureret) logning, og hvorfor du b\u00f8r bruge struktureret logning i dit Laravel-projekt.<\/p>\n I grundl\u00e6ggende logning er logfilerne gemt i et r\u00e5t format med begr\u00e6nsede data til at foresp\u00f8rge og identificere individuelle logfiler.<\/p>\n N\u00e5r du bruger Basic logging, vil udviklere<\/a> ikke kunne bruge tredjepartsanalysev\u00e6rkt\u00f8jer til at l\u00e6se, se og analysere logfiler, medmindre de udvikler et brugerdefineret v\u00e6rkt\u00f8j eller holder sig til et begr\u00e6nset v\u00e6rkt\u00f8j, der underst\u00f8tter deres logformat.<\/p>\n Der er tre store grunde til at undg\u00e5 at bruge Basic logging:<\/p>\n Struktureret logning sparer udviklere tid ved at bruge open source-v\u00e6rkt\u00f8jer til loganalyse fra tredjeparter, der underst\u00f8tter standard logstrukturer, til at l\u00e6se, se og analysere logfiler.<\/p>\n Logfiler er nyttige, hvis de indeholder de korrekte data, der er anf\u00f8rt nedenfor, hvilket er det, som struktureret logning sigter mod at opn\u00e5. Vi kan bruge de data, der er indeholdt i struktureret logning, til at oprette dashboards, grafer, diagrammer og enhver anden nyttig visualisering til at bestemme applikationens tilstand.<\/p>\n Dette er grundl\u00e6ggende eksempler p\u00e5 de oplysninger, som vi kan medtage i strukturerede logmeddelelser. Derudover kan du tilpasse dataene fuldst\u00e6ndigt til dine behov.<\/p>\n Her er nogle eksempler p\u00e5 de data, du kan indsamle med struktureret logning:<\/p>\n Logs skal indeholde nok data til, at det er nemt at visualisere l\u00f8sningen eller \u00e5rsagen til logh\u00e6ndelsen. Bem\u00e6rk ogs\u00e5, at du ikke b\u00f8r gemme alle typer oplysninger, f.eks. passwords eller f\u00f8lsomme data, i logfiler.<\/p>\n Nu hvor vi har f\u00e5et et glimt af, hvad Laravel-logning handler om, skal vi g\u00e5 videre til at implementere Laravel-logning ved at bygge en applikation med logning som en f\u00f8rsteklasses borger.<\/p>\n Nu skal vi anvende det, vi har l\u00e6rt indtil videre, ved at oprette et nyt Laravel-projekt og implementere Laravel-logning.<\/p>\n Hvis du ikke har brugt Laravel f\u00f8r, kan du l\u00e6se hvad Laravel er<\/a>, eller kigge p\u00e5 vores liste over fremragende Laravel-tutorials<\/a> for at komme i gang.<\/p>\n F\u00f8rst skal vi oprette en frisk Laravel-instans ved hj\u00e6lp af nedenst\u00e5ende kommando. Du kan sl\u00e5 op i den officielle dokumentation<\/a> for mere.<\/p>\n \u00c5bn din konsol og naviger til det sted, hvor du gemmer dine PHP-projekter, f\u00f8r du k\u00f8rer nedenst\u00e5ende kommandoer. S\u00f8rg for, at Composer<\/a> er installeret og konfigureret korrekt.<\/p>\n Dern\u00e6st skal vi konfigurere vores database, oprette en ny \u00c5bn din databaseklient, og opret en ny database. Vi g\u00f8r det samme med navnet Derefter k\u00f8rer vi f\u00f8lgende kommando for at oprette migreringen og \u00c5bn den nyligt oprettede migration fundet database\/migrations\/xxx-create-todos-xxx.php<\/strong> og inds\u00e6t f\u00f8lgende koder:<\/p>\n Du kan s\u00e6tte dine todos med Faker-data ved at l\u00e6re at s\u00e6tte dine databaser<\/a> i Laravel ved hj\u00e6lp af Faker.<\/p>\n Med Laravel Monolog kan du streame og sende strukturerede logs til forskellige kanaler som f.eks. e-mails, Slack, filer, sockets, indbakker, databaser og forskellige webtjenester. I Laravel kan du konfigurere logning fra en enkelt konfigurationsfil, der ligger i config\/logging.php<\/strong>.<\/p>\n Konfigurationsfilen leveres med foruddefinerede logdrivere at v\u00e6lge imellem, og standarddriveren er en Laravel tilbyder en h\u00e5ndfuld metoder<\/a> til at interagere med logs, som demonstreret generelt i TodosController.php<\/strong> controllerfilen om kort tid.<\/p>\n \u00c5bn den nyligt oprettede TodosController.php<\/strong> controllerfil fundet app\/Http\/Controllers<\/strong> mappe og inds\u00e6t f\u00f8lgende koder:<\/p>\n Inden for hver af metoderne i Log-facade i metoden Lad os antage, at du ikke er tilfreds med standard I s\u00e5 fald kan du nemt oprette et tilpasset formatterobjekt, der passer til dit brugsscenarie, og bruge det i hele programmet.<\/p>\n Den officielle Monolog-dokumentation giver en komplet liste over tilg\u00e6ngelige formatters<\/a> og kan nemt oprette en tilpasset en.<\/p>\nHvorfor bruge Laravel-logning?<\/h2>\n
Grundl\u00e6ggende om Laravel-logning<\/h2>\n
Laravel struktureret logning<\/h3>\n
Laravel centraliseret logning<\/h3>\n
Struktureret logning vs. grundl\u00e6ggende logning<\/h3>\n
Grundl\u00e6ggende logning<\/h4>\n
\n
Struktureret logning<\/h4>\n
\n
S\u00e5dan implementeres Laravel-logning med Todo App<\/h2>\n
Ops\u00e6tning af 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>\nKonfigurering og seedning af databasen<\/h3>\n
Todo<\/code> -model og seed 200 falske data til test.<\/p>\nlaravel_logging_app_db<\/code> og udfylder derefter vores .env<\/strong>-fil med databasens legitimationsoplysninger:<\/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> -modellen samtidigt:<\/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>\nOversigt over Monolog<\/h3>\n
stack<\/code>, der bruger single<\/code> -kanalen til at logge til en laravel.log<\/strong>-fil, der findes i mappen storage\/logs<\/strong>. Vi vil demonstrere struktureret logning ved at bruge et par af Laravel-logdriverne<\/a>.<\/p>\nSkrivning af logmeddelelser i controlleren<\/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>, tilf\u00f8jede vi Log<\/code> facaden med et specifikt logniveau for at definere den type fejl, vi \u00f8nsker at sende. Nedenfor er et eksempel p\u00e5 brug af<\/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>\nFormatering af logmeddelelser<\/h3>\n
LineFormatter<\/code>, som Laravel bruger, og som g\u00f8r et godt stykke arbejde med at give l\u00e6sbare og nyttige meddelelser.<\/p>\n