Management API Reference for async-handler

It defines a handler which writes to the sub-handlers in an asynchronous thread, used for handlers which introduce a substantial amount of lag.

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=/socket-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/size-rotating-file-handler=*

Attributes (7)

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.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["filter"], "capability-reference" : "org.wildfly.logging.filter", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }

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

Type	STRING
Default Value	ALL
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	TRACE ALL SEVERE FINER FINEST INFO DEBUG WARNING WARN OFF CONFIG FINE ERROR FATAL
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "ALL", "allowed" : [ "ALL", "FINEST", "FINER", "TRACE", "DEBUG", "FINE", "CONFIG", "INFO", "WARN", "WARNING", "ERROR", "SEVERE", "FATAL", "OFF" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

name - The name of the handler.

Deprecated Since 1.2.0

The name attribute should not be used as the handler's address contains the name.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the handler.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "1.2.0", "reason" : "The name attribute should not be used as the handler's address contains the name." }, "access-type" : "read-only", "storage" : "configuration", "restart-required" : null, "capability-reference" : null }`

overflow-action - Specify what action to take when the overflowing. The valid options are 'block' and 'discard'

Type	STRING
Default Value	BLOCK
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	DISCARD BLOCK
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Specify what action to take when the overflowing. The valid options are 'block' and 'discard'", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "BLOCK", "allowed" : [ "BLOCK", "DISCARD" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

queue-length - The queue length to use before flushing writing

Type	INT
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The queue length to use before flushing writing", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

subhandlers - The Handlers associated with this async handler.

Type	LIST
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The Handlers associated with this async handler.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.logging.handler", "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

Operations (10)

add - Add a new async handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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.
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 handler. Message levels lower than this value will be discarded.
overflow-action	STRING	false	true	BLOCK	Specify what action to take when the overflowing. The valid options are 'block' and 'discard'
queue-length	INT	true	true		The queue length to use before flushing writing
subhandlers	LIST	false	false		The Handlers associated with this async handler.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new async handler.",
    "request-properties" : {
        "enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "filter-spec" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["filter"],
            "capability-reference" : "org.wildfly.logging.filter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ALL",
            "allowed" : [
                "ALL",
                "FINEST",
                "FINER",
                "TRACE",
                "DEBUG",
                "FINE",
                "CONFIG",
                "INFO",
                "WARN",
                "WARNING",
                "ERROR",
                "SEVERE",
                "FATAL",
                "OFF"
            ],
            "stability" : "default"
        },
        "overflow-action" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specify what action to take when the overflowing.  The valid options are 'block' and 'discard'",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "BLOCK",
            "allowed" : [
                "BLOCK",
                "DISCARD"
            ],
            "stability" : "default"
        },
        "queue-length" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The queue length to use before flushing writing",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "subhandlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The Handlers associated with this async handler.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.logging.handler",
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

add-handler - Adds a child handler to the async handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to add.

Raw DMR model


{
    "operation-name" : "add-handler",
    "description" : "Adds a child handler to the async handler.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to add.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

assign-subhandler - Assign a subhandler to the handler.

Deprecated Since 1.2.0

Use the add-handler operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to add.

Raw DMR model


{
    "operation-name" : "assign-subhandler",
    "description" : "Assign a subhandler to the handler.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to add.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the add-handler operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

change-log-level - Change the logging level for a handler.

Deprecated Since 1.2.0

Use the write-attribute operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
level	STRING	false	true	ALL	The new level to set.

Raw DMR model


{
    "operation-name" : "change-log-level",
    "description" : "Change the logging level for a handler.",
    "request-properties" : {"level" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The new level to set.",
        "expressions-allowed" : true,
        "required" : false,
        "nillable" : true,
        "default" : "ALL",
        "allowed" : [
            "ALL",
            "FINEST",
            "FINER",
            "TRACE",
            "DEBUG",
            "FINE",
            "CONFIG",
            "INFO",
            "WARN",
            "WARNING",
            "ERROR",
            "SEVERE",
            "FATAL",
            "OFF"
        ],
        "stability" : "default"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

disable - Disable a logging handler.

Deprecated Since 1.2.0

Use the write-attribute for the enabled attribute.

Raw DMR model


{
    "operation-name" : "disable",
    "description" : "Disable a logging handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute for the enabled attribute."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

enable - Enable a logging handler.

Deprecated Since 1.2.0

Use the write-attribute for the enabled attribute.

Raw DMR model


{
    "operation-name" : "enable",
    "description" : "Enable a logging handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute for the enabled attribute."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes the async handler.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the async handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

remove-handler - Removes the handler from the async handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to remove.

Raw DMR model


{
    "operation-name" : "remove-handler",
    "description" : "Removes the handler from the async handler.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to remove.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

unassign-subhandler - Unassign a subhandler from the handler.

Deprecated Since 1.2.0

Use the remove-handler operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	false	false		The name of the handler to remove.

Raw DMR model


{
    "operation-name" : "unassign-subhandler",
    "description" : "Unassign a subhandler from the handler.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the handler to remove.",
        "expressions-allowed" : false,
        "required" : false,
        "nillable" : true,
        "capability-reference" : "org.wildfly.logging.handler",
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the remove-handler operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

update-properties - Update the properties on the existing handler.

Deprecated Since 1.2.0

Use the write-attribute operation.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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.
level	STRING	false	true	ALL	The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.
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.*"))
queue-length	INT	true	true		The queue length to use before flushing writing
overflow-action	STRING	false	true	BLOCK	Specify what action to take when the overflowing. The valid options are 'block' and 'discard'
subhandlers	LIST	false	false		The Handlers associated with this async handler.

Raw DMR model


{
    "operation-name" : "update-properties",
    "description" : "Update the properties on the existing handler.",
    "request-properties" : {
        "enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If set to true the handler is enabled and functioning as normal, if set to false the handler is ignored when processing log messages.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log level specifying which message levels will be logged by this handler. Message levels lower than this value will be discarded.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "ALL",
            "allowed" : [
                "ALL",
                "FINEST",
                "FINER",
                "TRACE",
                "DEBUG",
                "FINE",
                "CONFIG",
                "INFO",
                "WARN",
                "WARNING",
                "ERROR",
                "SEVERE",
                "FATAL",
                "OFF"
            ],
            "stability" : "default"
        },
        "filter-spec" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A filter expression value to define a filter. Example for a filter that does not match a pattern: not(match(\"JBAS.*\"))",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["filter"],
            "capability-reference" : "org.wildfly.logging.filter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "queue-length" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The queue length to use before flushing writing",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "overflow-action" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Specify what action to take when the overflowing.  The valid options are 'block' and 'discard'",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "BLOCK",
            "allowed" : [
                "BLOCK",
                "DISCARD"
            ],
            "stability" : "default"
        },
        "subhandlers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The Handlers associated with this async handler.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.logging.handler",
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "deprecated" : {
        "since" : "1.2.0",
        "reason" : "Use the write-attribute operation."
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.logging.logging-profile.async-handler

        
<feature spec="subsystem.logging.logging-profile.async-handler">
  <param name="async-handler" value="{resource name}"/>
  <param name="logging-profile" value="{resource name}"/>
  <param name="enabled" value="{value}"/>
  <param name="filter-spec" value="{value}"/>
  <param name="level" value="{value}"/>
  <param name="overflow-action" value="{value}"/>
  <param name="queue-length" value="{value}"/>
  <param name="subhandlers" value="{value}"/>
<feature/>