Add log handlers syslog and errorlog (matomo-org#17764)

* Add log handlers syslog and errorlog

Issue#9400

* Add log handlers syslog and errorlog

* syslog/errorlog: fix namespace; add log.syslog.ident

* syslog/errorlog: Document options

* ErrorLogHandler constructor: Avoid null

Avoid null in ErrorLogHandler constructor call: Use level param; default others

* missing comma

* fix two di definitions

Co-authored-by: diosmosis <[email protected]>

Author: mwithheld

config/global.ini.php

@@ -92,7 +92,7 @@
 enable_logging = 0
 
 [log]
-; possible values for log: screen, database, file
+; possible values for log: screen, database, file, errorlog, syslog
 log_writers[] = screen
 
 ; log level, everything logged w/ this level or one of greater severity
@@ -105,10 +105,16 @@
 ; this allows you to log more information to one backend vs another.
 ; log_level_screen =
 ; log_level_file =
+; log_level_errorlog =
+; log_level_syslog =
 
 ; if configured to log in a file, log entries will be made to this file
 logger_file_path = tmp/logs/matomo.log
 
+; if configured to log to syslog, mark them with this identifier string.
+; This acts as an easy-to-find tag in the syslog.
+logger_syslog_ident = 'matomo'
+
 [Cache]
 ; available backends are 'file', 'array', 'null', 'redis', 'chained'
 ; 'array' will cache data only during one request

core/Log.php

@@ -38,8 +38,9 @@
  * The following configuration options can be set:
  *
  * - `log_writers[]`: This is an array of log writer IDs. The three log writers provided
- *                    by Piwik core are **file**, **screen** and **database**. You can
- *                    get more by installing plugins. The default value is **screen**.
+ *                    by Piwik core are **file**, **screen**, **database**, **errorlog**, 
+ *                    and **syslog**. You can get more by installing plugins. The default 
+ *                    value is **screen**.
  * - `log_level`: The current log level. Can be **ERROR**, **WARN**, **INFO**, **DEBUG**,
  *                or **VERBOSE**. Log entries made with a log level that is as or more
  *                severe than the current log level will be outputted. Others will be
@@ -48,6 +49,9 @@
  *                       to log to or a path to a directory to store logs in. If a
  *                       directory, the file name is piwik.log. Can be relative to
  *                       Piwik's root dir or an absolute path. Defaults to **tmp/logs**.
+ * - `logger_syslog_ident`: If configured to log to syslog, mark them with this 
+ *                          identifier string.  This acts as an easy-to-find tag in 
+ *                          the syslog.
  *
  *
  * @deprecated Inject and use Psr\Log\LoggerInterface instead of this class.

plugins/Monolog/config/config.php

@@ -17,6 +17,8 @@
         'file'     => 'Piwik\Plugins\Monolog\Handler\FileHandler',
         'screen'   => 'Piwik\Plugins\Monolog\Handler\WebNotificationHandler',
         'database' => 'Piwik\Plugins\Monolog\Handler\DatabaseHandler',
+        'errorlog' => '\Monolog\Handler\ErrorLogHandler',
+        'syslog' => '\Monolog\Handler\SyslogHandler',
     ),
     'log.handlers' => DI\factory(function (\DI\Container $c) {
         if ($c->has('ini.log.log_writers')) {
@@ -97,6 +99,14 @@
     'Piwik\Plugins\Monolog\Handler\FileHandler' => DI\create()
         ->constructor(DI\get('log.file.filename'), DI\get('log.level.file'))
         ->method('setFormatter', DI\get('log.lineMessageFormatter.file')),
+    
+    '\Monolog\Handler\ErrorLogHandler' => DI\autowire()
+        ->constructorParameter('level', DI\get('log.level.errorlog'))
+        ->method('setFormatter', DI\get('log.lineMessageFormatter.file')),
+
+    '\Monolog\Handler\SyslogHandler' => DI\create()
+        ->constructor(DI\get('log.syslog.ident'), 'syslog', DI\get('log.level.syslog'))
+        ->method('setFormatter', DI\get('log.lineMessageFormatter.file')),
 
     'Piwik\Plugins\Monolog\Handler\DatabaseHandler' => DI\create()
         ->constructor(DI\get('log.level.database'))
@@ -147,6 +157,26 @@
         return $c->get('log.level');
     }),
 
+    'log.level.syslog' => DI\factory(function (ContainerInterface $c) {
+        if ($c->has('ini.log.log_level_syslog')) {
+            $level = Log::getMonologLevelIfValid($c->get('ini.log.log_level_syslog'));
+            if ($level !== null) {
+                return $level;
+            }
+        }
+        return $c->get('log.level');
+    }),
+
+    'log.level.errorlog' => DI\factory(function (ContainerInterface $c) {
+        if ($c->has('ini.log.log_level_errorlog')) {
+            $level = Log::getMonologLevelIfValid($c->get('ini.log.log_level_errorlog'));
+            if ($level !== null) {
+                return $level;
+            }
+        }
+        return $c->get('log.level');
+    }),
+
     'log.file.filename' => DI\factory(function (ContainerInterface $c) {
         $logPath = $c->get('ini.log.logger_file_path');
 
@@ -172,6 +202,14 @@
 
         return $logPath;
     }),
+    
+    'log.syslog.ident' => DI\factory(function (ContainerInterface $c) {
+        $ident = $c->get('ini.log.logger_syslog_ident');
+        if (empty($ident)) {
+            $ident = 'matomo';
+        }
+        return $ident;
+    }),
 
     'Piwik\Plugins\Monolog\Formatter\LineMessageFormatter' => DI\create('Piwik\Plugins\Monolog\Formatter\LineMessageFormatter')
                                                                 ->constructor(DI\get('log.short.format')),