Writes one access-log line per completed exchange through a Log4j appender. The line follows the Apache Common Log Format by default; add additionalPatternList entries to append your own SpEL-evaluated fields. Where the line is written and in which format is controlled by the Log4j configuration (log4j2.xml). Typically configured under global so it covers every API. See the tutorials under tutorials/logging.

Example Configuration

global:
   - accessLog:
       additionalPatternList:
         - name: forwarded
           expression: headers['x-forwarded-for']

global:
   - accessLog:
       additionalPatternList:
         - name: forwarded
           expression: headers['x-forwarded-for']

Syntax

accessLog:
  additionalPatternList:
    - <accessLog-scope>
  dateTimePattern: <string>
  defaultValue: <string>
  excludePayloadSize: <boolean>

accessLog:
  additionalPatternList:
    - <accessLog-scope>
  dateTimePattern: <string>
  defaultValue: <string>
  excludePayloadSize: <boolean>

Attributes

Name	Required	Default	Description	Examples
dateTimePattern	false	dd/MM/yyyy:HH:mm:ss Z	Pattern used to format the request timestamp in the log line. Month names are English. Use `dd/MMM/yyyy:HH:mm:ss Z` for the timestamp of the Apache Common Log Format.	-
defaultValue	false	-	Value logged when an exchange property or expression resolves to null.	N/A
excludePayloadSize	false	false	Whether to omit the payload size from the log line. Logging the size requires reading the whole body, which disables streaming; set to `true` to keep streaming.	-

Child Structure

Element	Cardinality	Description
accessLog-scope	0..*	Extra fields appended to each log line. Each additionalVariable binds a name, referenced in log4j2.xml as %X{name}, to a SpEL expression evaluated against the exchange. Line breaks, quotes, backslashes and other control characters in the value are escaped, e.g. a newline is logged as \n.

Example Configuration

Syntax

Attributes

Child Structure

Can be used in