Al desarrollar una aplicaci\u00f3n moderna, el registro debe estar en lo m\u00e1s alto de la lista de prioridades.<\/p>\n
El registro proporciona una forma de visualizar tu aplicaci\u00f3n tanto en desarrollo como en producci\u00f3n, permitiendo transparencia y visibilidad. Con un registro bien estructurado, las aplicaciones modernas pueden ser m\u00e1s f\u00e1ciles de mantener, ya que podemos identificar de forma proactiva los puntos de fallo y los cuellos de botella en el rendimiento de nuestra aplicaci\u00f3n.<\/p>\n
El framework Laravel viene con un robusto sistema de registro que maneja todos los obst\u00e1culos que implica la configuraci\u00f3n de un sistema de registro correctamente estructurado desde el principio. Este nuevo sistema de registro introducido en Laravel 6.5 es potente, y lo exploraremos en este art\u00edculo.<\/p>\n\n
Este art\u00edculo explorar\u00e1 los fundamentos del registro de Laravel y por qu\u00e9 deber\u00edas utilizar el registro de Laravel en tu pr\u00f3ximo proyecto. Hablaremos en detalle del registro estructurado y del registro centralizado. Adem\u00e1s, aprenderemos a implementar el registro de Laravel construyendo una aplicaci\u00f3n Todo.<\/p>\n
Sacar\u00e1s m\u00e1s provecho de este art\u00edculo si ya tienes:<\/p>\n
El registro de Laravel trata de c\u00f3mo Laravel gestiona el registro, o la notificaci\u00f3n autom\u00e1tica de problemas, utilizando un sistema de registro viral de PHP llamado Monolog. Sin embargo, debido a la filosof\u00eda de Laravel de utilizar librer\u00edas populares existentes para implementar diferentes caracter\u00edsticas del framework, Laravel emplea Monolog para todas sus necesidades de registro.<\/p>\n
Monolog<\/a> es una biblioteca de registro de PHP muy flexible y popular que podemos configurar para enviar sus registros a archivos, sockets, bases de datos y otros servicios web. Monolog proporciona una interfaz familiar para escribir registros desde archivos de texto est\u00e1ndar hasta servicios avanzados de gesti\u00f3n de registros de terceros. Laravel suele configurar Monolog para que utilice un archivo de configuraci\u00f3n de registro est\u00e1ndar.<\/p>\n Para obtener m\u00e1s informaci\u00f3n sobre Monolog y sus caracter\u00edsticas, consulta la documentaci\u00f3n oficial<\/a>, ya que est\u00e1 fuera del alcance de este art\u00edculo.<\/p>\n Antes de sumergirnos en la configuraci\u00f3n e implementaci\u00f3n del registro de Laravel mediante Monolog, vamos a explorar m\u00e1s razones para utilizar el registro de Laravel y los diferentes tipos.<\/p>\n \u00bfPor qu\u00e9 es necesario el registro?<\/p>\n El manifiesto de las Apps de 12 Factores<\/a> trata el registro como una de las preocupaciones cr\u00edticas de una aplicaci\u00f3n moderna, ya que el registro es clave para el rendimiento y la monitorizaci\u00f3n.<\/p>\n Los registros<\/a> ayudan a comprender en detalle los errores que se producen en producci\u00f3n y d\u00f3nde se originan. Adem\u00e1s, con las estructuras de registro adecuadas, se puede mostrar el usuario concreto, la acci\u00f3n que caus\u00f3 el error y la posible soluci\u00f3n para una correcci\u00f3n y mantenimiento m\u00e1s r\u00e1pidos de los errores.<\/p>\n El registro estructurado es un salvavidas en las aplicaciones de producci\u00f3n, ya que ayuda a localizar los defectos y a resolver los problemas en producci\u00f3n. Adem\u00e1s, puedes supervisar y recopilar todos tus mensajes de registro en tiempo real utilizando herramientas de registro especializadas para realizar an\u00e1lisis e informes en directo.<\/p>\n Por estas razones, debes hacer del registro estructurado una prioridad en tu pr\u00f3ximo proyecto de aplicaci\u00f3n moderna.<\/p>\n Veamos un resumen de los diferentes estilos de registro disponibles.<\/p>\n Aprender los fundamentos del registro te ayudar\u00e1 a entender c\u00f3mo maneja Laravel el registro y c\u00f3mo puedes mejorar tus pr\u00e1cticas de registro estructurado.<\/p>\n Examinemos dos conceptos esenciales del registro para entender mejor c\u00f3mo implementar nuestros procedimientos de registro.<\/p>\n En el desarrollo de software, el registro estructurado consiste en implementar un formato de mensaje predeterminado y coherente para los registros de la aplicaci\u00f3n. Este formato permite tratar los mensajes como datos que pueden ser monitorizados, manipulados y visualizados mucho mejor que el formato de texto normal.<\/p>\n Debes implementar un enfoque de registro estructurado en el desarrollo de tu aplicaci\u00f3n moderna, porque los archivos de registro son los activos esenciales para los desarrolladores cuando algo malo le ocurre a tu aplicaci\u00f3n en producci\u00f3n.<\/p>\n Como Laravel utiliza Monolog, los desarrolladores pueden implementar r\u00e1pidamente el registro estructurado configurando el registrador para recibir tipos espec\u00edficos de informaci\u00f3n, almacenando los archivos de registro en diferentes formatos y enviando los registros a varios servicios de gesti\u00f3n de registros de terceros para su visualizaci\u00f3n.<\/p>\n Un sistema de registro centralizado es aquel en el que los registros se env\u00edan a soluciones de gesti\u00f3n centralizada de registros (CLM) desde m\u00faltiples fuentes para facilitar su consolidaci\u00f3n y visualizaci\u00f3n. Sin embargo, CLM es una soluci\u00f3n de registro especializada que recoge los mensajes de registro de diferentes fuentes y consolida los datos para facilitar su procesamiento y visualizaci\u00f3n.<\/p>\n Adem\u00e1s de la recopilaci\u00f3n de datos, se espera que el CLM tambi\u00e9n apoye el an\u00e1lisis de los datos de registro y la presentaci\u00f3n clara de los datos despu\u00e9s del an\u00e1lisis.<\/p>\n Examinemos la diferencia entre el registro estructurado y el registro b\u00e1sico (no estructurado) y por qu\u00e9 deber\u00edas utilizar el registro estructurado en tu proyecto Laravel.<\/p>\n En el registro b\u00e1sico, los archivos de registro se almacenan en un formato crudo con datos limitados para consultar e identificar registros individuales.<\/p>\n Al utilizar el registro b\u00e1sico, los desarrolladores<\/a> no podr\u00e1n utilizar herramientas anal\u00edticas de terceros para leer, ver y analizar los registros, a menos que desarrollen una herramienta personalizada o se queden con una herramienta limitada que soporte su formato de registro.<\/p>\n Hay tres grandes razones para evitar el uso del registro b\u00e1sico:<\/p>\n El registro estructurado ahorra tiempo a los desarrolladores al utilizar herramientas anal\u00edticas de registro de terceros de c\u00f3digo abierto que admiten la estructura de registro est\u00e1ndar para leer, ver y analizar los registros.<\/p>\n Los registros son \u00fatiles si contienen los datos correctos que se indican a continuaci\u00f3n, que es lo que pretende el registro estructurado. Podemos utilizar los datos incluidos en el registro estructurado para crear cuadros de mando, gr\u00e1ficos, diagramas y cualquier otra visualizaci\u00f3n \u00fatil para determinar la salud de la aplicaci\u00f3n.<\/p>\n Estos son ejemplos b\u00e1sicos de la informaci\u00f3n que podemos incluir en los mensajes de registro estructurado. Adem\u00e1s, puedes personalizar completamente los datos para adaptarlos a tus necesidades.<\/p>\n Estos son algunos ejemplos de los datos que puedes recoger con el registro estructurado:<\/p>\n Los registros deben contener suficientes datos para visualizar f\u00e1cilmente la soluci\u00f3n o el motivo del evento de registro. Adem\u00e1s, ten en cuenta que no debes almacenar en los registros todo tipo de informaci\u00f3n, como contrase\u00f1as o datos sensibles.<\/p>\n Ahora que hemos vislumbrado en qu\u00e9 consiste el registro de Laravel, pasemos a implementar el registro de Laravel construyendo una aplicaci\u00f3n con el registro como ciudadano de primera clase.<\/p>\n Ahora vamos a aplicar lo que hemos aprendido hasta ahora creando un nuevo proyecto Laravel e implementando el registro Laravel.<\/p>\n Si no has usado Laravel antes, puedes leer \u00bfqu\u00e9 es Laravel<\/a>? o echar un vistazo a nuestra lista de excelentes tutoriales de Laravel<\/a> para empezar.<\/p>\n En primer lugar, vamos a crear una nueva instancia de Laravel utilizando el siguiente comando. Puedes consultar la documentaci\u00f3n oficial<\/a> para saber m\u00e1s.<\/p>\n Abre tu consola y navega hasta el lugar donde guardas tus proyectos PHP antes de ejecutar los comandos siguientes. Aseg\u00farate de tener instalado y configurado correctamente Composer<\/a>.<\/p>\n A continuaci\u00f3n, configuraremos nuestra base de datos, crearemos un nuevo modelo Abre tu cliente de base de datos y crea una nueva base de datos. Haremos lo mismo con el nombre A continuaci\u00f3n, ejecutaremos el siguiente comando para crear la migraci\u00f3n y el modelo Abre la migraci\u00f3n reci\u00e9n creada encontrada database\/migrations\/xxx-create-todos-xxx.php<\/strong> y pega los siguientes c\u00f3digos:<\/p>\n Puedes sembrar tus todos con datos de Faker aprendiendo a sembrar tus bases de datos<\/a> en Laravel utilizando Faker.<\/p>\n Con Laravel Monolog, puedes transmitir y enviar registros estructurados a diferentes canales como correos electr\u00f3nicos, Slack, archivos, sockets, bandejas de entrada, bases de datos y varios servicios web. En Laravel, puedes configurar el registro desde un \u00fanico archivo de configuraci\u00f3n situado en config\/logging.php<\/strong>.<\/p>\n El archivo de configuraci\u00f3n viene con controladores de registro predefinidos para elegir, y el controlador por defecto es un Laravel proporciona un pu\u00f1ado de m\u00e9todos<\/a> para interactuar con los logs, como se demuestra en general en el archivo controlador TodosController.<\/strong> php en breve.<\/p>\n Abre el archivo controlador TodosController.php<\/strong> reci\u00e9n creado que se encuentra en la carpeta app\/Http\/Controllers<\/strong> y pega los siguientes c\u00f3digos:<\/p>\n Dentro de cada uno de los m\u00e9todos del Fachada de registro en el m\u00e9todo Sup\u00f3n que no te sientes c\u00f3modo con el En ese caso, puedes crear f\u00e1cilmente un objeto formateador personalizado que se adapte a tu caso de uso y utilizarlo en toda la aplicaci\u00f3n.<\/p>\n La documentaci\u00f3n oficial de Monolog ofrece una lista completa de los formateadores disponibles<\/a> y puedes crear f\u00e1cilmente uno personalizado.<\/p>\n\u00bfPor Qu\u00e9 Utilizar el Registro de Laravel?<\/h2>\n
Fundamentos del Registro en Laravel<\/h2>\n
Registro Estructurado de Laravel<\/h3>\n
Registro Centralizado de Laravel<\/h3>\n
Registro Estructurado Frente a Registro B\u00e1sico<\/h3>\n
Registro B\u00e1sico<\/h4>\n
\n
Registro Estructurado<\/h4>\n
\n
\u00bfC\u00f3mo Implementar el Registro de Laravel con Todo App?<\/h2>\n
Configurar 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>\nConfigurar y Sembrar la Base de Datos<\/h3>\n
Todo<\/code> y sembraremos 200 datos falsos para las pruebas.<\/p>\nlaravel_logging_app_db<\/code> y luego rellenaremos nuestro archivo .env<\/strong> con las credenciales de la base de datos:<\/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> simult\u00e1neamente:<\/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>\nVisi\u00f3n General de Monolog<\/h3>\n
stack<\/code> que utiliza el canal single<\/code> para registrar en un archivo laravel.log<\/strong> que se encuentra en la carpeta storage\/logs<\/strong>. Vamos a demostrar el registro estructurado utilizando un par de controladores de registro de Laravel<\/a>.<\/p>\nEscribir Mensajes de Registro en el Controlador<\/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>, a\u00f1adimos la fachada Log<\/code> con un nivel de registro espec\u00edfico para definir el tipo de error que queremos enviar. A continuaci\u00f3n se muestra un ejemplo de uso del<\/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>\nFormatear los Mensajes de Registro<\/h3>\n
LineFormatter<\/code> por defecto utilizado por Laravel, que hace un gran trabajo para proporcionar mensajes legibles y \u00fatiles.<\/p>\n