WildFly Full 23 Model Reference

  1. home
  2. subsystem=logging
  3. console-handler

Defines a handler which writes to the console.

Provided capabilities(1)

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
  • 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 Defines a simple filter type.
    • Deprecated Since 1.2.0
    Use filter-spec.
    Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    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
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • formatter Defines a pattern for the formatter.
    • Attribute Value
    Default Value %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n
    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
  • 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.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • named-formatter The name of the defined formatter to be used on the handler.
  • target Defines the target of the console handler. The value can be System.out, System.err or console.
    • Attribute Value
    Default Value System.out
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values console
    System.out
    System.err

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 OBJECT false false Defines a simple filter type.
    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.
    name STRING false false The name of the handler.
    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.
  • 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.
  • disable Disable a logging handler.
    Deprecated Since 1.2.0
    Use the write-attribute for the enabled attribute.
  • enable Enable a logging handler.
    Deprecated Since 1.2.0
    Use the write-attribute for the enabled attribute.
  • remove Removes the console handler.
  • 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.
    filter OBJECT false false Defines a simple filter type.