From 0955b0a39dfbea341e4b7942c006f4397cc850e7 Mon Sep 17 00:00:00 2001 From: Marcel Müller Date: Sat, 19 Apr 2025 21:24:50 +0200 Subject: feat: Add option to also log parameters to query log MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- lib/private/DB/Connection.php | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/lib/private/DB/Connection.php b/lib/private/DB/Connection.php index eecf83ace95..96dd578b2ef 100644 --- a/lib/private/DB/Connection.php +++ b/lib/private/DB/Connection.php @@ -414,7 +414,7 @@ class Connection extends PrimaryReadReplicaConnection { $sql = $this->finishQuery($sql); $this->queriesExecuted++; - $this->logQueryToFile($sql); + $this->logQueryToFile($sql, $params); try { return parent::executeQuery($sql, $params, $types, $qcp); } catch (\Exception $e) { @@ -461,7 +461,7 @@ class Connection extends PrimaryReadReplicaConnection { } $sql = $this->finishQuery($sql); $this->queriesExecuted++; - $this->logQueryToFile($sql); + $this->logQueryToFile($sql, $params); try { return (int)parent::executeStatement($sql, $params, $types); } catch (\Exception $e) { @@ -470,14 +470,19 @@ class Connection extends PrimaryReadReplicaConnection { } } - protected function logQueryToFile(string $sql): void { + protected function logQueryToFile(string $sql, array $params): void { $logFile = $this->systemConfig->getValue('query_log_file'); if ($logFile !== '' && is_writable(dirname($logFile)) && (!file_exists($logFile) || is_writable($logFile))) { $prefix = ''; if ($this->systemConfig->getValue('query_log_file_requestid') === 'yes') { $prefix .= Server::get(IRequestId::class)->getId() . "\t"; } + $postfix = ''; + if ($this->systemConfig->getValue('query_log_file_parameters') === 'yes') { + $postfix .= '; ' . json_encode($params); + } + if ($this->systemConfig->getValue('query_log_file_backtrace') === 'yes') { $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); array_pop($trace); -- cgit v1.2.3 From 2ca168f717f75851f6c64446d060f37a18c03e6a Mon Sep 17 00:00:00 2001 From: Marcel Müller Date: Sat, 19 Apr 2025 21:25:22 +0200 Subject: chore: Update config.sample.php to include query log extensions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marcel Müller --- config/config.sample.php | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/config/config.sample.php b/config/config.sample.php index 97388db99f2..0b1e896e366 100644 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -2512,6 +2512,28 @@ $CONFIG = [ */ 'query_log_file' => '', +/** + * Prefix all queries with the requestid when set to `yes` + * + * Requires `query_log_file` to be set. + */ +'query_log_file_requestid' => '', + +/** + * Add all query parameters to the query log entry when set to `yes` + * + * Requires `query_log_file` to be set. + * Warning: This will log sensitive data into a plain text file. + */ +'query_log_file_parameters' => '', + +/** + * Add a backtrace to the query log entry when set to `yes` + * + * Requires `query_log_file` to be set. + */ +'query_log_file_backtrace' => '', + /** * Log all redis requests into a file * -- cgit v1.2.3