Merge pull request #5 from nkikkertyouwe/main

Added URL filter

Author: ugoliniriccardo

Model/Config.php

@@ -35,6 +35,11 @@ class Config
      */
     protected const WEBAPI_LOGS_LOG_CLEAN_OLDER_THAN_HOURS = 'webapi_logs/log/clean_older_than_hours';
 
+    /**
+     * @var string
+     */
+    protected const WEBAPI_LOGS_LOG_FILTER_REQUEST_PATHS = 'webapi_logs/log/filter_request_paths';
+
     /**
      * @var ScopeConfigInterface
      */
@@ -102,4 +107,19 @@ public function getCleanOlderThanHours(): int
             ScopeInterface::SCOPE_WEBSITE
         );
     }
+
+    /**
+     * @return array
+     */
+    public function getFilterRequestPaths(): array
+    {
+        $value = $this->scopeConfig->getValue(
+            self::WEBAPI_LOGS_LOG_FILTER_REQUEST_PATHS,
+            ScopeInterface::SCOPE_WEBSITE
+        );
+        if ($value == null) {
+            return [];
+        }
+        return preg_split('/\n|\r\n?/', $value);
+    }
 }

Model/LogHandle.php

@@ -78,22 +78,27 @@ public function before(
         string $requestBody,
         string $requestDateTime
     ) {
-        if ($this->config->isSecretMode()) {
-            $requestorIp = $this->secretParser->parseIp();
-            $requestHeaders = $this->secretParser->parseHeades($requestHeaders);
-            $requestBody = $this->secretParser->parseBody($requestBody);
-        }
+        $filter = $this->config->getFilterRequestPaths();
+        
+        // Only log this request if the path is not filtered.
+        if (!$this->filterRequestPath($requestPath, $filter)) {
+          if ($this->config->isSecretMode()) {
+              $requestorIp = $this->secretParser->parseIp();
+              $requestHeaders = $this->secretParser->parseHeades($requestHeaders);
+              $requestBody = $this->secretParser->parseBody($requestBody);
+          }
 
-        $log = $this->logFactory->create();
-        $log->setData([
-            'request_method' => $requestMethod,
-            'requestor_ip' => $requestorIp,
-            'request_url' => $requestPath,
-            'request_headers' => $requestHeaders,
-            'request_body' => $requestBody,
-            'request_datetime' => $requestDateTime
-        ]);
-        $this->lastLog = $log;
+          $log = $this->logFactory->create();
+          $log->setData([
+              'request_method' => $requestMethod,
+              'requestor_ip' => $requestorIp,
+              'request_url' => $requestPath,
+              'request_headers' => $requestHeaders,
+              'request_body' => $requestBody,
+              'request_datetime' => $requestDateTime
+          ]);
+          $this->lastLog = $log;
+        }
     }
 
     /**
@@ -123,4 +128,26 @@ public function after(
             $this->logger->error(__('Cant complete webapi log save because of error: %1', $exception->getMessage()));
         }
     }
+
+    /**
+     * Check if request path is among the filters.
+     *
+     * @param string $requestPath
+     * @param array  $filters
+     *
+     * @return bool
+     */
+    private function filterRequestPath(
+        string $requestPath,
+        array $filters
+    ): bool {
+        foreach ($filters as $filter) {
+            if ($filter != '') {
+                if (stripos($requestPath, $filter) !== false) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
 }

README.md

@@ -4,7 +4,7 @@ This module allows you to analyze all the webapi rest done call toward your mage
 
 # Install
 
-`composer require ghostunicorns/module-webapi-logs`
+`composer require youwe/module-webapi-logs`
 
 # Configure
 

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "ghostunicorns/module-webapi-logs",
+    "name": "youwe/module-webapi-logs",
     "description": "Magento Webapi Log Details accessible via backend",
     "type": "magento2-module",
     "require": {

etc/adminhtml/system.xml

@@ -44,6 +44,13 @@
                     </depends>
                     <validate>validate-number validate-greater-than-zero</validate>
                 </field>
+                <field id="filter_request_paths" translate="label" type="textarea" sortOrder="50" showInDefault="1" showInWebsite="0" showInStore="0">
+                    <label>Filter request paths</label>
+                    <depends>
+                        <field id="webapi_logs/log/enabled">1</field>
+                    </depends>
+                    <comment><![CDATA[A list of request paths that should not be logged, separated by a simple new line]]></comment>
+                </field>
             </group>
         </section>
     </system>