logger
Defines a logger category.
| Name | Type | Default | Description |
|---|---|---|---|
| use-parent-handlers | boolean | true | |
| category | string |
Defines the root logger for this log context.
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
handlers?
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
root-logger
Defines the root logger for this log context.
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
handlers?
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
console-handler
Defines a handler which writes to the console.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
target?
| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| name |
|
file-handler
Defines a handler which writes to a file.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
periodic-rotating-file-handler
Defines a handler which writes to a file, rotating the log after a time period derived from the given
suffix string, which should be in a format understood by java.text.SimpleDateFormat.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
suffix
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
periodic-size-rotating-file-handler
Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a
certain point or the time period derived from the given suffix string and keeping a fixed number of
backups. The suffix should be in a format understood by java.text.SimpleDateFormat.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true | |
| rotate-on-boot | boolean | false |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
rotate-size?
| Name | Type | Default | Description |
|---|---|---|---|
| value |
max-backup-index?
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
suffix
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
size-rotating-file-handler
Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a
certain point and keeping a fixed number of backups.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true | |
| rotate-on-boot | boolean | false |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
rotate-size?
| Name | Type | Default | Description |
|---|---|---|---|
| value |
max-backup-index?
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
suffix?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
socket-handler
Defines a handler which writes to a socket.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| block-on-reconnect | boolean | false | |
| name | string | ||
| enabled | boolean | true | |
| outbound-socket-binding-ref | string | ||
| ssl-context | string |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
protocol?
| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
async-handler
Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which
introduce a substantial amount of lag.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
queue-length
| Name | Type | Default | Description |
|---|---|---|---|
| value |
overflow-action?
| Name | Type | Default | Description | ||||
|---|---|---|---|---|---|---|---|
| value |
|
subhandlers
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
custom-handler
Defines a custom handler.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| module | string | ||
| class | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
syslog-handler
Defines a syslog handler for UNIX/Linux based operating systems.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
server-address?
The address of the syslog server. The default is localhost.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
hostname?
The name of the host the messages are being sent from. For example the name of the host the application server is running on.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
port?
The port the syslog server is listening on. The default is 514.
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
app-name?
The app name used when formatting the message in RFC5424 format. By default the app name is "java"
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
syslog-format
Formats the log message according to the RFC specification.
| Name | Type | Default | Description | ||||
|---|---|---|---|---|---|---|---|
| syslog-type |
|
named-formatter?
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
facility?
Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164
(http://tools.ietf.org/html/rfc3164).
| Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| value |
|
formatter
A formatter that can be assigned to a handler.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
The color-map attribute allows for a comma delimited list of colors to be used for different levels. The
format is level-name:color-name.
Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest
Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred,
brightgreen,
brightblue, brightyellow, brightmagenta, brightcyan, brightwhite
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string | The format pattern as defined in org.jboss.logmanager.formatters.FormatStringParser. | |
| color-map | string | The color-map attribute allows for a comma delimited list of colors to be used for different levels. The format is level-name:color-name. Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite |
custom-formatter
Defines a formatter to be used to format log messages.
Note that most log records are formatted in the printf format. Formatters may require invocation of org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.
| Name | Type | Default | Description |
|---|---|---|---|
| module | string | ||
| class | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
json-formatter
Defines a JSON formatter to be used to format log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| date-format | string | The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. | |
| pretty-print | boolean | false | Indicates whether or not pretty printing should be used when formatting. |
| print-details | boolean | false | Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number. |
| zone-id | string | The zone ID for formatting the date and time. The system default is used if left undefined. |
exception-output-type?
Indicates how the cause of the logged message, if one is available, will be added to the output.
Set the output type for exceptions. The default is detailed.| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
record-delimiter?
The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
key-overrides?
Allows the names of the keys or elements for the properties to be overridden.
| Name | Type | Default | Description |
|---|---|---|---|
| exception | string | ||
| exception-caused-by | string | ||
| exception-circular-reference | string | ||
| exception-frame | string | ||
| exception-frame-class | string | ||
| exception-frame-line | string | ||
| exception-frame-method | string | ||
| exception-frames | string | ||
| exception-message | string | ||
| exception-reference-id | string | ||
| exception-suppressed | string | ||
| exception-type | string | ||
| host-name | string | ||
| level | string | ||
| logger-class-name | string | ||
| logger-name | string | ||
| mdc | string | ||
| message | string | ||
| ndc | string | ||
| process-id | string | ||
| process-name | string | ||
| record | string | ||
| sequence | string | ||
| source-class-name | string | ||
| source-file-name | string | ||
| source-line-number | string | ||
| source-method-name | string | ||
| source-module-name | string | ||
| source-module-version | string | ||
| stack-trace | string | ||
| thread-id | string | ||
| thread-name | string | ||
| timestamp | string |
meta-data?
Sets the meta data to use in the structured format. Properties will be added to each log message.
A collection of free-form properties.property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
xml-formatter
Defines a XML formatter to be used to format log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| namespace-uri | string | Allows the namespace to be overridden. If not defined a default will be used. | |
| print-namespace | boolean | false | Indicates whether or no the namespace should be added to each record element. |
| Name | Type | Default | Description |
|---|---|---|---|
| date-format | string | The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. | |
| pretty-print | boolean | false | Indicates whether or not pretty printing should be used when formatting. |
| print-details | boolean | false | Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number. |
| zone-id | string | The zone ID for formatting the date and time. The system default is used if left undefined. |
exception-output-type?
Indicates how the cause of the logged message, if one is available, will be added to the output.
Set the output type for exceptions. The default is detailed.| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
record-delimiter?
The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
key-overrides?
Allows the names of the keys or elements for the properties to be overridden.
| Name | Type | Default | Description |
|---|---|---|---|
| exception | string | ||
| exception-caused-by | string | ||
| exception-circular-reference | string | ||
| exception-frame | string | ||
| exception-frame-class | string | ||
| exception-frame-line | string | ||
| exception-frame-method | string | ||
| exception-frames | string | ||
| exception-message | string | ||
| exception-reference-id | string | ||
| exception-suppressed | string | ||
| exception-type | string | ||
| host-name | string | ||
| level | string | ||
| logger-class-name | string | ||
| logger-name | string | ||
| mdc | string | ||
| message | string | ||
| ndc | string | ||
| process-id | string | ||
| process-name | string | ||
| record | string | ||
| sequence | string | ||
| source-class-name | string | ||
| source-file-name | string | ||
| source-line-number | string | ||
| source-method-name | string | ||
| source-module-name | string | ||
| source-module-version | string | ||
| stack-trace | string | ||
| thread-id | string | ||
| thread-name | string | ||
| timestamp | string |
meta-data?
Sets the meta data to use in the structured format. Properties will be added to each log message.
A collection of free-form properties.property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
filter
Defines a filter to be used to filter log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| module | string | ||
| class | string | ||
| name | string |
constructor-properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
add-logging-api-dependencies
Determines whether or not the default logging dependencies should be added to deployments during the deployment process.
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true |
use-deployment-logging-config
Determines whether or not deployments should be scanned for configuration files. If set to true and a configuration file is found the log manager will be configured based on the configuration file.
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean | true |
logging-profiles?
Contains a list of profiles available for use in deployments
logging-profile*
A logging profile that can be used in a deployment for a custom logging configuration.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
logger
Defines a logger category.
| Name | Type | Default | Description |
|---|---|---|---|
| use-parent-handlers | boolean | true | |
| category | string |
Defines the root logger for this log context.
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
handlers?
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
root-logger
Defines the root logger for this log context.
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
handlers?
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
console-handler
Defines a handler which writes to the console.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
target?
| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| name |
|
file-handler
Defines a handler which writes to a file.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
periodic-rotating-file-handler
Defines a handler which writes to a file, rotating the log after a time period derived from the given
suffix string, which should be in a format understood by java.text.SimpleDateFormat.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
suffix
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
periodic-size-rotating-file-handler
Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a
certain point or the time period derived from the given suffix string and keeping a fixed number of
backups. The suffix should be in a format understood by java.text.SimpleDateFormat.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true | |
| rotate-on-boot | boolean | false |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
rotate-size?
| Name | Type | Default | Description |
|---|---|---|---|
| value |
max-backup-index?
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
suffix
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
size-rotating-file-handler
Defines a handler which writes to a file, rotating the log after the size of the file grows beyond a
certain point and keeping a fixed number of backups.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| name | string | ||
| enabled | boolean | true | |
| rotate-on-boot | boolean | false |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
file
| Name | Type | Default | Description |
|---|---|---|---|
| relative-to | string | ||
| path | string |
rotate-size?
| Name | Type | Default | Description |
|---|---|---|---|
| value |
max-backup-index?
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
suffix?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
append?
| Name | Type | Default | Description |
|---|---|---|---|
| value | boolean |
socket-handler
Defines a handler which writes to a socket.
| Name | Type | Default | Description |
|---|---|---|---|
| autoflush | boolean | true | |
| block-on-reconnect | boolean | false | |
| name | string | ||
| enabled | boolean | true | |
| outbound-socket-binding-ref | string | ||
| ssl-context | string |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
protocol?
| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
async-handler
Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which
introduce a substantial amount of lag.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
queue-length
| Name | Type | Default | Description |
|---|---|---|---|
| value |
overflow-action?
| Name | Type | Default | Description | ||||
|---|---|---|---|---|---|---|---|
| value |
|
subhandlers
A collection of handlers to apply to the enclosing object.
handler
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
custom-handler
Defines a custom handler.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| module | string | ||
| class | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
encoding?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
filter-spec?
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string |
named-formatter
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
syslog-handler
Defines a syslog handler for UNIX/Linux based operating systems.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| enabled | boolean | true |
level?
A named reference to another object.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
server-address?
The address of the syslog server. The default is localhost.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
hostname?
The name of the host the messages are being sent from. For example the name of the host the application server is running on.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
port?
The port the syslog server is listening on. The default is 514.
| Name | Type | Default | Description |
|---|---|---|---|
| value | positiveInteger |
app-name?
The app name used when formatting the message in RFC5424 format. By default the app name is "java"
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
formatter?
Defines a formatter.
syslog-format
Formats the log message according to the RFC specification.
| Name | Type | Default | Description | ||||
|---|---|---|---|---|---|---|---|
| syslog-type |
|
named-formatter?
The name of a defined formatter that will be used to format the log message.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
facility?
Facility as defined by RFC-5424 (http://tools.ietf.org/html/rfc5424)and RFC-3164
(http://tools.ietf.org/html/rfc3164).
| Name | Type | Default | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| value |
|
formatter
A formatter that can be assigned to a handler.
| Name | Type | Default | Description |
|---|---|---|---|
| name | string |
pattern-formatter
Defines a pattern formatter. See the documentation for
org.jboss.logmanager.formatters.FormatStringParser
for more information about the format string.
The color-map attribute allows for a comma delimited list of colors to be used for different levels. The
format is level-name:color-name.
Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest
Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred,
brightgreen,
brightblue, brightyellow, brightmagenta, brightcyan, brightwhite
| Name | Type | Default | Description |
|---|---|---|---|
| pattern | string | The format pattern as defined in org.jboss.logmanager.formatters.FormatStringParser. | |
| color-map | string | The color-map attribute allows for a comma delimited list of colors to be used for different levels. The format is level-name:color-name. Valid Levels; severe, fatal, error, warn, warning, info, debug, trace, config, fine, finer, finest Valid Colors; black, green, red, yellow, blue, magenta, cyan, white, brightblack, brightred, brightgreen, brightblue, brightyellow, brightmagenta, brightcyan, brightwhite |
custom-formatter
Defines a formatter to be used to format log messages.
Note that most log records are formatted in the printf format. Formatters may require invocation of org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.
| Name | Type | Default | Description |
|---|---|---|---|
| module | string | ||
| class | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
json-formatter
Defines a JSON formatter to be used to format log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| date-format | string | The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. | |
| pretty-print | boolean | false | Indicates whether or not pretty printing should be used when formatting. |
| print-details | boolean | false | Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number. |
| zone-id | string | The zone ID for formatting the date and time. The system default is used if left undefined. |
exception-output-type?
Indicates how the cause of the logged message, if one is available, will be added to the output.
Set the output type for exceptions. The default is detailed.| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
record-delimiter?
The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
key-overrides?
Allows the names of the keys or elements for the properties to be overridden.
| Name | Type | Default | Description |
|---|---|---|---|
| exception | string | ||
| exception-caused-by | string | ||
| exception-circular-reference | string | ||
| exception-frame | string | ||
| exception-frame-class | string | ||
| exception-frame-line | string | ||
| exception-frame-method | string | ||
| exception-frames | string | ||
| exception-message | string | ||
| exception-reference-id | string | ||
| exception-suppressed | string | ||
| exception-type | string | ||
| host-name | string | ||
| level | string | ||
| logger-class-name | string | ||
| logger-name | string | ||
| mdc | string | ||
| message | string | ||
| ndc | string | ||
| process-id | string | ||
| process-name | string | ||
| record | string | ||
| sequence | string | ||
| source-class-name | string | ||
| source-file-name | string | ||
| source-line-number | string | ||
| source-method-name | string | ||
| source-module-name | string | ||
| source-module-version | string | ||
| stack-trace | string | ||
| thread-id | string | ||
| thread-name | string | ||
| timestamp | string |
meta-data?
Sets the meta data to use in the structured format. Properties will be added to each log message.
A collection of free-form properties.property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
xml-formatter
Defines a XML formatter to be used to format log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| namespace-uri | string | Allows the namespace to be overridden. If not defined a default will be used. | |
| print-namespace | boolean | false | Indicates whether or no the namespace should be added to each record element. |
| Name | Type | Default | Description |
|---|---|---|---|
| date-format | string | The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. | |
| pretty-print | boolean | false | Indicates whether or not pretty printing should be used when formatting. |
| print-details | boolean | false | Sets whether or not details should be printed. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name and source line number. |
| zone-id | string | The zone ID for formatting the date and time. The system default is used if left undefined. |
exception-output-type?
Indicates how the cause of the logged message, if one is available, will be added to the output.
Set the output type for exceptions. The default is detailed.| Name | Type | Default | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
| value |
|
record-delimiter?
The value to be used to indicate the end of a record. If set to null no delimiter will be used at the end of the record. The default value is a line feed.
| Name | Type | Default | Description |
|---|---|---|---|
| value | string |
key-overrides?
Allows the names of the keys or elements for the properties to be overridden.
| Name | Type | Default | Description |
|---|---|---|---|
| exception | string | ||
| exception-caused-by | string | ||
| exception-circular-reference | string | ||
| exception-frame | string | ||
| exception-frame-class | string | ||
| exception-frame-line | string | ||
| exception-frame-method | string | ||
| exception-frames | string | ||
| exception-message | string | ||
| exception-reference-id | string | ||
| exception-suppressed | string | ||
| exception-type | string | ||
| host-name | string | ||
| level | string | ||
| logger-class-name | string | ||
| logger-name | string | ||
| mdc | string | ||
| message | string | ||
| ndc | string | ||
| process-id | string | ||
| process-name | string | ||
| record | string | ||
| sequence | string | ||
| source-class-name | string | ||
| source-file-name | string | ||
| source-line-number | string | ||
| source-method-name | string | ||
| source-module-name | string | ||
| source-module-version | string | ||
| stack-trace | string | ||
| thread-id | string | ||
| thread-name | string | ||
| timestamp | string |
meta-data?
Sets the meta data to use in the structured format. Properties will be added to each log message.
A collection of free-form properties.property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
filter
Defines a filter to be used to filter log messages.
| Name | Type | Default | Description |
|---|---|---|---|
| module | string | ||
| class | string | ||
| name | string |
constructor-properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |
properties?
A collection of free-form properties.
property
| Name | Type | Default | Description |
|---|---|---|---|
| name | string | ||
| value | string |