Merge pull request #115 from Rockstar04/logging

PSR-3 Compliant Logging

Author: chrisboulton

bin/resque

@@ -39,15 +39,15 @@ if(!empty($REDIS_BACKEND)) {
         Resque::setBackend($REDIS_BACKEND, $REDIS_BACKEND_DB);
 }
 
-$logLevel = 0;
+$logLevel = false;
 $LOGGING = getenv('LOGGING');
 $VERBOSE = getenv('VERBOSE');
 $VVERBOSE = getenv('VVERBOSE');
 if(!empty($LOGGING) || !empty($VERBOSE)) {
-    $logLevel = Resque_Worker::LOG_NORMAL;
+    $logLevel = true;
 }
 else if(!empty($VVERBOSE)) {
-    $logLevel = Resque_Worker::LOG_VERBOSE;
+    $logLevel = true;
 }
 
 $APP_INCLUDE = getenv('APP_INCLUDE');
@@ -59,6 +59,12 @@ if($APP_INCLUDE) {
     require_once $APP_INCLUDE;
 }
 
+// See if the APP_INCLUDE containes a logger object,
+// If none exists, fallback to internal logger
+if (!isset($logger) && !is_object($logger)) {
+    $logger = new Resque_Log($logLevel);
+}
+
 $BLOCKING = getenv('BLOCKING') !== FALSE;
 
 $interval = 5;
@@ -75,22 +81,23 @@ if(!empty($COUNT) && $COUNT > 1) {
 
 $PREFIX = getenv('PREFIX');
 if(!empty($PREFIX)) {
-    fwrite(STDOUT, '*** Prefix set to '.$PREFIX."\n");
+    $logger->log(Psr\Log\LogLevel::INFO, 'Prefix set to {prefix}', array('prefix' => $PREFIX));
     Resque_Redis::prefix($PREFIX);
 }
 
 if($count > 1) {
     for($i = 0; $i < $count; ++$i) {
         $pid = Resque::fork();
         if($pid == -1) {
-            die("Could not fork worker ".$i."\n");
+            $logger->log(Psr\Log\LogLevel::EMERGENCY, 'Could not fork worker {count}', array('count' => $i));
+            die();
         }
         // Child, start the worker
         else if(!$pid) {
             $queues = explode(',', $QUEUE);
             $worker = new Resque_Worker($queues);
-            $worker->logLevel = $logLevel;
-            fwrite(STDOUT, '*** Starting worker '.$worker."\n");
+            $worker->setLogger($logger);
+            $logger->log(Psr\Log\LogLevel::NOTICE, 'Starting worker {worker}', array('worker' => $worker));
             $worker->work($interval, $BLOCKING);
             break;
         }
@@ -100,15 +107,15 @@ if($count > 1) {
 else {
     $queues = explode(',', $QUEUE);
     $worker = new Resque_Worker($queues);
-    $worker->logLevel = $logLevel;
+    $worker->setLogger($logger);
 
     $PIDFILE = getenv('PIDFILE');
     if ($PIDFILE) {
         file_put_contents($PIDFILE, getmypid()) or
             die('Could not write PID information to ' . $PIDFILE);
     }
 
-    fwrite(STDOUT, '*** Starting worker '.$worker."\n");
+    $logger->log(Psr\Log\LogLevel::NOTICE, 'Starting worker {worker}', array('worker' => $worker));
     $worker->work($interval, $BLOCKING);
 }
 ?>

composer.json

@@ -20,7 +20,8 @@
 	"require": {
 		"php": ">=5.3.0",
 		"ext-pcntl": "*",
-		"colinmollenhour/credis": "1.2.*"
+		"colinmollenhour/credis": "1.2.*",
+		"psr/log": "1.0.0"
 	},
 	"suggest": {
 		"ext-proctitle": "Allows php-resque to rename the title of UNIX processes to show the status of a worker.",

composer.lock

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Resque default logger PSR-3 compliant
+ *
+ * @package		Resque/Stat
+ * @author		Chris Boulton <[email protected]>
+ * @license		http://www.opensource.org/licenses/mit-license.php
+ */
+class Resque_Log extends Psr\Log\AbstractLogger 
+{
+	public $verbose;
+
+	public function __construct($verbose = false) {
+		$this->verbose = $verbose;
+	}
+
+	/**
+	 * Logs with an arbitrary level.
+	 *
+	 * @param mixed   $level    PSR-3 log level constant, or equivalent string
+	 * @param string  $message  Message to log, may contain a { placeholder }
+	 * @param array   $context  Variables to replace { placeholder }
+	 * @return null
+	 */
+	public function log($level, $message, array $context = array())
+	{
+		if ($this->verbose) {
+			fwrite(
+				STDOUT,
+				'[' . $level . '] [' . strftime('%T %Y-%m-%d') . '] ' . $this->interpolate($message, $context) . PHP_EOL
+			);
+			return;
+		}
+
+		if (!($level === Psr\Log\LogLevel::INFO || $level === Psr\Log\LogLevel::DEBUG)) {
+			fwrite(
+				STDOUT,
+				'[' . $level . '] ' . $this->interpolate($message, $context) . PHP_EOL
+			);
+		}
+	}
+
+	/**
+	 * Fill placeholders with the provided context
+	 * @author Jordi Boggiano [email protected]
+	 * 
+	 * @param  string  $message  Message to be logged
+	 * @param  array   $context  Array of variables to use in message
+	 * @return string
+	 */
+	public function interpolate($message, array $context = array())
+	{
+		// build a replacement array with braces around the context keys
+		$replace = array();
+		foreach ($context as $key => $val) {
+			$replace['{' . $key . '}'] = $val;
+		}
+	
+		// interpolate replacement values into the message and return
+		return strtr($message, $replace);
+	}
+}