增加动态配置监听方法

Author: zanehy

README.md

@@ -0,0 +1,42 @@
+# laravel-sql-monitor
+
+
+## 功能介绍
+
+> 目前支持版本为: `laravle5.5~` `laravel6^`
+
+##### 监控当前`页面功能`或者`接口`内执行的所有sql详细数据，以日志形式输出到laravel业务日志中（json方式写入日志）
+
+- 监控的方法名称以 `sql_monitor_action:` 为前缀的方法路径
+- sql执行语句
+- sql执行参数
+- sql执行时长(ms为单位)
+- sql执行的的文件路径和文件内执行的行数
+
+## 安装和配置
+
+- 安装扩展，复制一下命令直接安装扩展包
+```
+composer require zanehy/laravel-sql-monitor
+```
+
+- 配置，在 `/config/app.php` 文件内 `providers` 下增加以下配置
+```
+Zanehy\SqlMonitor\SqlMonitorServiceProvider::class,
+```
+
+- 开启监听，以下三种配置中任意一种符合要求即可开启监听模式
+    1. 配置 `env` 的 `APP_ENV` 为 `local`
+    2. 配置 `env` 的 `APP_DEBUG` 为 `true`
+    3. 新增 `env` 的配置 `MONITOR` 为 `true` （该种方式主要是为了兼容前两种配置在生产环境下需单独开启sql监听模式增加的一种独立开关配置）
+
+- 日志打印和输出，日志字段解释
+    * action： 当前访问的页面或者接口地址，以 `sql_monitor_action:` 为前缀
+    * sql：当前方法执行的sql语句 使用 `?` 作为占位符
+    * bindings： 当前sql使用到的参数，以数组形式展示，与上面sql中的占位符 `?` 依次对应
+    * time: 当前sql语句执行的时间，毫秒 `ms` 为单位
+    * file: 当期sql执行的文件名称（包含路径）
+    * line: 当前sql在上文件中执行的行数
+
+
+

config/monitor.php

@@ -7,7 +7,8 @@
  */
 
 return [
-
     'app' => env("APP_ENV", ''),
-    'sql-monitor' => env("SQL_MONITOR", false),
+    'debug' => env("APP_DEBUG", false),
+    'sql-monitor' => env("MONITOR", false),
+    'monitor-action' => env("MONITOR_ACTIONS", ""),
 ];

src/SqlMonitoServiceProvider.php

@@ -69,7 +69,30 @@ protected function mergeConfigFrom($path, $key)
     public function boot()
     {
 
-        if (($this->app['config']->get('monitor.app') == "local") || $this->app['config']->get('monitor.sql-monitor')) {
+        if (($this->app['config']->get('monitor.app') == "local") || //开启配置APP_ENV配置为local启动
+            $this->app['config']->get('monitor.debug') || //开启debug模式，默认自动启东监听
+            $this->app['config']->get('monitor.sql-monitor')) //开启配置SQL_MONITOR配置为true启动（为不影响APP_ENV和APP_DEBUG配置，单独设置sql监控的开启配置）
+        {
+
+            //获取当前访问的路径地址和要匹配的路由，进行匹配指定的监控路径
+            $urlPath = Request::capture()->path();
+            $monitorActions = $this->app['config']->get('monitor.monitor-action');
+            $monitorActions = array_unique(array_filter(explode("|", $monitorActions)));
+            if (empty($urlPath) || empty($monitorActions)) {
+                return true;
+            }
+
+            //匹配当前的路径是否在配置的路径中
+            $matching = false;
+            foreach ($monitorActions as $monitorAction) {
+                if (strstr(trim($urlPath), trim($monitorAction))) {
+                    $matching = true;
+                    break;
+                }
+            }
+            if (!$matching) {
+                true;
+            }
 
             $db = $this->app['db'];
             $db->listen(
@@ -89,8 +112,6 @@ function ($query) {
         }
     }
 
-
-
     /**
      * 监听
      * @auther zhanghy<[email protected]>
@@ -99,8 +120,8 @@ function ($query) {
      */
     private function sqlMonitor(QueryExecuted $event, array $stacks)
     {
-        $sql = str_replace("?", "'%s'", $event->sql);
-        $sql = vsprintf($sql, $event->bindings);
+//        $sql = str_replace("?", "'%s'", $event->sql);
+//        $sql = vsprintf($sql, $event->bindings);
         $urlPath = Request::capture()->path();
 
         //检索执行的文件和行数
@@ -115,9 +136,9 @@ private function sqlMonitor(QueryExecuted $event, array $stacks)
 
         //记录日志
         Log::info(json_encode([
-            'action' => 'sqlmonitor:'. $urlPath,
-            'path' => $urlPath,
-            'sql' => $sql,
+            'action' => 'sql_monitor_action:'. $urlPath,
+            'sql' => $event->sql,
+            'bindings' => $event->bindings,
             'time' => $event->time . 'ms',
             'file' => ($res['file'] ?? ''),
             'line' => ($res['line'] ?? '')