WildFly Full 21 Model Reference

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.

Provided capabilities(1)

Name	Dynamic	Other provider points
org.wildfly.logging.handler	true	/subsystem=logging/logging-profile=/periodic-rotating-file-handler= /subsystem=logging/periodic-size-rotating-file-handler=* /subsystem=logging/logging-profile=/custom-handler= /subsystem=logging/file-handler=* /subsystem=logging/custom-handler=* /subsystem=logging/logging-profile=/syslog-handler= /subsystem=logging/logging-profile=/console-handler= /subsystem=logging/logging-profile=/size-rotating-file-handler= /subsystem=logging/periodic-rotating-file-handler=* /subsystem=logging/socket-handler=* /subsystem=logging/logging-profile=/file-handler= /subsystem=logging/syslog-handler=* /subsystem=logging/console-handler=* /subsystem=logging/logging-profile=/periodic-size-rotating-file-handler= /subsystem=logging/async-handler=* /subsystem=logging/logging-profile=/async-handler= /subsystem=logging/size-rotating-file-handler=*

Attributes (10)

autoflush Automatically flush after each write.

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

block-on-reconnect If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.

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

enabled If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.

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

encoding The character encoding used by this Handler.

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

filter-spec A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))

Attribute	Value
Capability reference	/subsystem=logging/filter=* /subsystem=logging/logging-profile=/filter=
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services

level The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.

Attribute	Value
Default Value	ALL
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	no-services
Allowed Values	ALL FINEST FINER TRACE DEBUG FINE CONFIG INFO WARN WARNING ERROR SEVERE FATAL OFF

named-formatter The name of the defined formatter to be used on the handler.

Attribute	Value
Capability reference	/subsystem=logging/logging-profile=/custom-formatter= /subsystem=logging/custom-formatter=* /subsystem=logging/logging-profile=/json-formatter= /subsystem=logging/json-formatter=* /subsystem=logging/logging-profile=/xml-formatter= /subsystem=logging/xml-formatter=* /subsystem=logging/logging-profile=/pattern-formatter= /subsystem=logging/pattern-formatter=*
Type	STRING
Nillable	false
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

outbound-socket-binding-ref Outbound socket reference for the socket connection.

Attribute	Value
Capability reference	/socket-binding-group=/remote-destination-outbound-socket-binding= /socket-binding-group=/local-destination-outbound-socket-binding=
Type	STRING
Nillable	false
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

protocol The protocol the socket should communicate over.

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

ssl-context The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.

Attribute	Value
Capability reference	/subsystem=elytron/server-ssl-context=* /subsystem=elytron/server-ssl-sni-context=* /subsystem=elytron/client-ssl-context=*
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

Operations (2)

add Add a new socket handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
autoflush	BOOLEAN	false	true	true	Automatically flush after each write.
block-on-reconnect	BOOLEAN	false	true	false	If set to true the write methods will block when attempting to reconnect. This is only advisable to be set to true if using an asynchronous handler.
enabled	BOOLEAN	false	true	true	If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.
encoding	STRING	false	true		The character encoding used by this Handler.
filter-spec	STRING	false	true		A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match("JBAS.*"))
level	STRING	false	true	ALL	The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
named-formatter	STRING	true	false		The name of the defined formatter to be used on the handler.
outbound-socket-binding-ref	STRING	true	true		Outbound socket reference for the socket connection.
protocol	STRING	false	true	TCP	The protocol the socket should communicate over.
ssl-context	STRING	false	true		The reference to the defined SSL context. This is only used if the protocol is set to SSL_TCP.

remove Removes the socket handler.