Improve messages logged for exceptions

cakephp · Jan 12, 2013 · d8551c4 · d8551c4
1 parent 676872d
commit d8551c4
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 7 deletions.
diff --git a/lib/Cake/Error/ErrorHandler.php b/lib/Cake/Error/ErrorHandler.php
@@ -22,6 +22,7 @@
 App::uses('Debugger', 'Utility');
 App::uses('CakeLog', 'Log');
 App::uses('ExceptionRenderer', 'Error');
+App::uses('Router', 'Routing');
 
 /**
  *
@@ -109,12 +110,7 @@ class ErrorHandler {
 	public static function handleException(Exception $exception) {
 		$config = Configure::read('Exception');
 		if (!empty($config['log'])) {
-			$message = sprintf("[%s] %s\n%s",
-				get_class($exception),
-				$exception->getMessage(),
-				$exception->getTraceAsString()
-			);
-			CakeLog::write(LOG_ERR, $message);
+			CakeLog::write(LOG_ERR, self::_getMessage($exception));
 		}
 		$renderer = $config['renderer'];
 		if ($renderer !== 'ExceptionRenderer') {
@@ -136,6 +132,32 @@ public static function handleException(Exception $exception) {
 		}
 	}
 
+/**
+ * Generates a formatted error message
+ * @param Exception $exception Exception instance
+ * @return string Formatted message
+ */
+	protected function _getMessage($exception) {
+		$message = sprintf("[%s] %s",
+			get_class($exception),
+			$exception->getMessage()
+		);
+		if (method_exists($exception, 'getAttributes')) {
+			$attributes = $exception->getAttributes();
+			if ($attributes) {
+				$message .= "\nException Attributes: " . var_export($exception->getAttributes(), true);
+			}
+		}
+		if (php_sapi_name() != 'cli') {
+			$request = Router::getRequest();
+			if ($request) {
+				$message .= "\nRequest URL: " . $request->here();
+			}
+		}
+		$message .= "\nStack Trace:\n" . $exception->getTraceAsString();
+		return $message;
+	}
+
 /**
  * Set as the default error handler by CakePHP. Use Configure::write('Error.handler', $callback), to use your own
  * error handling methods. This function will use Debugger to display errors when debug > 0. And

diff --git a/lib/Cake/Test/Case/Error/ErrorHandlerTest.php b/lib/Cake/Test/Case/Error/ErrorHandlerTest.php
@@ -224,7 +224,7 @@ public function testHandleExceptionLog() {
 
 		$log = file(LOGS . 'error.log');
 		$this->assertRegExp('/\[NotFoundException\] Kaboom!/', $log[0], 'message missing.');
-		$this->assertRegExp('/\#0.*ErrorHandlerTest->testHandleExceptionLog/', $log[1], 'Stack trace missing.');
+		$this->assertRegExp('/\#0.*ErrorHandlerTest->testHandleExceptionLog/', $log[2], 'Stack trace missing.');
 	}
 
 /**