JBoss EAP 6.2 Model Reference

  1. JBoss EAP 6.2
  2. core-service=management
  3. access=audit
  4. json-formatter

A json formatter for audit log messages.

Attributes (6)

  • compact If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • date-format The date format to use as understood by {@link java.text.SimpleDateFormat}. Will be ignored if include-date="false".
    • Attribute Value
    Default Value yyyy-MM-dd HH:mm:ss
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • date-separator The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".
    • Attribute Value
    Default Value -
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • escape-control-characters If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line="false".
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • escape-new-line If true will escape all new lines with the ascii code in octal, e.g. "#012".
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • include-date Whether or not to include the date in the formatted log record.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (2)

  • add Adds a json formatter for the audit logging.
    Request Parameter Type Required Expressions Allowed Default value Description
    date-separator STRING false true - The separator between the date and the rest of the formatted log message. Will be ignored if include-date="false".
    compact BOOLEAN false true false If true will format the JSON on one line. There may still be values containing new lines, so if having the whole record on one line is important, set escape-new-line or escape-control-characters to true.
    escape-control-characters BOOLEAN false true false If true will escape all control characters (ascii entries with a decimal value < 32) with the ascii code in octal, e.g.' becomes '#012'. If this is true, it will override escape-new-line="false".
    date-format STRING false true yyyy-MM-dd HH:mm:ss The date format to use as understood by {@link java.text.SimpleDateFormat}. Will be ignored if include-date="false".
    escape-new-line BOOLEAN false true false If true will escape all new lines with the ascii code in octal, e.g. "#012".
    include-date BOOLEAN false true true Whether or not to include the date in the formatted log record.
  • remove Removes a json formatter for the audit logging.