PHP rolling log library
PHP records logs. I have come across a log recording method that divides folders into folders by year and month, and then divides files into files by day. This method has advantages and disadvantages and has its usage scenarios. What I want to talk about today is another way. A logging method - file rolling method to record logs. Of course, this rolling mechanism can also be added to the previous logging method.
How to make the log scroll
Rolling log, as the name suggests, uses a series of log files to record the log of a module. The number of files in the same module is limited, up to maxNum, and the size is also limited, up to maxSize bytes. The file name has a certain naming method, such as : testlog.log, testlog_1.log, testlog_2.log,,,,,, where testlog.log is the log file in use. When the testlog.log file size reaches the limit maxSize, the log file will be rolled backwards, like As follows:
The code is as follows:
When the number of log files reaches the limit maxNum, the elimination mechanism will be started and the oldest log will be deleted. For example, if maxNum is set to 10, there will be a maximum of 10 files including testlog.log at this time. When scrolling If testlog_9.log exists, it will start rolling from testlog_8.log and overwrite testlog_9.log. This ensures normal log recording and does not cause large log files to appear, ensuring the normal operation of the log system.
Code implementation
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
final class LOGS { private $level; private $maxFileNum; private $maxFileSize; private $logPath; private $file;
//日志的级别DEBUG，MSG，ERR const LOGS_DEBUG = 0; const LOGS_MSG = 1; const LOGS_ERR = 2;
private static $instance = null;
private function __construct(){}
public static function getInstance() { if(self::$instance == null) { self::$instance = new self(); } return self::$instance; }
/** * @Desc initialization * @Param $level int record level * @Param $maxNum int Maximum number of log files * @Param $maxSize int Maximum log file size * @Param $logPath string log file saving path * @Param $file string log file name prefix * @Return boolean */ public function init($level, $maxNum, $maxSize, $logPath, $file) { $level = intval($level); $maxNum = intval($maxNum); $maxSize = intval($maxSize); !is_dir($logPath) && mkdir($logPath, 0777, true); if(!in_array($level, array(self::LOGS_DEBUG, self::LOGS_MSG, self::LOGS_ERR)) || $maxNum <= 0 || $maxSize <= 0 || !is_dir($logPath)) { return false; } $this->level = $level; $this->maxFileNum = $maxNum; $this->maxFileSize = $maxSize; $this->logPath = $logPath; $this->file = $file; return true; }
/** * @Desc Get formatted time string */ public function formatTime() { $ustime = explode ( " ", microtime () ); return "[" . date('Y-m-d H:i:s', time()) .".". ($ustime[0] * 1000) . "]"; }
/** * @Desc rolling log file */ public function log($str) { $path = $this->logPath.DIRECTORY_SEPARATOR.$this->file.".log"; clearstatcache(); if(file_exists($path)) { if(filesize($path) >= $this->maxFileSize) { $index = 1; //获取最大的滚动日志数目 for(;$index < $this->maxFileNum; $index ) { if(!file_exists($this->logPath.DIRECTORY_SEPARATOR.$this->file."_".$index.".log")) { break; } } //已经存在maxFileNum个日志文件了 if($index == $this->maxFileNum) { $index--; } //滚动日志 for(;$index > 1; $index--) { $new = $this->logPath.DIRECTORY_SEPARATOR.$this->file."_".$index.".log"; $old = $this->logPath.DIRECTORY_SEPARATOR.$this->file."_".($index - 1).".log"; rename($old, $new); }
$newFile = $this->logPath.DIRECTORY_SEPARATOR.$this->file."_1.log"; rename($path, $newFile); } } $fp = fopen($path, "a b"); fwrite($fp, $str, strlen($str)); fclose($fp); return true; }
/** * @Desc records debugging information * @Param string log information * @Param string The file where the log is located * @Param string log line */ public function debug($msg, $file, $line) { if($this->level <= self::LOGS_DEBUG) { $this->log($this->formatTime()."[{$file}:{$line}]DEBUG: ${msg}n"); } }
/** * @Desc record information * @Param string log information * @Param string The file where the log is located * @Param string log line */ public function msg($msg, $file, $line) { if($this->level <= self::LOGS_MSG) { $this->log($this->formatTime()."[{$file}:{$line}]MSG: ${msg}n"); } }
/** * @Desc logs error messages * @Param string log information * @Param string The file where the log is located * @Param string log line */ public function err($msg, $file, $line) { if($this->level <= self::LOGS_ERR) { $this->log($this->formatTime()."[{$file}:{$line}]ERR: ${msg}n"); } } } |
看个例子
#例子中设置记录级别为msg（此时debug信息是不会纪录的），日志文件个数为5，大小为200个字节（测试方便），文件名称为testlog
3 4
5
$logs = LOGS::getInstance();
$logs->init(1, 5, 200, "./", 'testlog'); |
当我们不停的运行这个例子的时候，会在代码所在文件夹下生成5个文件就像下面这样：
|
![[Web front-end] Node.js quick start](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
