wrapper.logfile Property

Index

wrapper.logfile property

Log File Name generated by Tokens

wrapper.logfile.group property
wrapper.logfile.umask property

wrapper.logfile

Compatibility :	1.0.0
Editions :
Platforms :

Sets the path to the log file where all output from the Wrapper and from the Java Application will be logged.

Example ("wrapper.log"):

wrapper.logfile=../logs/wrapper.log

For further information about "rolling mode of log file", "output format of log file", and "log level of log file", please review the description of each property.

Default:

If this property is absent, or if the Wrapper is unable to write at the specified location (e.g because of a permission issue), then the messages will be logged to a default log file named "wrapper.log" in the working directory. Failing that, output to the log file will be disabled and logging will only continue in the console, syslog or EventLog.

Starting from version 3.5.30, the Wrapper has the ability to resume logging into the log file when it becomes available again.

The following diagram represents the fall back and resume mechanisms:

Logging Disable:

Setting the property to a blank value will cause file logging to be disabled.

Property Example:

wrapper.logfile=

NOTE

In versions 3.5.31 to 3.5.34, the Wrapper contains a bug which causes to use the default log file instead of disabling file logging when a blank value is specified. A better practice to disable output to the log file, and which works with all versions of the Wrapper above 2.2.5, is to set wrapper.logfile.loglevel to NONE.

Log File Name generated by Tokens:

The specified log file name may be able to contain one or both of the tokens; ROLLNUM and YYYYMMDD.

"ROLLNUM" Token:

The ROLLNUM token is used when the log file is rolled. If the format is "wrapper.log.ROLLNUM", the "ROLLNUM" token is replaced with an integer, and then the roll numbers will be appended to the end of the file name "wrapper.log".

The larger roll number values, the older files. The most recent rolled log file will always have a roll number of "1", which is "wrapper.log.1". The second recent one will be "wrapper.log.2".

While wrapper.logfile.rollmode property has a rolling mode, if a ROLLNUM token is not included in the specified log file, ".ROLLNUM" will be appended at the end by default.

Examples with ROLLNUM token:

wrapper.logfile=../logs/wrapper.log.ROLLNUM
wrapper.logfile=../logs/wrapper-ROLLNUM.log

"YYYYMMDD" Token:

The YYYYMMDD token is required when the wrapper.logfile.rollmode property has a value of DATE. The "YYYYMMDD" token will be replaced by the date of the log entries contained in the file.

Examples with YYYYMMDD token:

wrapper.logfile=../logs/wrapper.YYYYMMDD.log
wrapper.logfile=../logs/wrapper-YYYYMMDD.log
wrapper.logfile=../logs/wrapper_YYYYMMDD.log

Token Strip:

Whenever either token does not apply to a given file name format, it will be stripped from the generated file name. When a token part is stripped, the preceding character will also be stripped if it is a ".", "-", or "_".

wrapper.logfile.group

Compatibility :	3.5.38
Editions :
Platforms :

You can set "group" for this file. See the wrapper.*.group property.

Example:

wrapper.logfile.group=jenkins

wrapper.logfile.umask

Compatibility :	3.2.0
Editions :
Platforms :

You can set "umask" on this file. See the wrapper.*.umask property.

Example:

wrapper.logfile.umask=0022

Reference: logfile

wrapper.log.lf_delay.threshold (3.5.10)
Sets a threshold to split JVM messages that would be too long to be printed at once.
wrapper.log.warning.threshold (3.5.8)
Prints a warning when a log entry takes longer to be printed than the specified number of seconds.
wrapper.logfile (1.0.0)
Sets the path to the Wrapper log file.
wrapper.logfile.close.timeout (3.5.21)
Controls the number of seconds at which the log file should close after the last log entry.
wrapper.logfile.flush.timeout (3.5.21)
Configures the interval in seconds at which the Wrapper flushes all outputs to the log file.
wrapper.logfile.format (2.2.5)
Configures the format of the outputs sent to the log file.
wrapper.logfile.inactivity.timeout (3.2.0)
Controls the number of seconds at which the log file should close after the last log entry.
wrapper.logfile.loglevel (2.2.5)
Filters messages sent to the log file according to their log levels.
wrapper.logfile.maxfiles (2.2.5)
Controls the maximum number of rolled files.
wrapper.logfile.maxsize (2.2.5)
Controls the maximum size of rolled files.
wrapper.logfile.purge.pattern (3.3.8)
Controls the file pattern to purge old log files.
wrapper.logfile.purge.sort (3.3.8)
Configures the sorting mode of the rolled files to purge the last ones.
wrapper.logfile.rollmode (3.2.0)
Sets the roll mode of the log file.

wrapper.logfile.group (3.5.38)
Specifies the group to assign when creating the log file.
wrapper.logfile.umask (3.2.0)
Specifies the umask to use when creating the log file.

Configuration Properties:

Debugging:

Help Pages:

Currently logged on:

Customers