|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
coldbox.system.plugin
coldbox.system.plugins.logger
public class logger
This is the frameworks logger object. It is used for all logging facilities.
Constructor Summary | |
---|---|
init(any controller)
Constructor |
Method Summary | |
---|---|
private void |
checkRotation()
Checks the log file size. If greater than framework's settings, then zip and rotate. |
private void |
createDefaultLogDirectory()
Creates the default log directory. |
void |
debug(string Message, [string ExtraInfo=''])
I log a debug message. |
private void |
emailBugReport(string bugReport)
Email a bug report |
void |
ensureLogLocations()
Ensure log locations are set in instance correctly |
void |
error(string Message, [string ExtraInfo=''])
I log an error message. |
void |
fatal(string Message, [string ExtraInfo=''])
I log a fatal message. |
private string |
formatLogEntry(string Severity, string Message, [string ExtraInfo=''])
Format a log request into the specified entry format. |
string |
getLogFileName()
Get the logfilename |
string |
getlogFullPath()
Get the logFullPath |
numeric |
getlogLevel()
Get the current set logLevel (between 0-4) |
struct |
getlogLevels()
Get the logLevels structure |
string |
getvalidSeverities()
Get the validSeverities |
void |
info(string Message, [string ExtraInfo=''])
I log an information message. |
void |
initLogLocation()
Initialize the ColdBox log location. |
boolean |
isLoggerInitialized()
Checks if the logger's internal variables are initialized. |
void |
logEntry(string Severity, string Message, [string ExtraInfo=''])
Log a message to the Coldfusion/Coldbox Logging Facilities if enabled via the config |
void |
logError(string Message, [any ExceptionStruct='[runtime expression]'], [any ExtraInfo=''])
Log an error into the framework using arguments. Facade to logErrorWithBean. |
void |
logErrorWithBean(any ExceptionBean)
Log an error into the framework using a coldbox exceptionBean |
void |
removeLogFile([boolean reinitializeFlag='true'])
Removes the log file |
void |
setLogFileName(string filename)
Set the logfilename |
void |
setisLoggerInitialized(boolean isLoggerInitialized)
Set's the logger's internal variables flag to initalized. |
void |
setlogFullPath(string logFullPath)
Set the logFullPath |
void |
setlogLevel(numeric logLevel)
Set the logger's logLevel (0-4), else it ignores setting. |
private void |
setupLogLocationVariables()
Setup the log location variables. |
void |
tracer(string message, [any ExtraInfo=''])
Log a trace message to the debugger panel |
void |
warn(string Message, [string ExtraInfo=''])
I log a warning message. |
Methods inherited from class coldbox.system.plugin |
---|
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller)
Method Detail |
---|
private void checkRotation()
private void createDefaultLogDirectory()
public void debug(string Message, [string ExtraInfo=''])
Message
- The message to log.ExtraInfo
- Extra information to append.private void emailBugReport(string bugReport)
bugReport
- The bug reportpublic void ensureLogLocations()
public void error(string Message, [string ExtraInfo=''])
Message
- The message to log.ExtraInfo
- Extra information to append.public void fatal(string Message, [string ExtraInfo=''])
Message
- The message to log.ExtraInfo
- Extra information to append.private string formatLogEntry(string Severity, string Message, [string ExtraInfo=''])
Severity
- error|warning|infoMessage
- The message to log.ExtraInfo
- Extra information to append.public string getLogFileName()
public string getlogFullPath()
public numeric getlogLevel()
public struct getlogLevels()
public string getvalidSeverities()
public void info(string Message, [string ExtraInfo=''])
Message
- The message to log.ExtraInfo
- Extra information to append.public void initLogLocation()
public boolean isLoggerInitialized()
public void logEntry(string Severity, string Message, [string ExtraInfo=''])
Severity
- information,debug,warning,error,fatalMessage
- The message to log.ExtraInfo
- Extra information to append.public void logError(string Message, [any ExceptionStruct='[runtime expression]'], [any ExtraInfo=''])
Message
ExceptionStruct
- The CF cfcatch structure.ExtraInfo
public void logErrorWithBean(any ExceptionBean)
ExceptionBean
- This is the exception beanpublic void removeLogFile([boolean reinitializeFlag='true'])
reinitializeFlag
- Flag to reinitialize the log location or not.public void setLogFileName(string filename)
filename
- The filename to setpublic void setisLoggerInitialized(boolean isLoggerInitialized)
isLoggerInitialized
public void setlogFullPath(string logFullPath)
logFullPath
- The logFullPath to setpublic void setlogLevel(numeric logLevel)
logLevel
private void setupLogLocationVariables()
Public void tracer(string message, [any ExtraInfo=''])
message
- Message to SendExtraInfo
- Extra Information to dump on the tracepublic void warn(string Message, [string ExtraInfo=''])
Message
- The message to log.ExtraInfo
- Extra information to append.
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |