0 follower

CFileLogRoute

Package system.logging
Inheritance class CFileLogRoute » CLogRoute » CComponent
Since 1.0
Source Code framework/logging/CFileLogRoute.php
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

Hide inherited properties

PropertyTypeDescriptionDefined 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

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. CComponent
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
collectLogs() Retrieves filtered log messages from logger for further processing. CLogRoute
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
evaluateExpression() Evaluates a PHP expression or callback under the context of this component. CComponent
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getLogFile() Returns log file name. Defaults to 'application.log'. CFileLogRoute
getLogPath() Returns directory storing log files. Defaults to application runtime path. CFileLogRoute
getMaxFileSize() Returns maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB). CFileLogRoute
getMaxLogFiles() Returns number of files used for rotation. Defaults to 5. CFileLogRoute
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
init() Initializes the route. CFileLogRoute
raiseEvent() Raises an event. CComponent
setLogFile() Sets log file name CFileLogRoute
setLogPath() Sets directory for storing log files. CFileLogRoute
setMaxFileSize() Sets maximum log file size in kilo-bytes (KB). CFileLogRoute
setMaxLogFiles() Sets number of files used for rotation. CFileLogRoute

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
formatLogMessage() Formats a log message given different fields. CLogRoute
processLogs() Saves log messages in files. CFileLogRoute
rotateFiles() Rotates log files. CFileLogRoute

Property Details

logFile property
public string getLogFile()
public void setLogFile(string $value)

log file name. Defaults to 'application.log'.

logPath property
public string getLogPath()
public void setLogPath(string $value)

directory storing log files. Defaults to application runtime path.

maxFileSize property
public integer getMaxFileSize()
public void setMaxFileSize(integer $value)

maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).

maxLogFiles property
public integer getMaxLogFiles()
public void setMaxLogFiles(integer $value)

number of files used for rotation. Defaults to 5.

rotateByCopy property (available since v1.1.14)
public boolean $rotateByCopy;

Whether to rotate primary log by copy and truncate which is more compatible with log tailers. Defaults to false.

Method Details

getLogFile() method
public string getLogFile()
{return} string log file name. Defaults to 'application.log'.
Source Code: framework/logging/CFileLogRoute.php#93 (show)
public function getLogFile()
{
    return $this->_logFile;
}

getLogPath() method
public string getLogPath()
{return} string directory storing log files. Defaults to application runtime path.
Source Code: framework/logging/CFileLogRoute.php#73 (show)
public function getLogPath()
{
    return $this->_logPath;
}

getMaxFileSize() method
public integer getMaxFileSize()
{return} integer maximum log file size in kilo-bytes (KB). Defaults to 1024 (1MB).
Source Code: framework/logging/CFileLogRoute.php#109 (show)
public function getMaxFileSize()
{
    return $this->_maxFileSize;
}

getMaxLogFiles() method
public integer getMaxLogFiles()
{return} integer number of files used for rotation. Defaults to 5.
Source Code: framework/logging/CFileLogRoute.php#126 (show)
public function getMaxLogFiles()
{
    return $this->_maxLogFiles;
}

init() method
public void init()
Source Code: framework/logging/CFileLogRoute.php#63 (show)
public function init()
{
    parent::init();
    if($this->getLogPath()===null)
        $this->setLogPath(Yii::app()->getRuntimePath());
}

Initializes the route. This method is invoked after the route is created by the route manager.

processLogs() method
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.

rotateFiles() method
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.

setLogFile() method
public void setLogFile(string $value)
$value string log file name
Source Code: framework/logging/CFileLogRoute.php#101 (show)
public function setLogFile($value)
{
    $this->_logFile=$value;
}

setLogPath() method
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)));
}

setMaxFileSize() method
public void setMaxFileSize(integer $value)
$value integer maximum log file size in kilo-bytes (KB).
Source Code: framework/logging/CFileLogRoute.php#117 (show)
public function setMaxFileSize($value)
{
    if(($this->_maxFileSize=(int)$value)<1)
        $this->_maxFileSize=1;
}

setMaxLogFiles() method
public void setMaxLogFiles(integer $value)
$value integer number of files used for rotation.
Source Code: framework/logging/CFileLogRoute.php#134 (show)
public function setMaxLogFiles($value)
{
    if(($this->_maxLogFiles=(int)$value)<1)
        $this->_maxLogFiles=1;
}