JBoss EAP 7.1 Model Reference

  1. JBoss EAP 7.1
  2. subsystem=logging
  3. async-handler

Defines a handler which writes to the sub-handlers in an asynchronous thread. Used for handlers which introduce a substantial amount of lag.

Attributes (8)

  • 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
  • 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
    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 handler. 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
  • overflow-action Specify what action to take when the overflowing. The valid options are 'block' and 'discard'
    • Attribute Value
    Default Value BLOCK
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values BLOCK
    DISCARD
  • queue-length The queue length to use before flushing writing
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • subhandlers The Handlers associated with this async handler.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    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 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.*"))
    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.
    name STRING false false The name of the handler.
    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.
  • 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.
  • 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.
  • 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 async handler.
  • 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.
  • 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.
  • 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.
    filter OBJECT false false Defines a simple filter type.