WildFly 33 Model Reference

Allows the access log to be written to the console.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.undertow.host.console-access-log true

none

Attributes (5)

  • attributes The attributes to be included in the structured output.
    • Attribute Value
    Default Value {"remote-host" => {},"remote-user" => {},"date-time" => {},"request-line" => {},"response-code" => {},"bytes-sent" => {}}
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • include-host-name Indicates whether or not the host name should included in the JSON structured output. If set to true the key will be hostName in the structured data and the value will be the host this console-access-log belongs to.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • metadata Any additional metadata to add to the JSON structured output.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • predicate Predicate that determines if the request should be logged.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • worker Name of the worker to use for logging.
    • Attribute Value
    Default Value default
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default

Operations (2)

  • add Adds an access logger which writes to the console. The data is written in a JSON format.
    Request Parameter Type Required Expressions Allowed Default value Description
    attributes OBJECT false false {"remote-host" => {},"remote-user" => {},"date-time" => {},"request-line" => {},"response-code" => {},"bytes-sent" => {}} The attributes to be included in the structured output.
    include-host-name BOOLEAN false true true Indicates whether or not the host name should included in the JSON structured output. If set to true the key will be hostName in the structured data and the value will be the host this console-access-log belongs to.
    metadata OBJECT false true Any additional metadata to add to the JSON structured output.
    predicate STRING false true Predicate that determines if the request should be logged.
    worker STRING false false default Name of the worker to use for logging.
  • remove Stops the access logger from writing to the console.