JBoss AS7 7.1.1 Model Reference

  1. JBoss AS7 7.1.1
  2. subsystem=logging
  3. size-rotating-file-handler

Defines a handler which writes to a file, rotating the log after a the size of the file grows beyond a certain point and keeping a fixed number of backups.

Attributes (10)

  • append Specify whether to append to the target file.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required resource-services
  • autoflush Automatically flush after each write.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    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 false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • file The file description consisting of the path and optional relative to path.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • filter Defines a simple filter type.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values all
    any
    accept
    change-level
    deny
    level
    level-range
    match
    not
    replace
  • formatter Defines a formatter.
    • Attribute Value
    Default Value %d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • level The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values ALL
    FINEST
    FINER
    TRACE
    DEBUG
    FINE
    CONFIG
    INFO
    WARN
    WARNING
    ERROR
    FATAL
    OFF
  • max-backup-index The maximum number of backups to keep.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable false
    Expressions Allowed false
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • name The handler's name.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-only
  • rotate-size The size at which to rotate the log file.
    • Attribute Value
    Default Value 2m
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (7)

  • add Add a new size rotating file handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    name STRING true false The handler's name.
    encoding STRING false false The character encoding used by this Handler.
    level STRING false false The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.
    filter OBJECT false false Defines a simple filter type.
    formatter STRING false false Defines a formatter.
    autoflush BOOLEAN false false Automatically flush after each write.
    append BOOLEAN false false Specify whether to append to the target file.
    file OBJECT false false The file description consisting of the path and optional relative to path.
    rotate-size STRING true false The size at which to rotate the log file.
    max-backup-index INT true false The maximum number of backups to keep.
  • change-file Change the file for a handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    file OBJECT false false The file description consisting of the path and optional relative to path.
  • change-log-level Change the logging level for a handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    level STRING false false The log level specifying which message levels will be logged by this logger. Message levels lower than this value will be discarded.
  • disable Disable a logging handler.
  • enable Enable a logging handler.
  • remove Remove an existing logging handler.
  • update-properties Update the properties of an existing size rotating file handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    name STRING true false The handler's name.
    encoding STRING false false The character encoding used by this Handler.
    level STRING false false The log level specifying which message levels will be logged by this. Message levels lower than this value will be discarded.
    filter OBJECT false false Defines a simple filter type.
    formatter STRING false false Defines a formatter.
    autoflush BOOLEAN false false Automatically flush after each write.
    append BOOLEAN false false Specify whether to append to the target file.
    file OBJECT false false The file description consisting of the path and optional relative to path.
    rotate-size STRING true false The size at which to rotate the log file.
    max-backup-index INT true false The maximum number of backups to keep.