ADD more info in log: method Name caller, arguments, stackTrace.

Author: lopadova

.env.example

@@ -7,3 +7,5 @@ QUERYMONITOR_BUILDER_ATTIVA=true
 #in milliseconds
 QUERYMONITOR_BUILDER_MAX_EXECUTION_TIME=200
 QUERYMONITOR_BUILDER_METHOD_REGEX='^.*$'
+
+QUERYMONITOR_BUILDER_MAX_STACK_DEPTH=5

README.md

@@ -77,8 +77,30 @@ Once installed and configured, the package will automatically monitor and log SQ
 
 **Example Log Entry:**
 
-```bash
-[2024-11-28 12:34:56] local.INFO: QueryMonitor: Slow Eloquent method detected {"method":"get","execution_time":"250 ms"}
+```json
+{
+    "method": "get",
+    "execution_time": "250 ms",
+    "query": "SELECT * FROM `articles` WHERE `status` = 'published'",
+    "arguments": [
+        ["*"]
+    ],
+    "stack_trace": [
+        {
+            "file": "/path/to/your/project/app/Models/QueryBase.php",
+            "line": 123,
+            "class": "App\\Models\\QueryBase",
+            "function": "getPublishedArticles"
+        },
+        {
+            "file": "/path/to/your/project/app/Http/Controllers/ArticleController.php",
+            "line": 45,
+            "class": "App\\Http\\Controllers\\ArticleController",
+            "function": "index"
+        },
+        // ... additional frames up to the maximum stack depth
+    ]
+}
 ```
 
 ## Difference Between Monitoring SQL Queries and Eloquent Methods

config/querymonitor.php

@@ -78,4 +78,16 @@
         'methodRegEx' => env('QUERYMONITOR_BUILDER_METHOD_REGEX', '^.*$'),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Miscellaneous Settings
+    |--------------------------------------------------------------------------
+    |
+    */
+
+    /*
+     * Maximum stack trace depth to include in the logs.
+     * Set to 0 to disable stack trace logging.
+     */
+    'maxStackDepth' => env('QUERYMONITOR_BUILDER_MAX_STACK_DEPTH', 5),
 ];

src/Builders/QueryMonitorBuilder.php

@@ -65,17 +65,44 @@ private function executeWithTiming(string $methodName, array $arguments)
             $sql = preg_replace('/\?/', $value, $sql, 1);
         }
 
+        // Capture the call stack up to the maximum depth
+        $maxStackDepth = $builderConfig['maxStackDepth'] ?? 5;
+        $stackTrace = $this->getStackTrace($maxStackDepth);
+
         // Log the slow Eloquent method execution
         Log::info('QueryMonitor: Slow Eloquent method detected', [
             'method' => $methodName,
-            'execution_time' => $executionTime . ' ms',
+            'arguments' => $arguments,
             'query' => $sql,
+            'execution_time' => $executionTime . ' ms',
+            'stack_trace' => $stackTrace,
         ]);
 
         // Return the result of the parent method
         return $results;
     }
 
+    /**
+     * Captures the stack trace up to the specified depth.
+     */
+    private function getStackTrace(int $maxStackDepth): array
+    {
+        $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, $maxStackDepth + 1);
+        $stackTrace = [];
+
+        for ($i = 1; $i <= $maxStackDepth && isset($backtrace[$i]); $i++) {
+            $frame = $backtrace[$i];
+            $stackTrace[] = [
+                'file' => $frame['file'] ?? '',
+                'line' => $frame['line'] ?? '',
+                'class' => $frame['class'] ?? '',
+                'function' => $frame['function'] ?? '',
+            ];
+        }
+
+        return $stackTrace;
+    }
+
     /**
      * Overrides the get method to include performance monitoring.
      *
@@ -126,10 +153,10 @@ public function pluck($column, $key = null)
     /**
      * Overrides the paginate method to include performance monitoring.
      *
-     * @param  int|null                                              $perPage  Items per page.
-     * @param  array|string                                          $columns  The columns to retrieve.
-     * @param  string                                                $pageName The page query string parameter.
-     * @param  int|null                                              $page     The current page.
+     * @param  int|null             $perPage  Items per page.
+     * @param  array|string         $columns  The columns to retrieve.
+     * @param  string               $pageName The page query string parameter.
+     * @param  int|null             $page     The current page.
      * @return LengthAwarePaginator The paginator instance.
      */
     public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)