[Laravel Query Monitor] - How to see queries executed by Eloquent?

Jansen Felipe — Wed, 06 May 2020 03:56:48 +0000

This question I asked myself when I was studying the Laravel Framework. At the time, I was impressed with all the “magic” of Eloquent.

    <?php

    $users = User::where('name', "Jansen Felipe")->get();
   
    // The above code executes the following SQL statement:
    // select * from `users` where name = "Jansen Felipe"

The Eloquent included in Laravel provides a beautiful and simple ActiveRecord implementation for working with your database.
* Laravel Framework documentation *

I am in complete agreement. Eloquent is a hand in the wheel and speeds up the development of that MVP that you have to publish Friday (lol).

It turns out that, in the case of success, it is quite possible that your database will grow and your system will start to slow down. (a “good” problem, right?)

In all the slowness cases I've worked on, most were related to performance in the database. And how to see the queries executed, once they are encapsulated in the framework? It has several forms. I quote some of them:

One way is to access the MySQL server (for example) and run the “show processlist” command.
Another way is to debug the application by calling the “toSql ()” method
Another way is using the package https://github.com/supliu/laravel-query-monitor

Laravel Query Monitor

This package was created as a developer support tool. Through the terminal, you execute the command php artisan laravel-query-monitor and from then on, all queries executed in your application will appear in real time in the terminal.

To develop the package, we used React PHP to open the query listening service on the terminal. Queries are sent using the DB :: listen method as specified in the Laravel documentation https://laravel.com/docs/7.x/database#listening-for-query-events

If you want to use the package, just install it using the composer:

    $ composer require --dev supliu/laravel-query-monitor

    $ php artisan vendor:publish --provider="Supliu\LaravelQueryMonitor\ServiceProvider"

The package code is open and published under the MIT license. So, feel free to copy, use and enhance! Follow the link to the repository on GitHub https://github.com/supliu/laravel-query-monitor

Doubts, criticisms or suggestions? Feel free in the comments!

** This article was originally published in Portuguese https: //supliu.com.br/2020/04/29/laravel-query-monitor-como-ver-queries-e-executadas-pelo-eloquent/

[Laravel Query Monitor] — Como ver queries executadas pelo Eloquent?

Jansen Felipe — Wed, 06 May 2020 03:45:08 +0000

Read in English

Essa pergunta eu me fiz logo quando estava estudando o Laravel Framework. Na ocasião, estava impressionado com toda a “magia” do Eloquent.

    <?php

    $users = User::where('name', "Jansen Felipe")->get();

    // O código acima executa a seguinte instrução SQL:
    // select * from `users` where name = "Jansen Felipe"

O Eloquent incluído no Laravel fornece uma implementação ActiveRecord bonita e simples para trabalhar com seu banco de dados.
*Documentação do Laravel Framework*

Eu sou de total acordo. O Eloquent é uma mão na roda e acelera bastante o desenvolvimento daquele MVP que você tem que publicar sexta-feira rsrs..

Acontece que, no caso de sucesso, é bem possível que seu banco de dados cresça e seu sistema comece a ficar lento. (um “bom” problema né?)

Em todos os casos de lentidão que eu já trabalhei, a maioria estava relacionada a performance no banco de dados. E como ver as queries executadas, uma vez que elas estão encapsuladas no framework? Tem várias formas. Cito alguma delas:

Uma forma é acessar o servidor MySQL (por exemplo) e executar o comando “show processlist”.
Outra forma é realizar o debug da aplicação chamando o método “toSql()”
Outra forma é utilizando o package https://github.com/supliu/laravel-query-monitor

Laravel Query Monitor

Esse pacote foi criado como uma ferramenta de suporte ao desenvolvedor. Através do terminal, você executa o comando “php artisan laravel-query-monitor” e a partir de então, todas as queries executadas na sua aplicação irá aparecer em tempo real no terminal.

Para desenvolver o pacote, utilizamos o React PHP para abrir o serviço de escuta de queries no terminal. O envio das queries é realizado utilizando o método DB::listen conforme especificado na documentação do Laravel https://laravel.com/docs/7.x/database#listening-for-query-events

Se você quer utilizar o pacote, basta fazer a instalação utilizando o composer:

$ composer require --dev supliu/laravel-query-monitor

$ php artisan vendor:publish --
provider="Supliu\LaravelQueryMonitor\ServiceProvider"

O código do pacote é aberto e publicado sob a licença MIT. Então, fique a vontade para copiar, usar e aprimorar! Segue o link do repositório no GitHub https://github.com/supliu/laravel-query-monitor

Dúvidas, críticas ou sugestões? Fique a vontade nos comentários!

** Esse artigo foi originalmente publicado em *https://supliu.com.br/2020/04/29/laravel-query-monitor-como-ver-queries-e-executadas-pelo-eloquent/

DEV Community: Jansen Felipe

[Laravel Query Monitor] - How to see queries executed by Eloquent?

Laravel Query Monitor

[Laravel Query Monitor] — Como ver queries executadas pelo Eloquent?

Laravel Query Monitor