WildFly Full 24 Model Reference

The configuration of the logging subsystem.

Children (18)

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.
console-handler Defines a handler which writes to the console.
custom-formatter A custom formatter to be used with handlers. Note that most log records are formatted in the printf format. Formatters may require invocation of the org.jboss.logmanager.ExtLogRecord#getFormattedMessage() for the message to be properly formatted.
custom-handler Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.
file-handler Defines a handler which writes to a file.
filter A filter to be used with handlers and loggers. Please note the name of the filter should start with an alpha character and not contain any special characters. The following names are considered reserved names; accept, deny, not, all, any, levelChange, levels, levelRange, match, substitute, substituteAll.
json-formatter A formatter that formats log messages in JSON.
log-file Log files that are available to be read.
logger Defines a logger category.
logging-profile A profile that can be assigned to a deployment for its logging configuration.
pattern-formatter A pattern formatter to be used with handlers.
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.
periodic-size-rotating-file-handler Defines a handler which writes to a file, rotating the log after a time period derived from the given suffix string or after the size of the file grows beyond a certain point and keeping a fixed number of backups. The suffix should be in a format understood by the java.text.SimpleDateFormat. Any backups rotated by the suffix will not be purged during a size rotation.
root-logger Defines the root logger for this log context.

ROOT Defines the root logger for this log context.

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.
socket-handler Defines a handler which writes to a socket. Note that a socket-handler will queue messages during the boot process. These messages will be drained to the socket once the resource is fully configured. If the server is in admin-only state messages will be discarded.
syslog-handler Defines a syslog handler.
xml-formatter A formatter that formats log messages in XML.

Attributes (2)

add-logging-api-dependencies Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

use-deployment-logging-config Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file was found in the deployments META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set false the servers logging configuration will be used regardless of any logging configuration files supplied in the deployment.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	all-services

Operations (4)

add Add the logging subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
add-logging-api-dependencies	BOOLEAN	false	true	true	Indicates whether or not logging API dependencies should be added to deployments during the deployment process. A value of true will add the dependencies to the deployment. A value of false will skip the deployment from being processed for logging API dependencies.
use-deployment-logging-config	BOOLEAN	false	true	true	Indicates whether or not deployments should use a logging configuration file found in the deployment to configure the log manager. If set to true and a logging configuration file was found in the deployments META-INF or WEB-INF/classes directory, then a log manager will be configured with those settings. If set false the servers logging configuration will be used regardless of any logging configuration files supplied in the deployment.

list-log-files Lists the log files in the jboss.server.log.dir directory that are defined on a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.

Deprecated Since 3.0.0

Use the log-file resource to see the available log files.

Reply properties

type

LIST

Value Type

{
    "file-name" => {
        "type" => STRING,
        "description" => "The name of the file.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    },
    "file-size" => {
        "type" => LONG,
        "description" => "The size of the log file in bytes.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false
    },
    "last-modified-date" => {
        "type" => STRING,
        "description" => "The date the file was last modified.",
        "expressions-allowed" => false,
        "required" => true,
        "nillable" => false,
        "min-length" => 1L,
        "max-length" => 2147483647L
    }
}

read-log-file Reads the contents of a log file. The file must be in the jboss.server.log.dir and must be defined as a file-handler, periodic-rotating-file-handler or size-rotating-file-handler.

Deprecated Since 3.0.0

Use the log-file resource to read the log file.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	true		The name of the log file to read. This file must exist in the jboss.server.log.dir.
encoding	STRING	false	true		The character encoding used to read the file.
lines	INT	false	true	10	The number of lines to read from the file. A value of -1 will read all log lines.
skip	INT	false	true	0	The number of lines to skip before reading.
tail	BOOLEAN	false	true	true	Reads from the end of the file.

Reply properties

type

LIST

Value Type

STRING

remove Remove the logging subsystem.