WildFly Full 23 Model Reference

  1. home
  2. subsystem=elytron
  3. size-rotating-file-audit-log

An audit log definition for persisting an audit log to a local files rotating the log after the size of the file grows beyond a certain point and keeping a fixed number of backups.

Provided capabilities(1)

Attributes (9)

  • autoflush Whether every event should be immediately flushed to disk.
    • Attribute Value
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • format The format to use to record the audit event.
    • Attribute Value
    Default Value SIMPLE
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values SIMPLE
    JSON
  • max-backup-index The maximum number of files to backup when rotating.
    • 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 all-services
  • path Path of the file to be written.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • relative-to The relative path to the audit log.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • rotate-on-boot Whether the file should be rotated before the a new file is set.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • rotate-size The log file size the file should rotate at.
    • Attribute Value
    Default Value 10m
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • suffix Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • synchronized Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (2)

  • add Add the audit logger resource.
    Request Parameter Type Required Expressions Allowed Default value Description
    autoflush BOOLEAN false true Whether every event should be immediately flushed to disk.
    format STRING false true SIMPLE The format to use to record the audit event.
    max-backup-index INT false true 1 The maximum number of files to backup when rotating.
    rotate-on-boot BOOLEAN false true false Whether the file should be rotated before the a new file is set.
    rotate-size STRING false true 10m The log file size the file should rotate at.
    suffix STRING false true Format of date used as suffix of log file names in java.time.format.DateTimeFormatter. The suffix does not play a role in determining when the file should be rotated.
    synchronized BOOLEAN false true true Whether every event should be immediately flushed to disk (If undefined will default to the value of synchronized).
    path STRING true true Path of the file to be written.
    relative-to STRING false false The relative path to the audit log.
  • remove Remove the audit logger resource.