Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Info Please remember to set the
autoExpandproperty to FALSE if you will be using an absolute file path location.
Property
Type
Required
Default
Description
filePath
string
true
---
The location of where to store the log file
filename
string
false
Name of the Appender
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
string
false
utf-8
The file encoding to use, by default we use UTF-8
autoExpand
boolean
false
true
Whether to expand the file path or not. Defaults to true
This appender logs using Java's System.out.println function. Logs will appear in the directory specificied in your CF or Lucee Administrator.
This appender logs directly to the cflog tag by using a custom file or logging to the application logs.
Property
The ConsoleAppender takes no additional properties.
Property
Type
Required
Default
Description
logType
string(file or application)
false
file
The type of cflog to use: file or application.
fileName
string
false
Appender's name
The name of the file to log to if using file as the logType. If not set, it will use the appender's name
The columns needed or created in the table are
id : UUID
severity : string
category : string
logdate : timestamp
appendername : string
message : string
extrainfo : string
If you are building a column mapper, the map must have the above keys in it that match to your own table columns.
Property
Type
Required
Default
Description
dsn
string
true
---
The dsn to use for logging
table
string
true
---
The table name to use for logging
columnMap
struct
false
---
A column map for aliasing columns. (Optional)
autocreate
boolean
false
false
if true, then we will create the table. Defaults to false (Optional)
Property
Type
Required
Default
Description
subject
string
true
---
Get's pre-pended with the severity and category field.
from
string
true
---
The from email address
to
string
true
---
The to email(s)
cc
string
false
empty
The cc email(s)
bcc
string
false
empty
The bcc email(s)
mailserver
string
false
empty
The optional mail server
mailusername
string
false
empty
The optional mail username
mailpassword
string
false
empty
The optional mail password
mailport
int
false
25
The optional mail port
useTLS
boolean
false
false
Use the Transport level security setting in the cfmail tag.
useSSL
boolean
false
false
Use SSL or not
As we mentioned before, LogBox ships with over 10 different appenders for your logging and tracing needs. Some of them require configuration properties and some don't. We already discovered that when we configure an appender we can pass in a structure of properties much like how we configure ColdBox Interceptors. Each appender can implement as many properties as they see fit. We will digest all the included LogBox appenders and their configuration properties.
All appenders have an async boolean property by default inherited from LogBox. This will tell LogBox to log asynchronously in a separate thread. By default all logging is done synchronously
Property
Type
Requierd
Default
Description
host
string
true
The host to connect to
port
string
true
---
The port to connect to
timeout
numeric
false
5
the timeout in seconds. defaults to 5 seconds
persistConnection
boolean
false
true
Whether to persist the connection or create a new one every log time. Defaults to true
Property
Type
Required
Default
Description
scope
string
false
request
The scope to persist to, any valid CF scope.
key
string
false
appender's name
The key to use in the scope
limit
numeric
false
0
a limit to the amount of logs to rotate. Defaults to 0, unlimited (optional)
This appender directs messages via the cftrace tag. It has no configuration properties.
Info Please remember to set the
autoExpandproperty to FALSE if you will be using an absolute file path location.
Property
Type
Required
Default
Description
filePath
string
true
---
The location of where to store the log file
filename
string
false
Name of the Appender
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
string
false
utf-8
The file encoding to use, by default we use UTF-8
autoExpand
boolean
false
true
Whether to expand the file path or not. Defaults to true
fileMaxSize
int
false
2000 (2MB)
The max file size for log files. Defaults to 2000 (2 MB)
fileMaxArchives
int
false
2
The max number of archives to keep. Defaults to 2