CFileLogRoute
CFileLogRoute records log messages in files.
The log files are stored under
logPath and the file name is specified by
logFile. If the size of the log file is greater than
maxFileSize (in kilo-bytes), a rotation is performed, which renames the current log file by suffixing the file name with '.1'. All existing log files are moved backwards one place, i.e., '.2' to '.3', '.1' to '.2'. The property
maxLogFiles specifies how many files to be kept. If the property
rotateByCopy is true, the primary log file will be rotated by a copy and truncated (to be more compatible with log tailers) otherwise it will be rotated by being renamed.
Public Properties
Property |
Type |
Description |
Defined By |
categories | mixed | array of categories, or string list separated by comma or space. | CLogRoute |
enabled | boolean | whether to enable this log route. | CLogRoute |
except | mixed | array of categories, or string list separated by comma or space, to EXCLUDE from logs. | CLogRoute |
filter | mixed | the additional filter (eg CLogFilter) that can be applied to the log messages. | CLogRoute |
levels | string | list of levels separated by comma or space. | CLogRoute |
logFile | string | log file name. | CFileLogRoute |
logPath | string | directory storing log files. | CFileLogRoute |
logs | array | the logs that are collected so far by this log route. | CLogRoute |
maxFileSize | integer | maximum log file size in kilo-bytes (KB). | CFileLogRoute |
maxLogFiles | integer | number of files used for rotation. | CFileLogRoute |
rotateByCopy | boolean | Whether to rotate primary log by copy and truncate which is more compatible with log tailers. | CFileLogRoute |
Property Details
public string getLogFile()
public void setLogFile(string $value)
log file name. Defaults to 'application.log'.
public string getLogPath()
public void setLogPath(string $value)
directory storing log files. Defaults to application runtime path.
public integer getMaxFileSize()
public void setMaxFileSize(integer $value)
maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).
public integer getMaxLogFiles()
public void setMaxLogFiles(integer $value)
number of files used for rotation. Defaults to 5.
public boolean $rotateByCopy;
Whether to rotate primary log by copy and truncate which is more compatible with log tailers. Defaults to false.
Method Details
public string getLogFile() |
{return} | string | log file name. Defaults to 'application.log'. |
public string getLogPath() |
{return} | string | directory storing log files. Defaults to application runtime path. |
public integer getMaxFileSize() |
{return} | integer | maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB). |
public integer getMaxLogFiles() |
{return} | integer | number of files used for rotation. Defaults to 5. |
Initializes the route. This method is invoked after the route is created by the route manager.
protected void processLogs(array $logs) |
$logs | array | list of log messages |
Source Code: framework/logging/CFileLogRoute.php#144 (
show)
protected function processLogs($logs)
{
$text='';
foreach($logs as $log)
$text.=$this->formatLogMessage($log[0],$log[1],$log[2],$log[3]);
$logFile=$this->getLogPath().DIRECTORY_SEPARATOR.$this->getLogFile();
$fp=@fopen($logFile,'a');
@flock($fp,LOCK_EX);
if(@filesize($logFile)>$this->getMaxFileSize()*1024)
{
$this->rotateFiles();
@flock($fp,LOCK_UN);
@fclose($fp);
@file_put_contents($logFile,$text,FILE_APPEND|LOCK_EX);
}
else
{
@fwrite($fp,$text);
@flock($fp,LOCK_UN);
@fclose($fp);
}
}
Saves log messages in files.
protected void rotateFiles() |
Source Code: framework/logging/CFileLogRoute.php#171 (
show)
protected function rotateFiles()
{
$file=$this->getLogPath().DIRECTORY_SEPARATOR.$this->getLogFile();
$max=$this->getMaxLogFiles();
for($i=$max;$i>0;--$i)
{
$rotateFile=$file.'.'.$i;
if(is_file($rotateFile))
{
// suppress errors because it's possible multiple processes enter into this section
if($i===$max)
@unlink($rotateFile);
else
@rename($rotateFile,$file.'.'.($i+1));
}
}
if(is_file($file))
{
// suppress errors because it's possible multiple processes enter into this section
if($this->rotateByCopy)
{
@copy($file,$file.'.1');
if($fp=@fopen($file,'a'))
{
@ftruncate($fp,0);
@fclose($fp);
}
}
else
@rename($file,$file.'.1');
}
// clear stat cache after moving files so later file size check is not cached
clearstatcache();
}
Rotates log files.
public void setLogFile(string $value) |
$value | string | log file name |
public void setLogPath(string $value) |
$value | string | directory for storing log files. |
Source Code: framework/logging/CFileLogRoute.php#82 (
show)
public function setLogPath($value)
{
$this->_logPath=realpath($value);
if($this->_logPath===false || !is_dir($this->_logPath) || !is_writable($this->_logPath))
throw new CException(Yii::t('yii','CFileLogRoute.logPath "{path}" does not point to a valid directory. Make sure the directory exists and is writable by the Web server process.',
array('{path}'=>$value)));
}
public void setMaxFileSize(integer $value) |
$value | integer | maximum log file size in kilo-bytes (KB). |
public void setMaxLogFiles(integer $value) |
$value | integer | number of files used for rotation. |