Improved bundle configuration for the latest Symfony framework.

Author: DKravtsov

Dockerfile

@@ -63,9 +63,6 @@ COPY ./docker/general/do_we_need_xdebug.sh /tmp/
 COPY ./docker/dev/xdebug.ini /tmp/
 RUN chmod u+x /tmp/do_we_need_xdebug.sh && /tmp/do_we_need_xdebug.sh
 
-# copy modified monolog config for testing easyLogBundle
-COPY ./docker/dev/monolog.yaml /tmp/
-
 # install composer
 COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
 RUN chmod +x /usr/bin/composer

Makefile

@@ -81,33 +81,27 @@ test-using-symfony-6:
 	@make clean
 	@make exec-bash cmd="composer create-project symfony/skeleton:'6.4.x' ."
 	@make exec-bash cmd="composer require webapp --no-interaction"
-	@make transfer-monolog-config
 	@make install-bundle
 	@make cache-clear-warmup
 
 test-using-symfony-7:
 	@make clean
 	@make exec-bash cmd="composer create-project symfony/skeleton:'7.4.x' ."
 	@make exec-bash cmd="composer require webapp --no-interaction"
-	@make transfer-monolog-config
 	@make install-bundle
 	@make cache-clear-warmup
 
 test-using-symfony-8:
 	@make clean
 	@make exec-bash cmd="composer create-project symfony/skeleton:'8.0.x' ."
 	@make exec-bash cmd="composer require webapp --no-interaction"
-	@make transfer-monolog-config
 	@make install-bundle
 	@make cache-clear-warmup
 
 clean:
 	@make exec-by-root cmd="find . -delete"
 	@make exec-by-root cmd="chown -R www-data:www-data /var/www/html"
 
-transfer-monolog-config:
-	@make exec-bash cmd="mkdir -p /var/www/html/config/packages/dev && cp --force /tmp/monolog.yaml /var/www/html/config/packages/dev/"
-
 install-bundle:
 	@make exec-bash cmd="composer config extra.symfony.allow-contrib true"
 	@make exec-bash cmd="composer require --dev systemsdk/easy-log-bundle:*"

docker/dev/monolog.yaml

@@ -145,23 +145,7 @@ $ composer remove easycorp/easy-log-handler
 ```
 Note: Please remove configuration files `config/packages/easy_log_handler.yaml`, `config/packages/dev/easy_log_handler.yaml`, `config/packages/test/easy_log_handler.yaml`, etc...
 
-2. Edit your `config/packages/dev/monolog.yaml` and `config/packages/test/monolog.yaml` and put next configuration:
-```yaml
-monolog:
-    handlers:
-        buffered:
-            type: buffer
-            handler: easylog
-            level: debug
-            channels: ['!event']
-        easylog:
-            type: service
-            id: easy_log.handler
-```
-In the above configuration, the `buffered` handler saves all log messages and then passes them to the EasyLog bundle, which processes all messages at once and writes the result in the log file.
-Use the `buffered` handler to configure the channels logged/excluded and the level of the messages being logged.
-
-3. Allow Flex to use contrib recipes and install next symfony bundle:
+2. Allow Flex to use contrib recipes and install the next symfony bundle:
 ```bash
 $ composer config extra.symfony.allow-contrib true
 $ composer require --dev systemsdk/easy-log-bundle:*
@@ -170,13 +154,31 @@ $ composer require --dev systemsdk/easy-log-bundle:*
 Configuration and Usage
 -----------------------
 
-You can change default configuration in your application by editing next config file:
+You can change the default configuration in your application by editing the next config file:
 
 ```yaml
-# config/packages/dev/systemsdk_easy_log.yaml
-easy_log:
-    log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
-    max_line_length: 120
-    prefix_length: 2
-    ignored_routes: ['_wdt', '_profiler']
+# config/packages/systemsdk_easy_log.yaml
+when@dev:
+    monolog:
+        handlers:
+            buffered:
+                type: buffer
+                handler: easylog
+                level: debug
+                channels: [ '!event' ]
+            easylog:
+                type: service
+                id: easy_log.handler
+    easy_log:
+        log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
+        max_line_length: 120
+        prefix_length: 4
+        ignored_routes: [ '_wdt', '_profiler' ]
+
+when@test:
+    easy_log:
+        log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
+        max_line_length: 120
+        prefix_length: 4
+        ignored_routes: [ '_wdt', '_profiler' ]
 ```

readme.md

@@ -27,28 +27,7 @@ Installation
 Note: Please remove configuration files ``config/packages/easy_log_handler.yaml``,
 ``config/packages/dev/easy_log_handler.yaml``, ``config/packages/test/easy_log_handler.yaml``, etc...
 
-2. Edit your ``config/packages/dev/monolog.yaml`` and ``config/packages/test/monolog.yaml`` and put next configuration:
-
-.. configuration-block::
-
-    .. code-block:: yaml
-
-        monolog:
-            handlers:
-                buffered:
-                    type: buffer
-                    handler: easylog
-                    level: debug
-                    channels: ['!event']
-                easylog:
-                    type: service
-                    id: easy_log.handler
-
-In the above configuration, the ``buffered`` handler saves all log messages and then passes them to the EasyLog bundle,
-which processes all messages at once and writes the result in the log file.
-Use the ``buffered`` handler to configure the channels logged/excluded and the level of the messages being logged.
-
-3. Allow Flex to use contrib recipes and install next symfony bundle:
+2. Allow Flex to use contrib recipes and install the next symfony bundle:
 
 .. code-block:: bash
     $ composer config extra.symfony.allow-contrib true
@@ -58,17 +37,35 @@ Use the ``buffered`` handler to configure the channels logged/excluded and the l
 Configuration and Usage
 -----------------------
 
-You can change default configuration in your application by editing next config file:
+You can change the default configuration in your application by editing the next config file:
 
 .. configuration-block::
 
     .. code-block:: yaml
 
-        # config/packages/dev/systemsdk_easy_log.yaml
-        easy_log:
-            log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
-            max_line_length: 120
-            prefix_length: 2
-            ignored_routes: ['_wdt', '_profiler']
+        # config/packages/systemsdk_easy_log.yaml
+        when@dev:
+            monolog:
+                handlers:
+                    buffered:
+                        type: buffer
+                        handler: easylog
+                        level: debug
+                        channels: [ '!event' ]
+                    easylog:
+                        type: service
+                        id: easy_log.handler
+            easy_log:
+                log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
+                max_line_length: 120
+                prefix_length: 4
+                ignored_routes: [ '_wdt', '_profiler' ]
+
+        when@test:
+            easy_log:
+                log_path: '%kernel.logs_dir%/%kernel.environment%-readable.log'
+                max_line_length: 120
+                prefix_length: 4
+                ignored_routes: [ '_wdt', '_profiler' ]
 
 .. _`easycorp/easy-log-handler`: https://github.com/EasyCorp/easy-log-handler