logbox.system.logging.appenders

Class RollingFileAppender

lucee.Component
    extended by logbox.system.logging.AbstractAppender
      extended by logbox.system.logging.appenders.FileAppender
        extended by logbox.system.logging.appenders.RollingFileAppender

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- A RollingFileAppender. This appenders rotates the log files according to the properties defined. Properties: - filepath : The location of where to store the log file. - autoExpand : Whether to expand the file path or not. Defaults to true. - filename : The name of the file, if not defined, then it will use the name of this appender. Do not append an extension to it. We will append a .log to it. - fileEncoding : The file encoding to use, by default we use UTF-8; - fileMaxSize : The max file size for log files. Defaults to 2000 (2 MB) - fileMaxArchives : The max number of archives to keep. Defaults to 2.

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Constructor Summary
    init(any name, [struct properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])
          Constructor.
    Method Summary
    any logMessage(LogEvent logEvent)
         Write an entry into the appender.
     
    Methods inherited from class logbox.system.logging.appenders.FileAppender
    append, ensureDefaultLogDirectory, getLockName, getLockTimeout, getLogFullpath, getLogListener, initLogLocation, onRegistration, removeLogFile, setLockName, setLockTimeout, setLogFullpath, setLogListener, startLogListener
     
    Methods inherited from class logbox.system.logging.AbstractAppender
    $log, canLog, getColdbox, getCustomLayout, getHash, getInitialized, getLevelMax, getLevelMin, getName, getProperties, getProperty, getUtil, hasCustomLayout, isInitialized, onUnRegistration, out, propertyExists, setColdbox, setCustomLayout, setInitialized, setLevelMax, setLevelMin, setName, setProperties, setProperty, severityToString
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any name, [struct properties='[runtime expression]'], [any layout=''], [any levelMin='0'], [any levelMax='4'])

    Constructor

    Parameters:
    name - The unique name for this appender.
    properties - A map of configuration properties for the appender"
    layout - The layout class to use in this appender for custom message rendering.
    levelMin - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN
    levelMax - The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARN
    Method Detail

    logMessage

    public any logMessage(LogEvent logEvent)

    Write an entry into the appender. You must implement this method yourself.

    Overrides:
    logMessage in class FileAppender
    Parameters:
    logEvent - The logging event to log