Ao desenvolver um aplicativo moderno, o registro deve estar no topo da lista de prioridades.<\/p>\n
O registro fornece uma maneira de visualizar seu aplicativo tanto no desenvolvimento quanto na produ\u00e7\u00e3o, permitindo transpar\u00eancia e visibilidade. Com o registro corretamente estruturado, aplicativos modernos podem se tornar mais f\u00e1ceis de manter, pois podemos identificar proativamente pontos de falha e gargalos de desempenho em nosso aplicativo.<\/p>\n
A Framework Laravel vem com um robusto sistema de registro que lida com todos os obst\u00e1culos envolvidos na configura\u00e7\u00e3o de um sistema de registro devidamente estruturado fora da caixa. Este novo sistema de explora\u00e7\u00e3o do registro introduzido no Laravel 6.5 \u00e9 poderoso e n\u00f3s o exploraremos neste artigo.<\/p>\n\n
Este artigo ir\u00e1 explorar os fundamentos dos registros no Laravel e por que voc\u00ea deve usar o registro de Laravel em seu pr\u00f3ximo projeto. Discutiremos em detalhes o registro estruturado e o registro centralizado. Al\u00e9m disso, aprenderemos como implementar o registro Laravel atrav\u00e9s da constru\u00e7\u00e3o de um aplicativo Todo.<\/p>\n
Voc\u00ea obter\u00e1 mais deste artigo se voc\u00ea j\u00e1 tiver o seguinte sob seu cinto:<\/p>\n
O registro Laravel \u00e9 tudo sobre como Laravel lida com o registro, ou relat\u00f3rio autom\u00e1tico de problemas, usando um sistema de registro PHP viral chamado Monolog. Entretanto, devido \u00e0 filosofia de Laravel de usar bibliotecas populares existentes para implementar diferentes caracter\u00edsticas de framework, Laravel emprega Monolog para todas as suas necessidades de registro.<\/p>\n
Monolog<\/a> \u00e9 uma biblioteca de registros PHP altamente flex\u00edvel e popular que podemos configurar para enviar seus registros para arquivos, soquetes, bancos de dados e outros servi\u00e7os web. Monolog fornece uma interface familiar para escrever registros de arquivos de texto padr\u00e3o para servi\u00e7os avan\u00e7ados de gerenciamento de registros de terceiros. Laravel tipicamente configura Monolog para usar um arquivo de configura\u00e7\u00e3o de registro padr\u00e3o.<\/p>\n Para mais informa\u00e7\u00f5es sobre Monolog e suas funcionalidades, confira a documenta\u00e7\u00e3o oficial<\/a>, pois isso est\u00e1 al\u00e9m do escopo deste artigo.<\/p>\n Antes de mergulharmos na configura\u00e7\u00e3o e implementa\u00e7\u00e3o do registro Laravel usando Monolog, vamos explorar mais raz\u00f5es para usar o registro Laravel e os diferentes tipos.<\/p>\n Por que \u00e9 necess\u00e1rio o registro de dados?<\/p>\n O Manifesto dos Aplicativos de 12 Fatores<\/a> trata a explora\u00e7\u00e3o do registro como uma das preocupa\u00e7\u00f5es cr\u00edticas de um aplicativo moderno, j\u00e1 que a explora\u00e7\u00e3o do registro \u00e9 a chave para o desempenho e monitoramento.<\/p>\n Os registros<\/a> ajudam na compreens\u00e3o detalhada dos erros que acontecem na produ\u00e7\u00e3o e de onde eles se originaram. Al\u00e9m disso, com estruturas de registros adequadas, ele pode mostrar o usu\u00e1rio em particular, a a\u00e7\u00e3o que causou o erro e a solu\u00e7\u00e3o poss\u00edvel para a corre\u00e7\u00e3o e manuten\u00e7\u00e3o mais r\u00e1pida do bug.<\/p>\n O registro estruturado \u00e9 um salva-vidas em aplicativos de produ\u00e7\u00e3o, ajudando a solucionar defeitos e resolver problemas na produ\u00e7\u00e3o. Al\u00e9m disso, voc\u00ea pode monitorar e coletar todas as suas mensagens de registro em tempo real usando ferramentas especializadas de registro para an\u00e1lise e relat\u00f3rios ao vivo.<\/p>\n Por estas raz\u00f5es, voc\u00ea precisa fazer do registro estruturado uma prioridade m\u00e1xima em seu pr\u00f3ximo projeto de aplicativo moderno.<\/p>\n Vamos dar uma olhada na vis\u00e3o geral dos diferentes estilos de extra\u00e7\u00e3o dispon\u00edveis.<\/p>\n Aprender o b\u00e1sico da explora\u00e7\u00e3o do registro o ajudar\u00e1 a entender como Laravel lida com a explora\u00e7\u00e3o do registro e como voc\u00ea pode melhorar suas pr\u00e1ticas estruturadas de explora\u00e7\u00e3o do registro.<\/p>\n Vamos examinar dois conceitos essenciais na explora\u00e7\u00e3o do registro para entender melhor como implementar nossos procedimentos de explora\u00e7\u00e3o do registro.<\/p>\n No desenvolvimento de software, o registro estruturado est\u00e1 implementando um formato de mensagem pr\u00e9-determinado e consistente para os registros de aplicativo. Este formato permite que as mensagens sejam tratadas como dados que podem ser monitorados, manipulados e visualizados muito melhor do que o formato de texto regular.<\/p>\n Voc\u00ea deve implementar uma abordagem de registro estruturado no desenvolvimento do seu aplicativo moderno porque os arquivos de registro s\u00e3o os ativos essenciais para os desenvolvedores quando algo errado acontece com o seu aplicativo em produ\u00e7\u00e3o.<\/p>\n Como Laravel usa o Monolog, os desenvolvedores podem rapidamente implementar registros estruturados configurando o logger para receber tipos espec\u00edficos de informa\u00e7\u00f5es, armazenando os arquivos de registro em diferentes formatos e enviando os registros para v\u00e1rios servi\u00e7os de gerenciamento de registros de terceiros para visualiza\u00e7\u00e3o.<\/p>\n Um sistema de registro centralizado \u00e9 onde os registros s\u00e3o enviados para solu\u00e7\u00f5es de Gerenciamento Centralizado de registro (CLM) a partir de m\u00faltiplas fontes para f\u00e1cil consolida\u00e7\u00e3o e visualiza\u00e7\u00e3o. Entretanto, o CLM \u00e9 uma solu\u00e7\u00e3o de logger especializada que coleta mensagens de registro de diferentes fontes e consolida os dados para facilitar o processamento e a visualiza\u00e7\u00e3o.<\/p>\n Al\u00e9m da coleta de dados, espera-se que o CLM tamb\u00e9m suporte a an\u00e1lise dos dados de registro e a apresenta\u00e7\u00e3o clara dos dados ap\u00f3s a an\u00e1lise.<\/p>\n Vamos examinar a diferen\u00e7a entre o registro estruturado e o registro b\u00e1sico (n\u00e3o estruturado) e porque voc\u00ea deve usar o registro estruturado em seu projeto Laravel.<\/p>\n No registro b\u00e1sico, os arquivos de registro s\u00e3o armazenados em um formato bruto com dados limitados para consulta e identifica\u00e7\u00e3o de registros individuais.<\/p>\n Ao usar o registro b\u00e1sico, os desenvolvedores<\/a> n\u00e3o ser\u00e3o capazes de usar ferramentas anal\u00edticas de terceiros para ler, visualizar e analisar os registros, a menos que eles desenvolvam uma ferramenta customizada ou que se fixem com uma ferramenta limitada que suporte seu formato de registros.<\/p>\n H\u00e1 tr\u00eas grandes raz\u00f5es para evitar o uso do corte b\u00e1sico:<\/p>\n O registro estruturado economiza tempo dos desenvolvedores ao usar ferramentas anal\u00edticas de registro de terceiros de c\u00f3digo aberto que suportam a estrutura padr\u00e3o de registro para ler, visualizar e analisar os registros.<\/p>\n Os registros s\u00e3o \u00fateis se eles contiverem os dados corretos listados abaixo, que \u00e9 o que o registro estruturado visa alcan\u00e7ar. N\u00f3s podemos usar os dados inclu\u00eddos no registro estruturado para criar pain\u00e9is, gr\u00e1ficos, gr\u00e1ficos e qualquer outra visualiza\u00e7\u00e3o \u00fatil para determinar a sa\u00fade do aplicativo.<\/p>\n Estes s\u00e3o exemplos b\u00e1sicos das informa\u00e7\u00f5es que podemos incluir em mensagens de registro estruturadas. Al\u00e9m disso, voc\u00ea pode personalizar completamente os dados para atender \u00e0s suas necessidades.<\/p>\n Aqui est\u00e3o alguns exemplos dos dados que voc\u00ea pode coletar com o registro estruturado:<\/p>\n Os registros devem conter dados suficientes para visualizar facilmente a solu\u00e7\u00e3o ou a raz\u00e3o do evento de log. Observe tamb\u00e9m que voc\u00ea n\u00e3o deve armazenar todos os tipos de informa\u00e7\u00f5es, tais como senhas ou dados sens\u00edveis nos registros.<\/p>\n Agora que vislumbramos o que \u00e9 a explora\u00e7\u00e3o do registro Laravel, vamos passar \u00e0 implementa\u00e7\u00e3o da explora\u00e7\u00e3o do registro Laravel, construindo um aplicativo com explora\u00e7\u00e3o do registro como um cidad\u00e3o de primeira classe.<\/p>\n Agora n\u00f3s vamos aplicar o que aprendemos at\u00e9 agora, criando um novo projeto Laravel e implementando o registro Laravel.<\/p>\n Se voc\u00ea nunca usou Laravel antes, voc\u00ea pode ler o que Laravel \u00e9<\/a> ou espreitar nossa lista de excelentes tutoriais de Laravel<\/a> para come\u00e7ar.<\/p>\n Primeiro, vamos criar uma nova inst\u00e2ncia de Laravel usando o comando abaixo. Voc\u00ea pode consultar a documenta\u00e7\u00e3o oficial<\/a> para mais informa\u00e7\u00f5es.<\/p>\n Abra seu console e navegue at\u00e9 onde voc\u00ea armazena seus projetos PHP antes de executar os comandos abaixo. Certifique-se de ter o Composer<\/a> instalado e configurado corretamente.<\/p>\n Em seguida, vamos montar nosso banco de dados, criar um novo modelo Abra seu cliente de banco de dados e crie um novo banco de dados. Faremos o mesmo com o nome Em seguida, executaremos o seguinte comando para criar a migra\u00e7\u00e3o e o modelo Abra o database\/migrations\/xxx-create-todos-xxx.php<\/strong>\u00a0e cole nos seguintes c\u00f3digos:<\/p>\n Voc\u00ea pode alimentar seus todos com dados falsos aprendendo a alimentar seus bancos de dados<\/a> em Laravel usando o Faker.<\/p>\n Com Laravel Monolog, voc\u00ea pode transmitir e enviar registros estruturados para diferentes canais, como e-mails, Slack, arquivos, soquetes, caixas de entrada, bancos de dados e v\u00e1rios servi\u00e7os web. No Laravel, voc\u00ea pode configurar o registro a partir de um \u00fanico arquivo de configura\u00e7\u00e3o localizado em config\/logging.php<\/strong>.<\/p>\n O arquivo de configura\u00e7\u00e3o vem com drivers de registro pr\u00e9-definidos para escolher, e o driver padr\u00e3o \u00e9 um Laravel fornece um punhado de m\u00e9todos<\/a> para interagir com os registros, como demonstrado em geral no arquivo do controlador TodosController.php<\/strong> em breve.<\/p>\n Abra o arquivo rec\u00e9m-criado TodosController.php<\/strong> controller encontrado na pasta app\/Http\/Controllers<\/strong> e cole nos seguintes c\u00f3digos:<\/p>\n Dentro de cada um dos m\u00e9todos no Fachada de log no m\u00e9todo Suponha que voc\u00ea n\u00e3o esteja confort\u00e1vel com o padr\u00e3o Nesse caso, voc\u00ea pode facilmente girar um objeto formatador personalizado para se ajustar ao seu caso de uso e us\u00e1-lo durante toda a aplica\u00e7\u00e3o.<\/p>\n A documenta\u00e7\u00e3o oficial do Monolog d\u00e1 uma lista completa de formatadores dispon\u00edveis<\/a> e pode facilmente criar um formatador personalizado.<\/p>\nPor que usar o registro Laravel?<\/h2>\n
No\u00e7\u00f5es b\u00e1sicas de registros no Laravel<\/h2>\n
Registro estruturado do Laravel<\/h3>\n
Registro centralizado no Laravel<\/h3>\n
Registros estruturados vs Registros b\u00e1sicos<\/h3>\n
Registro b\u00e1sico<\/h4>\n
\n
Registro estruturado<\/h4>\n
\n
Como implementar o registro Laravel com o aplicativo Todo<\/h2>\n
Configurando o 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>\nConfigurando e alimentando o banco de dados<\/h3>\n
Todo<\/code>, e alimentar 200 dados falsos para testes.<\/p>\nlaravel_logging_app_db<\/code> e ent\u00e3o preencheremos nosso arquivo .env<\/strong> com as credenciais do banco de dados:<\/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> simultaneamente:<\/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>\nVis\u00e3o geral do Monolog<\/h3>\n
stack<\/code> que usa o canal single<\/code> para logar em um arquivo laravel.log<\/strong> encontrado na pasta storage\/logs<\/strong>. N\u00f3s demonstraremos o registro estruturado usando um par de drivers de registro Laravel<\/a>.<\/p>\nEscrevendo mensagens de registro no 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>, n\u00f3s adicionamos a fachada Log<\/code> com um n\u00edvel de registro espec\u00edfico para definir o tipo de erro que queremos enviar. Abaixo est\u00e1 um exemplo de como usar o<\/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>\nFormata\u00e7\u00e3o de mensagens de registro<\/h3>\n
LineFormatter<\/code> usado por Laravel, que faz um \u00f3timo trabalho de fornecer mensagens leg\u00edveis e \u00fateis.<\/p>\n