WildFly 9.0 Model Reference

  1. WildFly 9.0
  2. subsystem=logging
  3. logging-profile
  4. custom-handler

Defines a custom logging handler. The custom handler must extend java.util.logging.Handler.

Attributes (10)

  • class The logging handler class to be used.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-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
    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
  • module The module that the logging handler depends on.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • 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.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • properties Defines the properties used for the logging handler. All properties must be accessible via a setter method.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (6)

  • add Adds a new custom handler. The handler must extend org.jboss.logmanager.ExtHandler, java.util.logging.Handler or be a log4j appender.
    Request Parameter Type Required Expressions Allowed Default value Description
    class STRING true false The logging handler class to be used.
    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.
    module STRING true false The module that the logging handler depends on.
    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.
    properties OBJECT false true Defines the properties used for the logging handler. All properties must be accessible via a setter method.
  • 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 custom 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.*"))
    class STRING true false The logging handler class to be used.
    module STRING true false The module that the logging handler depends on.
    named-formatter STRING false false The name of the defined formatter to be used on the handler.
    properties OBJECT false true Defines the properties used for the logging handler. All properties must be accessible via a setter method.