Merge pull request #8 from crowdsecurity/log-path

log path

Author: mobula9

docs/contribute.md

@@ -135,7 +135,7 @@ docker-compose run wordpress<X.X> bash
 ### Display the plugin logs
 
 ```bash
-tail -f logs/*
+tail -f logs/debug-*
 ```
 
 #### New feature workflow

inc/bouncer-instance.php

@@ -3,6 +3,7 @@
 use CrowdSecBouncer\Bouncer;
 use CrowdSecBouncer\BouncerException;
 use CrowdSecBouncer\Constants;
+use Monolog\Formatter\LineFormatter;
 use Monolog\Handler\RotatingFileHandler;
 use Monolog\Logger;
 use Symfony\Component\Cache\Adapter\AbstractAdapter;
@@ -25,15 +26,18 @@ function getCrowdSecLoggerInstance(): Logger
 
     // Log more data if WP_DEBUG=1
 
-    $loggerLevel = WP_DEBUG ? Logger::DEBUG : Logger::INFO;
     $logger = new Logger('wp_bouncer');
-    $fileHandler = new RotatingFileHandler(CROWDSEC_LOG_PATH, 0, $loggerLevel);
 
-    // Set custom readble logger for WP_DEBUG=1
+    $fileHandler = new RotatingFileHandler(CROWDSEC_LOG_PATH, 0, Logger::INFO);
+    $fileHandler->setFormatter(new LineFormatter("%datetime%|%level%|%context%\n"));
+    $logger->pushHandler($fileHandler);
+
+    // Set custom readable logger for WP_DEBUG=1
     if (WP_DEBUG) {
-        $fileHandler->setFormatter(new \Bramus\Monolog\Formatter\ColoredLineFormatter(null, "[%datetime%] %message% %context%\n", 'H:i:s'));
+        $debugFileHandler = new RotatingFileHandler(CROWDSEC_DEBUG_LOG_PATH, 0, Logger::DEBUG);
+        $debugFileHandler->setFormatter(new \Bramus\Monolog\Formatter\ColoredLineFormatter(null, "[%datetime%] %message% %context%\n", 'H:i:s'));
+        $logger->pushHandler($debugFileHandler);
     }
-    $logger->pushHandler($fileHandler);
 
     return $logger;
 }

inc/constants.php

@@ -1,6 +1,8 @@
 <?php
 
-define('CROWDSEC_LOG_PATH', CROWDSEC_PLUGIN_PATH.'/logs/crowdsec.log');
+$crowdsecRandomLogFolder = get_option('crowdsec_random_log_folder') ?: '';
+define('CROWDSEC_LOG_PATH', CROWDSEC_PLUGIN_PATH."/logs/$crowdsecRandomLogFolder/prod.log");
+define('CROWDSEC_DEBUG_LOG_PATH', CROWDSEC_PLUGIN_PATH."/logs/$crowdsecRandomLogFolder/debug.log");
 define('CROWDSEC_CACHE_PATH', CROWDSEC_PLUGIN_PATH.'/.cache');
 
 define('CROWDSEC_BOUNCING_LEVEL_DISABLED', 'bouncing_disabled');

inc/plugin-setup.php

@@ -31,6 +31,10 @@ function activate_crowdsec_plugin()
     update_option('crowdsec_hide_mentions', false);
     update_option('crowdsec_trust_ip_forward', '');
     update_option('crowdsec_trust_ip_forward_array', []);
+
+    if (!get_option('crowdsec_random_log_folder')) {
+        update_option('crowdsec_random_log_folder', bin2hex(random_bytes(64)));
+    }
 }
 
 /**

inc/templates/dashboard.php

@@ -8,13 +8,13 @@ const WORDPRESS_VERSION = process.env.WORDPRESS_VERSION;
 const ADMIN_LOGIN = "admin";
 const ADMIN_PASSWORD = "my_very_very_secret_admin_password";
 const LAPI_URL = process.env.LAPI_URL_FROM_CONTAINERS;
-const NOTIFY = !!process.env.DEBUG;
+const DEBUG = !!process.env.DEBUG;
 const TIMEOUT = (!!process.env.DEBUG ? 5 * 60 : 8) * 1000;
 const OTHER_IP = "1.2.3.4";
 const adminUrl = `${BASE_URL}/wp-admin/`;
 
 const notify = (message) => {
-    if (NOTIFY) {
+    if (DEBUG) {
         notifier.notify({
             title: "CrowdSec automation",
             message: message,
@@ -33,10 +33,6 @@ const WP56 = WORDPRESS_VERSION === "";
 const WP55 = WORDPRESS_VERSION === "5.5";
 const WP54 = WORDPRESS_VERSION === "5.4";
 const WP53 = WORDPRESS_VERSION === "5.3";
-const WP52 = WORDPRESS_VERSION === "5.2";
-const WP51 = WORDPRESS_VERSION === "5.1";
-const WP50 = WORDPRESS_VERSION === "5.0";
-const WP49 = WORDPRESS_VERSION === "4.9";
 
 const waitForNavigation = page.waitForNavigation();
 
@@ -266,7 +262,7 @@ const remediationShouldUpdate = async (
 
     describe(`Setup WordPress ${WORDPRESS_VERSION} and CrowdSec plugin`, () => {
 
-    beforeEach(() => console.log(expect.getState().currentTestName));
+    beforeEach(() => (DEBUG ? console.log(expect.getState().currentTestName) : null))
 
     it('Should install wordpress"', async () => {
         notify(`Setup WordPress ${WORDPRESS_VERSION} and CrowdSec plugin`);
@@ -328,7 +324,7 @@ const remediationShouldUpdate = async (
 
 describe(`Run in Live mode`, () => {
 
-    beforeEach(() => console.log(expect.getState().currentTestName));
+    beforeEach(() => (DEBUG ? console.log(expect.getState().currentTestName) : null))
 
     it('Should reduce the cache durations"', async () => {
         notify("Run in Live mode");
@@ -493,7 +489,7 @@ describe(`Run in Live mode`, () => {
 
 describe(`Run in Stream mode`, () => {
 
-    beforeEach(() => console.log(expect.getState().currentTestName));
+    beforeEach(() => (DEBUG ? console.log(expect.getState().currentTestName) : null))
 
     it('Should enable the stream mode"', async () => {
         notify("Run in Stream mode");
@@ -534,7 +530,7 @@ describe(`Run in Stream mode`, () => {
 
 describe(`Use Redis technology`, () => {
 
-    beforeEach(() => console.log(expect.getState().currentTestName));
+    beforeEach(() => (DEBUG ? console.log(expect.getState().currentTestName) : null))
 
     it('Should be able to use Redis cache"', async () => {
         notify("Use Redis technology");
@@ -565,7 +561,7 @@ describe(`Use Redis technology`, () => {
 
 describe(`Use Memcached technology`, () => {
 
-    beforeEach(() => console.log(expect.getState().currentTestName));
+    beforeEach(() => (DEBUG ? console.log(expect.getState().currentTestName) : null))
 
     it('Should be able to use Memcached cache"', async () => {
         notify("Use Memcached technology");