WildFly 37 Model Reference

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

Attributes (8)

  • disabled-due-to-failure Whether this handler has been disabled due to logging failures.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default
  • failure-count The number of logging failures since the handler was initialized.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Stability default
  • formatter The formatter used to format the log messages.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • max-backup-index The maximum number of backups to keep.
    • Attribute Value
    Default Value 1
    Type INT
    Nillable true
    Expressions Allowed true
    Min 1
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • max-failure-count The maximum number of logging failures before disabling this handler.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • path The path of the audit log file.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • relative-to The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • rotate-size The size at which to rotate the log file.
    • Attribute Value
    Default Value 10m
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default

Operations (3)

  • add Adds an audit log size-rotating file handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    formatter STRING true false The formatter used to format the log messages.
    max-backup-index INT false true 1 The maximum number of backups to keep.
    max-failure-count INT false true 10 The maximum number of logging failures before disabling this handler.
    path STRING true true The path of the audit log file.
    relative-to STRING false false The name of another previously named path, or of one of the standard paths provided by the system. If 'relative-to' is provided, the value of the 'path' attribute is treated as relative to the path specified by this attribute.
    rotate-size STRING false true 10m The size at which to rotate the log file.
  • recycle Resets the file handler failure count, and backs up the current log file.
  • remove Removes an audit log size-rotating file handler.