Show Table of Contents
14.6.6. Size Log Handler Properties
Table 14.12. Size Log Handler Properties
| Property | Datatype | Description |
|---|---|---|
| append | Boolean |
If set to true then all messages written by this handler will be appended to the file if it already exists. If set to false a new file will be created each time the application server launches. Changes to append require a server reboot to take effect.
|
| autoflush | Boolean |
If set to true the log messages will be sent to the handlers assigned file immediately upon receipt. Changes to append require a server reboot to take effect.
|
| encoding | String |
The character encoding scheme to be used for the output.
|
| formatter | String |
The log formatter used by this log handler.
|
| level | String |
The maximum level of log message the log handler records.
|
| name | String |
The unique identifier for this log handler.
|
| file | Object |
Object that represents the file where the output of this log handler is written to. It has two configuration properties,
relative-to and path.
|
| relative-to | String |
This is a property of the file object and is the directory where the log file is written to. File path variables can be specified here. The
jboss.server.log.dir variable points to the log/ directory of the server.
|
| path | String |
This is a property of the file object and is the name of the file where the log messages will be written. It is a relative path name that is appended to the value of the
relative-to property to determine the complete path.
|
| rotate-size | Integer |
The maximum size that the log file can reach before it is rotated. A single character appended to the number indicates the size units:
b for bytes, k for kilobytes, m for megabytes, g for gigabytes. Eg. 50m for 50 megabytes.
|
| max-backup-index | Integer |
The maximum number of rotated logs that are kept. When this number is reached, the oldest log is reused.
|
| enabled | Boolean |
If set to
true, the handler is enabled and functioning as normal. If set to false, the handler is ignored when processing log messages.
|
| filter-spec | String |
An expression value that defines a filter. The following expression defines a filter that does not match a pattern:
not(match("JBAS.*"))
|
| rotate-on-boot | Boolean |
If set to
true, a new log file will be created on server restart. Default is false.
|
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.