Bei der Entwicklung einer modernen Anwendung sollte die Protokollierung ganz oben auf der Priorit\u00e4tenliste stehen.<\/p>\n
Die Protokollierung bietet eine M\u00f6glichkeit, deine Anwendung sowohl in der Entwicklung als auch in der Produktion zu visualisieren und erm\u00f6glicht Transparenz und Sichtbarkeit. Mit einer gut strukturierten Protokollierung k\u00f6nnen moderne Anwendungen leichter gewartet werden, da wir proaktiv Fehlerstellen und Leistungsengp\u00e4sse in unserer Anwendung erkennen k\u00f6nnen.<\/p>\n
Das Laravel-Framework verf\u00fcgt \u00fcber ein robustes Logging-System, das alle H\u00fcrden bei der Konfiguration eines gut strukturierten Logging-Systems von Haus aus meistert. Dieses neue Logging-System, das mit Laravel 6.5 eingef\u00fchrt wurde, ist sehr leistungsf\u00e4hig und wir werden es in diesem Artikel genauer untersuchen.<\/p>\n\n
In diesem Artikel geht es um die Grundlagen des Laravel-Loggings und warum du Laravel-Logging in deinem n\u00e4chsten Projekt einsetzen solltest. Wir werden das strukturierte Logging und das zentralisierte Logging im Detail besprechen. Au\u00dferdem erfahren wir, wie du das Laravel-Logging implementierst, indem du eine Todo-Anwendung erstellst.<\/p>\n
Du hast mehr von diesem Artikel, wenn du bereits \u00fcber die folgenden Kenntnisse verf\u00fcgst:<\/p>\n
Bei Laravel Logging geht es darum, wie Laravel das Logging oder die automatische Problemmeldung mit Hilfe eines viralen PHP-Logging-Systems namens Monolog handhabt. Aufgrund der Laravel-Philosophie, beliebte bestehende Bibliotheken f\u00fcr die Implementierung verschiedener Framework-Funktionen zu nutzen, verwendet Laravel Monolog f\u00fcr alle Logging-Anforderungen.<\/p>\n
Monolog<\/a> ist eine \u00e4u\u00dferst flexible und beliebte PHP-Logging-Bibliothek, die wir so konfigurieren k\u00f6nnen, dass sie deine Logs an Dateien, Sockets, Datenbanken und andere Webservices sendet. Monolog bietet eine vertraute Schnittstelle f\u00fcr das Schreiben von Logs aus Standard-Textdateien bis hin zu fortschrittlichen Log-Management-Diensten von Drittanbietern. Laravel richtet Monolog normalerweise so ein, dass es eine Standardkonfigurationsdatei f\u00fcr das Logging verwendet.<\/p>\n Weitere Informationen \u00fcber Monolog und seine Funktionen findest du in der offiziellen Dokumentation<\/a>, da dies den Rahmen dieses Artikels sprengen w\u00fcrde.<\/p>\n Bevor wir uns mit der Konfiguration und Implementierung des Laravel-Loggings mit Monolog besch\u00e4ftigen, wollen wir mehr \u00fcber die Gr\u00fcnde f\u00fcr die Verwendung des Laravel-Loggings und die verschiedenen Arten erfahren.<\/p>\n Warum ist Logging notwendig?<\/p>\n Im Manifest der Zw\u00f6lf-Faktoren-App<\/a> wird das Logging als eines der wichtigsten Anliegen einer modernen Anwendung behandelt, da Logging ein Schl\u00fcssel zur Leistung und \u00dcberwachung ist.<\/p>\n Logs<\/a> helfen dabei, Fehler, die in der Produktion auftreten, im Detail zu verstehen und herauszufinden, woher sie kommen. Mit den richtigen Log-Strukturen k\u00f6nnen sie au\u00dferdem den jeweiligen Nutzer, die Aktion, die den Fehler verursacht hat, und die m\u00f6gliche L\u00f6sung f\u00fcr eine schnellere Fehlerbehebung und Wartung aufzeigen.<\/p>\n Die strukturierte Protokollierung ist ein Lebensretter in Produktionsanwendungen, denn sie hilft bei der Fehlersuche und der L\u00f6sung von Problemen in der Produktion. Au\u00dferdem kannst du alle deine Log-Meldungen in Echtzeit mit speziellen Logging-Tools f\u00fcr Live-Analysen und Berichte \u00fcberwachen und sammeln.<\/p>\n Aus diesen Gr\u00fcnden solltest du der strukturierten Protokollierung bei deinem n\u00e4chsten modernen Anwendungsprojekt oberste Priorit\u00e4t einr\u00e4umen.<\/p>\n Schauen wir uns einen \u00dcberblick \u00fcber die verschiedenen Logging-Stile an.<\/p>\n Wenn du die Grundlagen des Loggings kennst, wirst du verstehen, wie Laravel das Logging handhabt und wie du deine strukturierten Logging-Praktiken verbessern kannst.<\/p>\n Schauen wir uns zwei wesentliche Konzepte des Loggings an, um besser zu verstehen, wie wir unsere Logging-Verfahren implementieren k\u00f6nnen.<\/p>\n In der Softwareentwicklung bedeutet strukturiertes Logging die Implementierung eines vorgegebenen und konsistenten Nachrichtenformats f\u00fcr Anwendungsprotokolle. Dieses Format erm\u00f6glicht es, die Meldungen als Daten zu behandeln, die viel besser \u00fcberwacht, bearbeitet und visualisiert werden k\u00f6nnen als das normale Textformat.<\/p>\n Du musst in deiner modernen Anwendungsentwicklung einen strukturierten Logging-Ansatz einf\u00fchren, denn Logdateien sind f\u00fcr Entwicklerinnen und Entwickler von entscheidender Bedeutung, wenn in deiner Anwendung in der Produktion etwas schief l\u00e4uft.<\/p>\n Da Laravel Monolog verwendet, k\u00f6nnen Entwickler\/innen schnell eine strukturierte Protokollierung implementieren, indem sie den Logger so konfigurieren, dass er bestimmte Arten von Informationen empf\u00e4ngt, die Protokolldateien in verschiedenen Formaten speichert und die Protokolle zur Visualisierung an verschiedene Log-Management-Dienste von Drittanbietern sendet.<\/p>\n Bei einem zentralisierten Logging-System werden die Logs aus verschiedenen Quellen zur einfachen Konsolidierung und Visualisierung an zentrale Log-Management-L\u00f6sungen (CLM) gesendet. CLM ist jedoch eine spezielle Logger-L\u00f6sung, die Log-Meldungen aus verschiedenen Quellen sammelt und die Daten f\u00fcr eine einfache Verarbeitung und Visualisierung konsolidiert.<\/p>\n Neben der Datenerfassung soll CLM auch die Analyse der Logdaten und die \u00fcbersichtliche Darstellung der Daten nach der Analyse unterst\u00fctzen.<\/p>\n Schauen wir uns den Unterschied zwischen strukturiertem Logging und einfachem (unstrukturiertem) Logging an und warum du strukturiertes Logging in deinem Laravel-Projekt verwenden solltest.<\/p>\n Bei der einfachen Protokollierung werden die Protokolldateien in einem Rohformat mit begrenzten Daten zur Abfrage und Identifizierung einzelner Protokolle gespeichert.<\/p>\n Bei der Verwendung von Basic Logging k\u00f6nnen Entwickler<\/a> keine Analysetools von Drittanbietern zum Lesen, Anzeigen und Analysieren von Logs verwenden, es sei denn, sie entwickeln ein eigenes Tool oder bleiben bei einem begrenzten Tool, das ihr Log-Format unterst\u00fctzt.<\/p>\n Es gibt drei wichtige Gr\u00fcnde, die gegen die Verwendung von Basic Logging sprechen:<\/p>\n Strukturiertes Logging spart Entwicklern Zeit, indem sie Open-Source-Analyse-Tools von Drittanbietern verwenden, die eine Standard-Protokollstruktur zum Lesen, Anzeigen und Analysieren von Protokollen unterst\u00fctzen.<\/p>\n Logs sind hilfreich, wenn sie die richtigen, unten aufgef\u00fchrten Daten enthalten, und das ist das Ziel des strukturierten Loggings. Mit den Daten aus der strukturierten Protokollierung k\u00f6nnen wir Dashboards, Grafiken, Diagramme und andere hilfreiche Visualisierungen erstellen, um den Zustand der Anwendung zu ermitteln.<\/p>\n Dies sind nur einige Beispiele f\u00fcr Informationen, die in strukturierte Logmeldungen aufgenommen werden k\u00f6nnen. Dar\u00fcber hinaus kannst du die Daten vollst\u00e4ndig an deine Bed\u00fcrfnisse anpassen.<\/p>\n Hier sind einige Beispiele f\u00fcr Daten, die du mit der strukturierten Protokollierung sammeln kannst:<\/p>\n Die Logs sollten gen\u00fcgend Daten enthalten, um die L\u00f6sung oder den Grund f\u00fcr das Log-Ereignis leicht zu visualisieren. Beachte auch, dass du nicht alle Arten von Informationen wie Passw\u00f6rter oder sensible Daten in den Protokollen speichern solltest.<\/p>\n Nachdem wir nun einen Einblick in das Laravel-Logging bekommen haben, wollen wir uns nun der Implementierung des Laravel-Loggings widmen, indem wir eine Anwendung mit Logging als B\u00fcrger erster Klasse erstellen.<\/p>\n Jetzt wenden wir an, was wir bisher gelernt haben, indem wir ein neues Laravel-Projekt erstellen und Laravel-Logging implementieren.<\/p>\n Wenn du noch nie mit Laravel gearbeitet hast, kannst du nachlesen, was Laravel ist<\/a>, oder einen Blick auf unsere Liste mit hervorragenden Laravel-Tutorials<\/a> werfen, um den Einstieg zu finden.<\/p>\n Zuerst erstellen wir mit dem unten stehenden Befehl eine neue Laravel-Instanz. Du kannst in der offiziellen Dokumentation<\/a> nachschauen, um mehr zu erfahren.<\/p>\n \u00d6ffne deine Konsole und navigiere zu dem Ort, an dem du deine PHP-Projekte speicherst, bevor du die unten stehenden Befehle ausf\u00fchrst. Vergewissere dich, dass der Composer<\/a> installiert und richtig konfiguriert ist.<\/p>\n Als N\u00e4chstes richten wir unsere Datenbank ein, erstellen ein neues \u00d6ffne deinen Datenbank-Client und erstelle eine neue Datenbank. Wir tun dasselbe mit dem Namen Als N\u00e4chstes f\u00fchren wir den folgenden Befehl aus, um die Migration und das Modell \u00d6ffne die neu erstellte Migration database\/migrations\/xxx-create-todos-xxx.php<\/strong> und f\u00fcge die folgenden Codes ein:<\/p>\n Du kannst deine Todos mit Faker-Daten seeden, indem du lernst, deine Datenbanken in Laravel mit Faker zu seeden<\/a>.<\/p>\n Mit Laravel Monolog kannst du strukturierte Logs streamen und an verschiedene Kan\u00e4le wie E-Mails, Slack, Dateien, Sockets, Posteing\u00e4nge, Datenbanken und verschiedene Webservices senden. In Laravel kannst du die Protokollierung in einer einzigen Konfigurationsdatei konfigurieren, die sich in config\/logging.php<\/strong> befindet.<\/p>\n Die Konfigurationsdatei enth\u00e4lt vordefinierte Log-Treiber, aus denen du ausw\u00e4hlen kannst. Der Standardtreiber ist Laravel bietet eine Handvoll Methoden<\/a>, um mit Logs zu interagieren, wie wir in der Controller-Datei TodosController.php<\/strong> kurz demonstrieren.<\/p>\n \u00d6ffne die neu erstellte Controller-Datei TodosController.php<\/strong> im Ordner app\/Http\/Controllers<\/strong> und f\u00fcge die folgenden Codes ein:<\/p>\n Innerhalb jeder der Methoden in Log-Fassade in der Methode Angenommen, du bist mit der von Laravel standardm\u00e4\u00dfig verwendeten In diesem Fall kannst du ganz einfach ein benutzerdefiniertes Formatierungsobjekt erstellen, das auf deinen Anwendungsfall zugeschnitten ist, und es in der gesamten Anwendung verwenden.<\/p>\n In der offiziellen Monolog-Dokumentation findest du eine vollst\u00e4ndige Liste der verf\u00fcgbaren Formatierer<\/a> und kannst ganz einfach einen benutzerdefinierten Formatierer erstellen.<\/p>\nWarum Laravel Logging verwenden?<\/h2>\n
Grundlagen des Laravel-Loggings<\/h2>\n
Laravel Strukturierte Protokollierung<\/h3>\n
Zentrales Logging in Laravel<\/h3>\n
Strukturiertes Logging vs. Basic Logging<\/h3>\n
Einfache Protokollierung<\/h4>\n
\n
Strukturiertes Logging<\/h4>\n
\n
Wie man Laravel Logging mit Todo App implementiert<\/h2>\n
Laravel einrichten<\/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>\nKonfigurieren und Seeding der Datenbank<\/h3>\n
Todo<\/code> Modell und legen 200 Fake-Daten zum Testen an.<\/p>\nlaravel_logging_app_db<\/code> und f\u00fcllen dann unsere .env-Datei<\/strong> mit den Datenbank-Anmeldedaten:<\/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> gleichzeitig zu erstellen:<\/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\u00dcberblick \u00fcber Monolog<\/h3>\n
stack<\/code>, der den Kanal single<\/code> verwendet, um in eine laravel.log-Datei<\/strong> im Ordner storage\/logs<\/strong> zu loggen. Wir werden die strukturierte Protokollierung anhand einiger der Laravel-Log-Treiber<\/a> demonstrieren.<\/p>\nSchreiben von Log-Meldungen im 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> haben wir die Log<\/code> Fassade mit einem bestimmten Log-Level hinzugef\u00fcgt, um die Art des Fehlers zu definieren, den wir senden wollen. Im Folgenden findest du ein Beispiel f\u00fcr die Verwendung der<\/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>\nFormatierung von Log-Meldungen<\/h3>\n
LineFormatter<\/code> nicht zufrieden, die sehr gut lesbare und hilfreiche Meldungen liefert.<\/p>\n