JBoss EAP 7.3.0.GA Model Reference

A formatter that formats log messages in XML.

Provided capabilities(1)

Name	Dynamic	Other provider points
org.wildfly.logging.formatter	true	/subsystem=logging/logging-profile=/custom-formatter= /subsystem=logging/custom-formatter=* /subsystem=logging/logging-profile=/json-formatter= /subsystem=logging/json-formatter=* /subsystem=logging/logging-profile=/pattern-formatter= /subsystem=logging/xml-formatter=* /subsystem=logging/pattern-formatter=*

Attributes (10)

date-format The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

exception-output-type Indicates how the cause of the logged message, if one is available, will be added to the XML output.

Attribute	Value
Default Value	detailed
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

key-overrides Allows the names of the keys for the XML properties to be overridden.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	resource-services

meta-data Sets the meta data to use in the XML format. Properties will be added to each log message.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

namespace-uri Sets the namespace URI used for each record if print-namespace attribute is true. Note that if no namespace-uri is defined and there are overridden keys no namespace will be written regardless if the print-namespace attribute is set to true.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

pretty-print Indicates whether or not pretty printing should be used when formatting.

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

print-details 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, source module name, source module version and source line number.

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

print-namespace Turns on or off the printing of the namespace for each . This is set to false by default.

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

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.

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

zone-id The zone ID for formatting the date and time. The system default is used if left undefined.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

Operations (2)

add Adds a new XML formatter.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
date-format	STRING	false	true		The date/time format pattern. The pattern must be a valid java.time.format.DateTimeFormatter.ofPattern() pattern. The default pattern is an ISO-8601 extended offset date-time format.
exception-output-type	STRING	false	true	detailed	Indicates how the cause of the logged message, if one is available, will be added to the XML output.
key-overrides	OBJECT	false	false		Allows the names of the keys for the XML properties to be overridden.
meta-data	OBJECT	false	false		Sets the meta data to use in the XML format. Properties will be added to each log message.
namespace-uri	STRING	false	true		Sets the namespace URI used for each record if print-namespace attribute is true. Note that if no namespace-uri is defined and there are overridden keys no namespace will be written regardless if the print-namespace attribute is set to true.
pretty-print	BOOLEAN	false	true	false	Indicates whether or not pretty printing should be used when formatting.
print-details	BOOLEAN	false	true	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, source module name, source module version and source line number.
print-namespace	BOOLEAN	false	true	false	Turns on or off the printing of the namespace for each . This is set to false by default.
record-delimiter	STRING	false	true		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.
zone-id	STRING	false	true		The zone ID for formatting the date and time. The system default is used if left undefined.

remove Removes the XML formatter.