Make Docker logging to stderr the default

This will make logging to stderr the default. Also documentation is added on how to add syslog config. This will allow debugging in dev env (devonf) out-of-the-box.
OpenConext · Feb 6, 2025 · 7ce7a13 · 7ce7a13
1 parent c72e17a
commit 7ce7a13
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 32 deletions.
diff --git a/app/config/config_test.yml b/app/config/config_test.yml
@@ -47,9 +47,9 @@ monolog:
             type: fingers_crossed
             activation_strategy: engineblock.logger.manual_or_error_activation_strategy
             passthru_level: "%logger.fingers_crossed.passthru_level%"
-            handler: file
+            handler: nested
             channels: ['!event']
-        file:
+        nested:
             type:   stream
             path:   "%kernel.logs_dir%/%kernel.environment%.log"
             level:  DEBUG

diff --git a/app/config/logging.yml b/app/config/logging.yml
@@ -5,16 +5,19 @@ monolog:
             type: fingers_crossed
             activation_strategy: engineblock.logger.manual_or_error_activation_strategy
             passthru_level: "%logger.fingers_crossed.passthru_level%"
-            handler: syslog
-            channels: ["!authentication"]
-        syslog:
-            type:      syslog
-            ident:     "%logger.syslog.ident%"
-            formatter: engineblock.logger.additional_info_formatter
+            handler: nested
+            channels: [!authentication]
+        nested:
+            type:      stream
+            path:      php://stderr
+            formatter: engineblock.logger.formatter.syslog_json
         authentication:
-            type:      syslog
-            ident:     EBAUTH
-            facility:  user
+            type:      stream
+            path:      php://stderr
             level:     INFO
             channels:  [authentication]
             formatter: engineblock.logger.formatter.syslog_json
+        console:
+            type: console
+            process_psr_3_messages: false
+            channels: [!event, !doctrine, !console]
diff --git a/app/config/parameters.yml.dist b/app/config/parameters.yml.dist
@@ -113,7 +113,6 @@ parameters:
     logger.channel: engineblock
     logger.fingers_crossed.passthru_level: NOTICE
     logger.fingers_crossed.action_level: ERROR
-    logger.syslog.ident: EBLOG
     logger.line_format: '[%%datetime%%] %%channel%%.%%level_name%%: %%message%% %%extra%% %%context%%'
 
     ##########################################################################################

diff --git a/docker/Dockerfile.prod b/docker/Dockerfile.prod
@@ -13,7 +13,6 @@ RUN tar -xvjf /tmp/*.tar.bz2 -C /var/www/html/ && \
 # Add the config files for Apache2
 RUN rm -rf /etc/apache2/sites-enabled/*
 COPY ./docker/conf/engine.conf /etc/apache2/sites-enabled/engine.conf
-COPY ./docker/conf/logging.yml /var/www/html/app/config/logging.yml
 # Instantiate devconf config
 RUN cp app/config/parameters.yml.dist app/config/parameters.yml
 

diff --git a/docker/conf/logging.yml b/docker/conf/logging.yml
diff --git a/docs/index.md b/docs/index.md
@@ -9,10 +9,12 @@
 1. [Release notes for releases < 5.0.0][release-notes]
 1. [PHP testing][php-testing]
 1. [Javscript testing][js-testing]
+1. [Logging][logging]
 
 [license]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/LICENSE
 [release]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/release_procedure.md
 [filter]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/filter_commands.md
 [release-notes]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/release_notes
 [php-testing]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/php_testing.md
 [js-testing]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/js_testing.md
+[logging]: https://github.com/OpenConext/OpenConext-engineblock/tree/master/docs/logging.md
diff --git a/docs/logging.md b/docs/logging.md
@@ -0,0 +1,38 @@
+# Logging
+
+## Overview
+
+The default logging method of Engineblock is logging to `stderr`, which is particularly useful for Docker-based deployments.
+However, logging to `syslog` will still be possible for environments where traditional syslog logging is required.
+
+## Configuring Logging to Syslog
+
+To configure `logging.yml` to log to syslog, you should use the syslog handler to the Monolog configuration. Below is an example configuration:
+
+```yaml
+monolog:
+    channels: ["%logger.channel%", "authentication"]
+    handlers:
+        main:
+            type: fingers_crossed
+            activation_strategy: engineblock.logger.manual_or_error_activation_strategy
+            passthru_level: "%logger.fingers_crossed.passthru_level%"
+            channels: [!authentication]
+            handler: nested
+        authentication:
+            type:      syslog
+            ident:     EBAUTH
+            facility:  user
+            level:     INFO
+            channels:  [authentication]
+            formatter: engineblock.logger.formatter.syslog_json
+        nested:
+            type: syslog
+            ident: "EBLOG"
+            formatter: engineblock.logger.formatter.syslog_json`
+        console:
+            type: console
+            process_psr_3_messages: false
+            channels: [!event, !doctrine, !console]
+
+