N\u00e4r man utvecklar en modern applikation b\u00f6r loggning st\u00e5 h\u00f6gst upp p\u00e5 prioriteringslistan.<\/p>\n
Loggning ger ett s\u00e4tt att visualisera din app i b\u00e5de utveckling och produktion, vilket m\u00f6jligg\u00f6r transparens och synlighet. Med en korrekt strukturerad loggning kan moderna applikationer bli l\u00e4ttare att underh\u00e5lla eftersom vi proaktivt kan identifiera felpunkter och flaskhalsar i appens prestanda.<\/p>\n
Laravel-ramverket levereras med ett robust loggningssystem som hanterar alla hinder som kan uppst\u00e5 n\u00e4r man konfigurerar ett korrekt strukturerat loggningssystem direkt ur l\u00e5dan. Det nya loggningssystemet som introducerades i Laravel 6.5 \u00e4r kraftfullt och vi kommer att utforska detta i den h\u00e4r artikeln.<\/p>\n\n
Den h\u00e4r artikeln kommer att utforska grunderna i Laravel-loggning och varf\u00f6r du b\u00f6r anv\u00e4nda Laravel-loggning i ditt n\u00e4sta projekt. Vi kommer att diskutera strukturerad loggning och centraliserad loggning i detalj. Vi kommer dessutom att l\u00e4ra oss hur man implementerar Laravel-loggning genom att bygga en Todo-applikation.<\/p>\n
Du kommer att f\u00e5 ut mer av den h\u00e4r artikeln om du redan har f\u00f6ljande i bagaget:<\/p>\n
Laravel logging handlar om hur Laravel hanterar loggning, eller automatisk problemrapportering, med hj\u00e4lp av ett viralt PHP-loggningssystem som heter Monolog. P\u00e5 grund av Laravels filosofi att anv\u00e4nda popul\u00e4ra befintliga bibliotek f\u00f6r att implementera olika ramfunktioner anv\u00e4nder Laravel dock Monolog f\u00f6r alla loggningsbehov.<\/p>\n
Monolog<\/a> \u00e4r ett mycket flexibelt och popul\u00e4rt PHP-loggningsbibliotek som vi kan konfigurera f\u00f6r att skicka dina loggar till filer, sockets, databaser och andra webbtj\u00e4nster. Monolog erbjuder ett v\u00e4lbekant gr\u00e4nssnitt f\u00f6r att skriva loggar fr\u00e5n vanliga textfiler till avancerade logghanteringstj\u00e4nster fr\u00e5n tredje part. Laravel st\u00e4ller vanligtvis in Monolog s\u00e5 att det nyttjas en standardkonfigurationsfil f\u00f6r loggning.<\/p>\n F\u00f6r mer information om Monolog och dess funktioner, kolla in den officiella dokumentationen<\/a>, eftersom detta ligger utanf\u00f6r den h\u00e4r artikelns r\u00e4ckvidd.<\/p>\n Innan vi djupdyker i konfigurering och implementering av Laravel-loggning med Monolog, ska vi utforska fler anledningar till att anv\u00e4nda Laravel-loggning och de olika typerna.<\/p>\n Varf\u00f6r \u00e4r loggning n\u00f6dv\u00e4ndig?<\/p>\n Manifestet Twelve-Factor App<\/a> behandlar loggning som en av de kritiska fr\u00e5gorna f\u00f6r en modern applikation, eftersom loggning \u00e4r en nyckel till prestanda och \u00f6vervakning.<\/p>\n Loggningar<\/a> hj\u00e4lper till med en detaljerad f\u00f6rst\u00e5else av fel som intr\u00e4ffar i produktionen och var de har sitt ursprung. Med r\u00e4tt loggstrukturer kan man dessutom visa vilken anv\u00e4ndare som det r\u00f6r sig om, vilken \u00e5tg\u00e4rd som orsakade felet och en m\u00f6jlig l\u00f6sning f\u00f6r snabbare fel-korrigering och underh\u00e5ll.<\/p>\n Strukturerad loggning \u00e4r en livr\u00e4ddare i produktionsapplikationer genom att den hj\u00e4lper till att fels\u00f6ka fel och l\u00f6sa problem i produktionen. Du kan dessutom \u00f6vervaka och samla in alla dina loggmeddelanden i realtid med hj\u00e4lp av specialiserade loggningsverktyg f\u00f6r liveanalys och rapportering.<\/p>\n Av dessa sk\u00e4l m\u00e5ste du g\u00f6ra strukturerad loggning till h\u00f6gsta prioritet i ditt n\u00e4sta moderna applikationsprojekt.<\/p>\n L\u00e5t oss titta p\u00e5 en \u00f6versikt av de olika loggningsstilarna som finns tillg\u00e4ngliga.<\/p>\n Om du l\u00e4r dig grunderna f\u00f6r loggning kommer du att f\u00f6rst\u00e5 hur Laravel hanterar loggning och hur du kan f\u00f6rb\u00e4ttra dina metoder f\u00f6r strukturerad loggning.<\/p>\n L\u00e5t oss unders\u00f6ka tv\u00e5 viktiga begrepp inom loggning f\u00f6r att b\u00e4ttre f\u00f6rst\u00e5 hur vi ska implementera v\u00e5ra loggningsprocedurer.<\/p>\n Inom mjukvaruutveckling inneb\u00e4r strukturerad loggning att man implementerar ett f\u00f6rutbest\u00e4mt och konsekvent meddelandeformat f\u00f6r applikationsloggar. Detta format g\u00f6r att meddelandena kan behandlas som data som kan \u00f6vervakas, manipuleras och visualiseras mycket b\u00e4ttre \u00e4n i det vanliga textformatet.<\/p>\n Du m\u00e5ste implementera en strukturerad loggningsmetod i din moderna applikationsutveckling eftersom loggfiler \u00e4r viktiga tillg\u00e5ngar f\u00f6r utvecklare n\u00e4r det uppst\u00e5r n\u00e5got fel med din applikation i produktion.<\/p>\n Eftersom Laravel anv\u00e4nder Monolog kan utvecklare snabbt implementera strukturerad loggning genom att konfigurera loggaren s\u00e5 att den tar emot specifika typer av information, lagrar loggfilerna i olika format och skickar loggarna till olika logghanteringstj\u00e4nster fr\u00e5n tredje part f\u00f6r visualisering.<\/p>\n Ett centraliserat loggningssystem \u00e4r ett system d\u00e4r loggar skickas till l\u00f6sningar f\u00f6r centraliserad logghantering (CLM) fr\u00e5n flera k\u00e4llor f\u00f6r enkel konsolidering och visualisering. CLM \u00e4r dock en specialiserad loggningsl\u00f6sning som samlar in loggmeddelanden fr\u00e5n olika k\u00e4llor och konsoliderar data f\u00f6r enkel bearbetning och visualisering.<\/p>\n F\u00f6rutom datainsamling f\u00f6rv\u00e4ntas CLM \u00e4ven st\u00f6dja analysen av loggdata och ge en tydlig presentation av data efter analysen.<\/p>\n L\u00e5t oss unders\u00f6ka skillnaden mellan strukturerad loggning och grundl\u00e4ggande (ostrukturerad) loggning och anledningen till att du b\u00f6r anv\u00e4nda strukturerad loggning i ditt Laravel-projekt.<\/p>\n Vid grundl\u00e4ggande loggning lagras loggfilerna i ett r\u00e5tt format med begr\u00e4nsade data f\u00f6r att s\u00f6ka och identifiera enskilda loggar.<\/p>\n N\u00e4r Grundl\u00e4ggande loggning anv\u00e4nds kommer utvecklare<\/a> inte att kunna anv\u00e4nda tredjepartsanalysverktyg f\u00f6r att l\u00e4sa, visa och analysera loggar om de inte utvecklar ett anpassat verktyg eller h\u00e5ller sig till ett begr\u00e4nsat verktyg som st\u00f6der deras loggformat.<\/p>\n Det finns tre viktiga anledningar till att undvika att anv\u00e4nda grundl\u00e4ggande loggning:<\/p>\n Med strukturerad loggning sparar utvecklare tid genom att anv\u00e4nda logganalysverktyg fr\u00e5n tredje part med \u00f6ppen k\u00e4llkod som st\u00f6der standardloggstruktur f\u00f6r att l\u00e4sa, visa och analysera loggar.<\/p>\n Loggar \u00e4r anv\u00e4ndbara om de inneh\u00e5ller de korrekta data som anges nedan, vilket \u00e4r vad strukturerad loggning syftar till att uppn\u00e5. Vi kan anv\u00e4nda de data som ing\u00e5r i strukturerad loggning f\u00f6r att skapa instrumentpaneler, grafer, diagram och andra anv\u00e4ndbara visualiseringar f\u00f6r att fastst\u00e4lla applikationens h\u00e4lsa.<\/p>\n Detta \u00e4r grundl\u00e4ggande exempel p\u00e5 information som vi kan inkludera i strukturerade loggmeddelanden. Du kan dessutom helt och h\u00e5llet anpassa uppgifterna till dina behov.<\/p>\n H\u00e4r \u00e4r n\u00e5gra exempel p\u00e5 data som du kan samla in med strukturerad loggning:<\/p>\n Loggar b\u00f6r inneh\u00e5lla tillr\u00e4ckligt med data f\u00f6r att enkelt visualisera l\u00f6sningen eller orsaken till loggh\u00e4ndelsen. Observera \u00e4ven att du inte b\u00f6r lagra alla typer av information, t.ex. l\u00f6senord eller k\u00e4nsliga uppgifter i loggar.<\/p>\n Nu n\u00e4r vi har f\u00e5tt en glimt av vad Laravel-loggning handlar om, l\u00e5t oss g\u00e5 vidare till att implementera Laravel-loggning genom att bygga en applikation med en f\u00f6rstklassig loggning.<\/p>\n Nu ska vi till\u00e4mpa det som vi har l\u00e4rt oss hittills genom att skapa ett nytt Laravel-projekt och implementera Laravel-loggning.<\/p>\n Om du inte har anv\u00e4nt Laravel tidigare kan du l\u00e4sa igenom vad Laravel \u00e4r<\/a> eller kika p\u00e5 v\u00e5r lista \u00f6ver utm\u00e4rkta Laravel-tutorials<\/a> f\u00f6r att komma ig\u00e5ng.<\/p>\n Vi ska f\u00f6rst skapa en ny Laravel-instans med hj\u00e4lp av kommandot nedan. Du kan titta p\u00e5 den officiella dokumentationen<\/a> f\u00f6r mer information.<\/p>\n \u00d6ppna din konsol och navigera till den plats d\u00e4r du lagrar dina PHP-projekt innan du k\u00f6r kommandona nedan. Se till att Composer<\/a> \u00e4r installerad och konfigurerad p\u00e5 r\u00e4tt s\u00e4tt.<\/p>\n D\u00e4refter ska vi konfigurera v\u00e5r databas, skapa en ny \u00d6ppna din databasklient och skapa en ny databas. Vi g\u00f6r samma sak med namnet D\u00e4refter k\u00f6r vi f\u00f6ljande kommando f\u00f6r att skapa migreringen och \u00d6ppna den nyligen skapade migreringen som finns i database\/migrations\/xxx-create-todos-xxx.php<\/strong> och klistra in f\u00f6ljande koder:<\/p>\n Du kan skapa dina todos med Faker-data genom att l\u00e4ra dig att skapa dina databaser<\/a> i Laravel med hj\u00e4lp av Faker.<\/p>\n Med Laravel Monolog kan du str\u00f6mma och skicka strukturerade loggar till olika kanaler som e-post, Slack, filer, sockets, inboxar, databaser och olika webbtj\u00e4nster. I Laravel kan du konfigurera loggning fr\u00e5n en enda konfigurationsfil som finns i config\/logging.php<\/strong>.<\/p>\n Konfigurationsfilen inneh\u00e5ller f\u00f6rdefinierade loggdrivrutiner att v\u00e4lja mellan, och standarddrivrutinen \u00e4r en Laravel tillhandah\u00e5ller en handfull metoder<\/a> f\u00f6r att interagera med loggar, vilket inom kort demonstreras generellt i kontrollantfilen TodosController.php<\/strong>.<\/p>\n \u00d6ppna den nyligen skapade kontrollantfilen TodosController.php<\/strong> som finns i mappen app\/Http\/Controllers<\/strong> och klistra in f\u00f6ljande koder:<\/p>\n I varje metod i Log-fasaden i metoden Anta att du inte \u00e4r bekv\u00e4m med standardinst\u00e4llningen I det fallet kan du enkelt skapa ett anpassat formateringsobjekt som passar ditt anv\u00e4ndningsomr\u00e5de och anv\u00e4nda det i hela programmet.<\/p>\n I den officiella Monolog-dokumentationen finns en fullst\u00e4ndig lista \u00f6ver tillg\u00e4ngliga formaterare<\/a> och du kan enkelt skapa en anpassad formaterare.<\/p>\nVarf\u00f6r ska man anv\u00e4nda Laravel-loggning?<\/h2>\n
Grunderna f\u00f6r loggning i Laravel<\/h2>\n
Strukturerad loggning i Laravel<\/h3>\n
Laravel centraliserad loggning<\/h3>\n
Strukturerad loggning kontra grundl\u00e4ggande loggning<\/h3>\n
Grundl\u00e4ggande loggning<\/h4>\n
\n
Strukturerad loggning<\/h4>\n
\n
Hur man implementerar Laravel-loggning med Todo App<\/h2>\n
Konfigurera 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 och uts\u00e4ttning av databasen<\/h3>\n
Todo<\/code> -modell och s\u00e5lla 200 falska data f\u00f6r testning.<\/p>\nlaravel_logging_app_db<\/code> och fyller sedan v\u00e5r .env-fil<\/strong> med databasens autentiseringsuppgifter:<\/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>\n\u00d6versikt \u00f6ver Monolog<\/h3>\n
stack<\/code> som anv\u00e4nder kanalen single<\/code> f\u00f6r att logga till en laravel.log-fil<\/strong>\u00a0som finns i mappen storage\/logs<\/strong>. Vi kommer att demonstrera strukturerad loggning genom att anv\u00e4nda ett par av Laravel’s loggdrivrutiner<\/a>.<\/p>\nSkriva loggmeddelanden i styrenheten<\/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> l\u00e4gger vi till Log<\/code> -fasaden med en specifik loggniv\u00e5 f\u00f6r att definiera vilken typ av fel som vi vill skicka. Nedan f\u00f6ljer ett exempel p\u00e5 hur man anv\u00e4nder<\/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 av loggmeddelanden<\/h3>\n
LineFormatter<\/code> som anv\u00e4nds av Laravel, som g\u00f6r ett bra jobb med att ge l\u00e4sbara och anv\u00e4ndbara meddelanden.<\/p>\n