Show queries memory usage (#1462)

Co-authored-by: Barry vd. Heuvel <barryvdh@gmail.com>
barryvdh · Feb 9, 2024 · 04b2868 · 04b2868
1 parent 22333fd
commit 04b2868
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/config/debugbar.php b/config/debugbar.php
@@ -216,6 +216,7 @@
             'hints'             => false,    // Show hints for common mistakes
             'show_copy'         => false,    // Show copy button next to the query,
             'slow_threshold'    => false,   // Only track queries that last longer than this time in ms
+            'memory_usage'      => false,   // Show queries memory usage
         ],
         'mail' => [
             'timeline' => false,  // Add mails to the timeline

diff --git a/src/DataCollector/QueryCollector.php b/src/DataCollector/QueryCollector.php
@@ -13,6 +13,7 @@ class QueryCollector extends PDOCollector
 {
     protected $timeCollector;
     protected $queries = [];
+    protected $lastMemoryUsage;
     protected $renderSqlWithParams = false;
     protected $findSource = false;
     protected $middleware = [];
@@ -117,6 +118,10 @@ public function setExplainSource($enabled, $types)
 //        }
     }
 
+    public function startMemoryUsage() {
+        $this->lastMemoryUsage = memory_get_usage(false);
+    }
+
     /**
      *
      * @param string $query
@@ -189,6 +194,7 @@ public function addQuery($query, $bindings, $time, $connection)
             'bindings' => $this->getDataFormatter()->escapeBindings($bindings),
             'start' => $startTime,
             'time' => $time,
+            'memory' => $this->lastMemoryUsage ? memory_get_usage(false) - $this->lastMemoryUsage : 0,
             'source' => $source,
             'explain' => $explainResults,
             'connection' => $connection->getDatabaseName(),
@@ -451,6 +457,7 @@ public function collectTransactionEvent($event, $connection)
             'bindings' => [],
             'start' => microtime(true),
             'time' => 0,
+            'memory' => 0,
             'source' => $source,
             'explain' => [],
             'connection' => $connection->getDatabaseName(),
@@ -474,12 +481,14 @@ public function reset()
     public function collect()
     {
         $totalTime = 0;
+        $totalMemory = 0;
         $queries = $this->queries;
 
         $statements = [];
         foreach ($queries as $query) {
             $source = reset($query['source']);
             $totalTime += $query['time'];
+            $totalMemory += $query['memory'];
 
             $statements[] = [
                 'sql' => $this->getDataFormatter()->formatSql($query['query']),
@@ -492,6 +501,8 @@ public function collect()
                 'start' => $query['start'] ?? null,
                 'duration' => $query['time'],
                 'duration_str' => ($query['type'] == 'transaction') ? '' : $this->formatDuration($query['time']),
+                'memory' => $query['memory'],
+                'memory_str' => $query['memory'] ? $this->getDataFormatter()->formatBytes($query['memory']) : null,
                 'stmt_id' => $this->getDataFormatter()->formatSource($source),
                 'xdebug_link' => is_object($source) ? $this->getXdebugLink($source->file ?: '', $source->line) : null,
                 'connection' => $query['connection'],
@@ -588,6 +599,8 @@ public function collect()
             'nb_failed_statements' => 0,
             'accumulated_duration' => $totalTime,
             'accumulated_duration_str' => $this->formatDuration($totalTime),
+            'memory_usage' => $totalMemory,
+            'memory_usage_str' => $totalMemory ? $this->getDataFormatter()->formatBytes($totalMemory) : null,
             'statements' => $statements
         ];
         return $data;

diff --git a/src/LaravelDebugbar.php b/src/LaravelDebugbar.php
@@ -426,6 +426,18 @@ function ($event, $params) use ($queryCollector) {
                         $queryCollector->collectTransactionEvent('Rollback Transaction', $params[0]);
                     }
                 );
+
+                $db->getEventDispatcher()->listen(
+                    function (\Illuminate\Database\Events\ConnectionEstablished $event) use ($queryCollector) {
+                        $queryCollector->collectTransactionEvent('Connection Established', $event->connection);
+
+                        if (app('config')->get('debugbar.options.db.memory_usage')) {
+                            $event->connection->beforeExecuting(function () use ($queryCollector){
+                                $queryCollector->startMemoryUsage();
+                            });
+                        }
+                    }
+                );
             } catch (\Exception $e) {
                 $this->addThrowable(
                     new Exception(