FileLogger: Add option to log errors only (#351)

dg · Feb 9, 2020 · f766292 · f766292
1 parent 2f857c2
commit f766292
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 24 deletions.
diff --git a/examples/using-logger.php b/examples/using-logger.php
@@ -20,6 +20,7 @@
 	// enable query logging to this file
 	'profiler' => [
 		'file' => 'log/log.sql',
+		'errorsOnly' => false,
 	],
 ]);
 

diff --git a/src/Dibi/Connection.php b/src/Dibi/Connection.php
@@ -51,6 +51,7 @@ class Connection implements IConnection
 	 *   - profiler (array)
 	 *       - run (bool) => enable profiler?
 	 *       - file => file to log
+	 * 		 - errorsOnly (bool) => log only errors
 	 *   - substitutes (array) => map of driver specific substitutes (under development)
 	 *   - onConnect (array) => list of SQL queries to execute (by Connection::query()) after connection is established
 	 * @throws Exception
@@ -70,7 +71,8 @@ public function __construct(array $config, string $name = null)
 		// profiler
 		if (isset($config['profiler']['file']) && (!isset($config['profiler']['run']) || $config['profiler']['run'])) {
 			$filter = $config['profiler']['filter'] ?? Event::QUERY;
-			$this->onEvent[] = [new Loggers\FileLogger($config['profiler']['file'], $filter), 'logEvent'];
+			$errorsOnly = $config['profiler']['errorsOnly'] ?? false;
+			$this->onEvent[] = [new Loggers\FileLogger($config['profiler']['file'], $filter, $errorsOnly), 'logEvent'];
 		}
 
 		$this->substitutes = new HashMap(function (string $expr) { return ":$expr:"; });

diff --git a/src/Dibi/Loggers/FileLogger.php b/src/Dibi/Loggers/FileLogger.php
@@ -25,11 +25,14 @@ class FileLogger
 	/** @var int */
 	public $filter;
 
+	/** @var bool */
+	private $errorsOnly;
 
-	public function __construct(string $file, int $filter = null)
+	public function __construct(string $file, int $filter = null, bool $errorsOnly)
 	{
 		$this->file = $file;
 		$this->filter = $filter ?: Dibi\Event::QUERY;
+		$this->errorsOnly = $errorsOnly ?? false;
 	}
 
 
@@ -42,35 +45,39 @@ public function logEvent(Dibi\Event $event): void
 			return;
 		}
 
-		$handle = fopen($this->file, 'a');
-		if (!$handle) {
-			return; // or throw exception?
+		if ($this->errorsOnly === true && ($event->result instanceof \Exception) === false) {
+			return;
 		}
-		flock($handle, LOCK_EX);
 
 		if ($event->result instanceof \Exception) {
 			$message = $event->result->getMessage();
 			if ($code = $event->result->getCode()) {
 				$message = "[$code] $message";
 			}
-			fwrite($handle,
-				"ERROR: $message"
-				. "\n-- SQL: " . $event->sql
-				. "\n-- driver: " . $event->connection->getConfig('driver') . '/' . $event->connection->getConfig('name')
-				. ";\n-- " . date('Y-m-d H:i:s')
-				. "\n\n"
-			);
-		} else {
-			fwrite($handle,
-				'OK: ' . $event->sql
-				. ($event->count ? ";\n-- rows: " . $event->count : '')
-				. "\n-- takes: " . sprintf('%0.3f ms', $event->time * 1000)
-				. "\n-- source: " . implode(':', $event->source)
-				. "\n-- driver: " . $event->connection->getConfig('driver') . '/' . $event->connection->getConfig('name')
-				. "\n-- " . date('Y-m-d H:i:s')
-				. "\n\n"
-			);
+			$message = "ERROR: $message"
+					.  "\n-- SQL: " . $event->sql;
+
+			$this->writeToFile($event, $message);
+			return;
+
 		}
-		fclose($handle);
+
+		$message = 'OK: ' . $event->sql
+				 . ($event->count ? ";\n-- rows: " . $event->count : '')
+				 . "\n-- takes: " . sprintf('%0.3f ms', $event->time * 1000)
+				 . "\n-- source: " . implode(':', $event->source);
+
+		$this->writeToFile($event, $message);
+	}
+
+	private function writeToFile(Dibi\Event $event, $message): void
+	{
+		if (is_writable(dirname($this->file)) === false) return;
+
+		$message .= "\n-- driver: " . $event->connection->getConfig('driver') . '/' . $event->connection->getConfig('name')
+				 .  "\n-- " . date('Y-m-d H:i:s')
+				 .  "\n\n";
+
+		file_put_contents($this->file, $message, FILE_APPEND | LOCK_EX);
 	}
 }