├── .gitignore
├── README.md
├── composer.json
└── src
    ├── Contracts
        └── FileWritable.php
    ├── QueryLog.php
    ├── QueryLogServiceProvider.php
    └── Supports
        ├── JsonLogFileWriter.php
        └── TextLogFileWriter.php


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /.idea
3 | /node_modules
4 | /composer.lock
5 | *.txt


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <h1 align="center">Laravel Query Log</h1>
 2 | <p align="center">
 3 |     <a href="https://packagist.org/packages/haruncpi/laravel-query-log"><img src="https://badgen.net/packagist/v/haruncpi/laravel-query-log" /></a>
 4 |     <a href="https://creativecommons.org/licenses/by/4.0/"><img src="https://badgen.net/badge/licence/CC BY 4.0/23BCCB" /></a>
 5 |      <a href=""><img src="https://badgen.net/packagist/dt/haruncpi/laravel-query-log"/></a>
 6 |     <a href="https://twitter.com/laravelarticle"><img src="https://badgen.net/badge/twitter/@laravelarticle/1DA1F2?icon&label" /></a>
 7 |     <a href="https://facebook.com/laravelarticle"><img src="https://badgen.net/badge/facebook/laravelarticle/3b5998"/></a>
 8 | </p>
 9 | <p align="center">Log executed Laravel SQL queries and their line number and more!</p>
10 | 
11 | 
12 | ## Support
13 | <a href="https://www.buymeacoffee.com/haruncpi" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="width: 160px !important;" ></a>
14 | 
15 | ## Documentation
16 | Get documentation on [laravelarticle.com](https://laravelarticle.com/laravel-query-log)
17 | 
18 | ## Sample Preview
19 | text format
20 | ```text
21 | url         : http://example.test
22 | method      : GET
23 | total_query : 3
24 | total_time  : 5.69
25 | --------------------
26 | 
27 | sl          : 1
28 | query       : select * from `students` where `id` = ? and `name` = ?
29 | bindings    : 6|Tomas
30 | final_query : select * from `students` where `id` = 6 and `name` = 'Tomas'
31 | time        : 4.38
32 | file        : C:\www\example\app\Http\Controllers\SiteController.php:10
33 | line        : 10
34 | 
35 | sl          : 2
36 | query       : select * from `students` where `id` = ? and `phone` = ?
37 | bindings    : 6|649-768-7305
38 | final_query : select * from `students` where `id` = 6 and `phone` = '649-768-7305'
39 | time        : 0.75
40 | file        : C:\www\example\app\Http\Controllers\SiteController.php:11
41 | line        : 11
42 | 
43 | sl          : 3
44 | query       : select * from `students` where `id` = ?
45 | bindings    : 6
46 | final_query : select * from `students` where `id` = 6
47 | time        : 0.56
48 | file        : C:\www\example\app\Http\Controllers\SiteController.php:12
49 | line        : 12
50 | ```
51 | 
52 | ## Other Packages
53 | - [Laravel Log Reader](https://github.com/haruncpi/laravel-log-reader) - A simple and beautiful laravel log reader.
54 | - [Laravel H](https://github.com/haruncpi/laravel-h) - A helper package for Laravel Framework.
55 | - [Laravel Simple Filemanager](https://github.com/haruncpi/laravel-simple-filemanager) - A simple filemanager for Laravel.
56 | - [Laravel Option Framework](https://github.com/haruncpi/laravel-option-framework) - Option framework for Laravel.
57 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "haruncpi/laravel-query-log",
 3 |     "description": "Log your all laravel sql query",
 4 |     "license": "cc-by-4.0",
 5 |     "authors": [{
 6 |         "name": "Md.Harun-Ur-Rashid",
 7 |         "email": "harun.cox@gmail.com"
 8 |     }],
 9 |     "minimum-stability": "dev",
10 |     "prefer-stable": true,
11 |     "require": {
12 |         "php": ">=5.6.0"
13 |     },
14 |     "autoload": {
15 |         "psr-4": {
16 |             "Haruncpi\\QueryLog\\": "src/"
17 |         }
18 |     },
19 |     "extra": {
20 |         "laravel": {
21 |             "providers": [
22 |                 "Haruncpi\\QueryLog\\QueryLogServiceProvider"
23 |             ]
24 |         }
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Contracts/FileWritable.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Haruncpi\QueryLog\Contracts;
 2 | 
 3 | interface FileWritable
 4 | {
 5 |     /**
 6 |      * @param string $file_path
 7 |      * @param array $data
 8 |      * @return void
 9 |      */
10 |     public function write($file_path, $data);
11 | }


--------------------------------------------------------------------------------
/src/QueryLog.php:
--------------------------------------------------------------------------------
  1 | <?php namespace Haruncpi\QueryLog;
  2 | 
  3 | use Haruncpi\QueryLog\Supports\JsonLogFileWriter;
  4 | use Haruncpi\QueryLog\Supports\TextLogFileWriter;
  5 | use Illuminate\Support\Facades\DB;
  6 | 
  7 | /**
  8 |  * QueryLog Class
  9 |  * @since 1.0.0
 10 |  */
 11 | class QueryLog
 12 | {
 13 |     const FORMAT_TEXT = 'text';
 14 |     const FORMAT_JSON = 'json';
 15 | 
 16 |     /**
 17 |      * @var string file name for query log inside storage directory
 18 |      */
 19 |     private $file_name = 'query.log';
 20 | 
 21 |     /**
 22 |      * @var string file format of query log. default is text. available text,json
 23 |      */
 24 |     private $format;
 25 | 
 26 |     /**
 27 |      * @var string $file_path use for get the absolute path
 28 |      */
 29 |     private $file_path;
 30 | 
 31 |     /**
 32 |      * @var int calculate the total number of query.
 33 |      */
 34 |     private $total_query;
 35 | 
 36 |     /**
 37 |      * @var int calculate the total amount of query time.
 38 |      */
 39 |     private $total_time;
 40 | 
 41 |     /**
 42 |      * @var array file data for writing data into file.
 43 |      */
 44 |     private $final;
 45 | 
 46 | 
 47 |     /**
 48 |      * QueryLog constructor.
 49 |      * @throws \Exception
 50 |      */
 51 |     public function __construct()
 52 |     {
 53 |         $this->file_path = storage_path($this->file_name);
 54 |         $this->format = trim(env('QUERY_LOG_FORMAT', self::FORMAT_TEXT));
 55 |         $this->total_query = 0;
 56 |         $this->total_time = 0;
 57 |         $this->final = [];
 58 | 
 59 |         if (!in_array(strtolower($this->format), [self::FORMAT_TEXT, self::FORMAT_JSON])) {
 60 |             throw new \Exception('Invalid query log data file format. Support text or json file format.');
 61 |         }
 62 | 
 63 |         if (file_exists($this->file_path)) {
 64 |             unlink($this->file_path);
 65 |         }
 66 | 
 67 | 
 68 |         $this->listenQueries();
 69 |     }
 70 | 
 71 | 
 72 |     /**
 73 |      * Query listener
 74 |      * @return void
 75 |      *
 76 |      * @since 1.0.0
 77 |      */
 78 |     private function listenQueries()
 79 |     {
 80 | 
 81 |         DB::listen(function ($query) {
 82 |             $this->total_query++;
 83 |             $this->total_time += $query->time;
 84 | 
 85 |             $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 86 |             foreach ($backtrace as $trace) {
 87 |                 if (array_key_exists('file', $trace) && array_key_exists('line', $trace)) {
 88 |                     if (strpos($trace['file'], base_path('app')) !== false) {
 89 |                         $this->addQuery($query, $trace);
 90 |                         break;
 91 |                     }
 92 |                 }
 93 |             }
 94 |         });
 95 | 
 96 |         app()->terminating(function () {
 97 | 
 98 |             $this->final['meta'] = [
 99 |                 'url'         => request()->url(),
100 |                 'method'      => request()->method(),
101 |                 'total_query' => $this->total_query,
102 |                 'total_time'  => $this->total_time
103 |             ];
104 | 
105 |             if ($this->format == self::FORMAT_JSON && isset($this->final['queries'])) {
106 |                 (new JsonLogFileWriter)->write($this->file_path, $this->final);
107 |             }
108 | 
109 |             if ($this->format == self::FORMAT_TEXT && isset($this->final['queries'])) {
110 |                 (new TextLogFileWriter)->write($this->file_path, $this->final);
111 |             }
112 |         });
113 |     }
114 | 
115 |     /**
116 |      * Make final query from sql bindings
117 |      *
118 |      * @param $query
119 |      * @return string
120 |      *
121 |      * @since 1.0.0
122 |      */
123 |     private function getSqlWithBindings($query)
124 |     {
125 |         return vsprintf(str_replace('?', '%s', $query->sql), collect($query->bindings)
126 |             ->map(function ($binding) {
127 |                 return is_numeric($binding) ? $binding : "'{$binding}'";
128 |             })->toArray());
129 |     }
130 | 
131 | 
132 |     /**
133 |      * add each query in a specific array format
134 |      *
135 |      * @param object $query
136 |      * @param array $trace
137 |      * @return void
138 |      *
139 |      * @since 1.0.0
140 |      */
141 |     private function addQuery($query, $trace)
142 |     {
143 |         $queryStr = $this->getSqlWithBindings($query);
144 |         $time = $query->time;
145 |         $file = $trace['file'];
146 |         $line = $trace['line'];
147 | 
148 | 
149 |         $this->final['queries'][] = [
150 |             'sl'          => $this->total_query,
151 |             'query'       => $query->sql,
152 |             'bindings'    => $query->bindings,
153 |             'final_query' => $queryStr,
154 |             'time'        => $time,
155 |             'file'        => $file . ":$line",
156 |             'line'        => $line
157 |         ];
158 |     }
159 | }
160 | 


--------------------------------------------------------------------------------
/src/QueryLogServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Haruncpi\QueryLog;
 2 | 
 3 | use Illuminate\Support\ServiceProvider;
 4 | 
 5 | class QueryLogServiceProvider extends ServiceProvider
 6 | {
 7 | 
 8 |     /**
 9 |      * @throws \Exception
10 |      */
11 |     public function boot()
12 |     {
13 |         if (env('QUERY_LOG', false)) {
14 |             new QueryLog;
15 |         }
16 |     }
17 | 
18 |     public function register()
19 |     {
20 |     }
21 | 
22 | }


--------------------------------------------------------------------------------
/src/Supports/JsonLogFileWriter.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Haruncpi\QueryLog\Supports;
 2 | 
 3 | use Haruncpi\QueryLog\Contracts\FileWritable;
 4 | 
 5 | class JsonLogFileWriter implements FileWritable
 6 | {
 7 |     public function write($file_path, $data)
 8 |     {
 9 |         file_put_contents($file_path, json_encode($data, JSON_PRETTY_PRINT));
10 |     }
11 | }


--------------------------------------------------------------------------------
/src/Supports/TextLogFileWriter.php:
--------------------------------------------------------------------------------
 1 | <?php namespace Haruncpi\QueryLog\Supports;
 2 | 
 3 | use Haruncpi\QueryLog\Contracts\FileWritable;
 4 | 
 5 | class TextLogFileWriter implements FileWritable
 6 | {
 7 |     private $file_path;
 8 | 
 9 |     public function write($file_path, $data)
10 |     {
11 |         $this->file_path = $file_path;
12 | 
13 |         foreach ($data['meta'] as $key => $value) {
14 |             $this->writeLine($this->addSpace($key, 12) . ": $value");
15 |         }
16 | 
17 |         $this->writeLine("--------------------\n");
18 | 
19 |         foreach ($data['queries'] as $q) {
20 |             foreach ($q as $key => $val) {
21 |                 if (is_array($val)) {
22 |                     $this->writeLine($this->addSpace($key, 12) . ": " . implode("|", $val));
23 |                 } else {
24 |                     $this->writeLine($this->addSpace($key, 12) . ": " . $val);
25 |                 }
26 |             }
27 | 
28 |             $this->writeLine("");
29 |         }
30 |     }
31 | 
32 |     private function addSpace($key, $max)
33 |     {
34 |         return $key . str_repeat(' ', $max - strlen($key));
35 |     }
36 | 
37 |     private function writeLine($txt)
38 |     {
39 |         file_put_contents($this->file_path, $txt . "\n", FILE_APPEND);
40 |     }
41 | }


--------------------------------------------------------------------------------