Management API Reference for console-handler

Defines a handler which writes to the console.

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=/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 (9)

autoflush - Automatically flush after each write.

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" : "Automatically flush after each write.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

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 }`

encoding - The character encoding used by this Handler.

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" : "The character encoding used by this Handler.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "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" }

formatter - Defines a pattern for the formatter.

Type	STRING
Default Value	%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
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" : "Defines a pattern for the formatter.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n", "alternatives" : ["named-formatter"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

level - The log level specifying which message levels will be logged by this logger. 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 logger. 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 }`

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

Type	STRING
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" : "STRING" }, "description" : "The name of the defined formatter to be used on the handler.", "expressions-allowed" : false, "required" : false, "nillable" : true, "alternatives" : ["formatter"], "capability-reference" : "org.wildfly.logging.formatter", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

target - Defines the target of the console handler. The value can be System.out, System.err or console.

Type	STRING
Default Value	System.out
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	console System.err System.out
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the target of the console handler. The value can be System.out, System.err or console.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "System.out", "allowed" : [ "console", "System.out", "System.err" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (6)

add - Add a new console handler.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
autoflush	BOOLEAN	false	true	true	Automatically flush after each write.
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.*"))
formatter	STRING	false	true	%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n	Defines a pattern for the formatter.
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	false	false		The name of the defined formatter to be used on the handler.
target	STRING	false	true	System.out	Defines the target of the console handler. The value can be System.out, System.err or console.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new console handler.",
    "request-properties" : {
        "autoflush" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Automatically flush after each write.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "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"
        },
        "encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The character encoding used by this Handler.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "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"
        },
        "formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines a pattern for the formatter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n",
            "alternatives" : ["named-formatter"],
            "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 logger. 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"
        },
        "named-formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the defined formatter to be used on the handler.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["formatter"],
            "capability-reference" : "org.wildfly.logging.formatter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "target" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the target of the console handler. The value can be System.out, System.err or console.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "System.out",
            "allowed" : [
                "console",
                "System.out",
                "System.err"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "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 console handler.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes the console handler.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "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
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.
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.
formatter	STRING	false	true	%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n	Defines a pattern for the formatter.
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.*"))
autoflush	BOOLEAN	false	true	true	Automatically flush after each write.
target	STRING	false	true	System.out	Defines the target of the console handler. The value can be System.out, System.err or console.
named-formatter	STRING	false	false		The name of the defined formatter to be used on the handler.

Raw DMR model


{
    "operation-name" : "update-properties",
    "description" : "Update the properties on the existing handler.",
    "request-properties" : {
        "level" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The log level specifying which message levels will be logged by this logger. 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"
        },
        "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"
        },
        "encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The character encoding used by this Handler.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines a pattern for the formatter.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n",
            "alternatives" : ["named-formatter"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "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"
        },
        "autoflush" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Automatically flush after each write.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "target" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the target of the console handler. The value can be System.out, System.err or console.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "System.out",
            "allowed" : [
                "console",
                "System.out",
                "System.err"
            ],
            "stability" : "default"
        },
        "named-formatter" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the defined formatter to be used on the handler.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["formatter"],
            "capability-reference" : "org.wildfly.logging.formatter",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "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.console-handler

        
<feature spec="subsystem.logging.logging-profile.console-handler">
  <param name="console-handler" value="{resource name}"/>
  <param name="logging-profile" value="{resource name}"/>
  <param name="autoflush" value="{value}"/>
  <param name="enabled" value="{value}"/>
  <param name="encoding" value="{value}"/>
  <param name="filter-spec" value="{value}"/>
  <param name="formatter" value="{value}"/>
  <param name="level" value="{value}"/>
  <param name="named-formatter" value="{value}"/>
  <param name="target" value="{value}"/>
<feature/>