Merge pull request #10048 from nextcloud/feature/9760/systemd-logger

Systemd Logger

4 files changed, 97 insertions, 4 deletions

diff --git a/lib/private/Log/LogFactory.php b/lib/private/Log/LogFactory.php
index 9b9d12abfa8..5bb803cbaf2 100644
--- a/lib/private/Log/LogFactory.php
+++ b/lib/private/Log/LogFactory.php
@@ -3,6 +3,7 @@
  * @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
  *
  * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Johannes Ernst <jernst@indiecomputing.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -50,6 +51,8 @@ class LogFactory implements ILogFactory {
 				return new Errorlog();
 			case 'syslog':
 				return $this->c->resolve(Syslog::class);
+			case 'systemd':
+				return $this->c->resolve(Systemdlog::class);
 			case 'file':
 				return $this->buildLogFile();
 
diff --git a/lib/private/Log/Syslog.php b/lib/private/Log/Syslog.php
index 90a20026f0e..b652eb4343d 100644
--- a/lib/private/Log/Syslog.php
+++ b/lib/private/Log/Syslog.php
@@ -39,7 +39,7 @@ class Syslog implements IWriter {
 	];
 
 	public function __construct(IConfig $config) {
-		openlog($config->getSystemValue('syslog_tag', 'ownCloud'), LOG_PID | LOG_CONS, LOG_USER);
+		openlog($config->getSystemValue('syslog_tag', 'Nextcloud'), LOG_PID | LOG_CONS, LOG_USER);
 	}
 
 	public function __destruct() {
diff --git a/lib/private/Log/Systemdlog.php b/lib/private/Log/Systemdlog.php
new file mode 100644
index 00000000000..40e9c12386e
--- /dev/null
+++ b/lib/private/Log/Systemdlog.php
@@ -0,0 +1,78 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018, Johannes Ernst
+ *
+ * @author Johannes Ernst <jernst@indiecomputing.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Log;
+
+use OC\HintException;
+use OCP\ILogger;
+use OCP\IConfig;
+use OCP\Log\IWriter;
+
+// The following fields are understood by systemd/journald, see
+// man systemd.journal-fields. All are optional:
+// MESSAGE=
+//     The human-readable message string for this entry.
+// MESSAGE_ID=
+//     A 128-bit message identifier ID
+// PRIORITY=
+//     A priority value between 0 ("emerg") and 7 ("debug")
+// CODE_FILE=, CODE_LINE=, CODE_FUNC=
+//     The code location generating this message, if known
+// ERRNO=
+//     The low-level Unix error number causing this entry, if any.
+// SYSLOG_FACILITY=, SYSLOG_IDENTIFIER=, SYSLOG_PID=
+//     Syslog compatibility fields
+
+class Systemdlog implements IWriter {
+	protected $levels = [
+		ILogger::DEBUG => 7,
+		ILogger::INFO => 6,
+		ILogger::WARN => 4,
+		ILogger::ERROR => 3,
+		ILogger::FATAL => 2,
+	];
+
+	protected $syslogId;
+
+	public function __construct(IConfig $config) {
+		if(!function_exists('sd_journal_send')) {
+			throw new HintException(
+				'PHP extension php-systemd is not available.',
+				'Please install and enable PHP extension systemd if you wish to log to the Systemd journal.');
+
+		}
+		$this->syslogId = $config->getSystemValue('syslog_tag', 'Nextcloud');
+	}
+
+	/**
+	 * Write a message to the log.
+	 * @param string $app
+	 * @param string $message
+	 * @param int $level
+	 */
+	public function write(string $app, $message, int $level) {
+		$journal_level = $this->levels[$level];
+		sd_journal_send('PRIORITY='.$journal_level,
+				'SYSLOG_IDENTIFIER='.$this->syslogId,
+				'MESSAGE={'.$app.'} '.$message);
+	}
+}
diff --git a/lib/private/legacy/template.php b/lib/private/legacy/template.php
index f84d6386deb..1505089d561 100644
--- a/lib/private/legacy/template.php
+++ b/lib/private/legacy/template.php
@@ -358,9 +358,21 @@ class OC_Template extends \OC\Template\Base {
 			$content->assign('requestID', $request->getId());
 			$content->printPage();
 		} catch (\Exception $e) {
-			$logger = \OC::$server->getLogger();
-			$logger->logException($exception, ['app' => 'core']);
-			$logger->logException($e, ['app' => 'core']);
+			try {
+				$logger = \OC::$server->getLogger();
+				$logger->logException($exception, ['app' => 'core']);
+				$logger->logException($e, ['app' => 'core']);
+			} catch (Throwable $e) {
+				// no way to log it properly - but to avoid a white page of death we send some output
+				header('Content-Type: text/plain; charset=utf-8');
+				print("Internal Server Error\n\n");
+				print("The server encountered an internal error and was unable to complete your request.\n");
+				print("Please contact the server administrator if this error reappears multiple times, please include the technical details below in your report.\n");
+				print("More details can be found in the server log.\n");
+
+				// and then throw it again to log it at least to the web server error log
+				throw $e;
+			}
 
 			header('Content-Type: text/plain; charset=utf-8');
 			print("Internal Server Error\n\n");