Package io.quarkus.vertx.http.runtime

Interface AccessLogConfig

public interface AccessLogConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    baseFileName()
    The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.
    String
    category()
    The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty).
    boolean
    consolidateReroutedRequests()
    If rerouted requests should be consolidated into one log entry
    boolean
    enabled()
    If access logging is enabled.
    Optional<String>
    excludePattern()
    A regular expression that can be used to exclude some paths from logging.
    Optional<String>
    logDirectory()
    The log directory to use when logging access to a file
    String
    logSuffix()
    The log file suffix
    boolean
    logToFile()
    If logging should be done to a separate file.
    Optional<Set<String>>
    maskedCookies()
    Set of HTTP Cookie headers whose values must be masked when the `%{ALL_REQUEST_HEADERS}` attribute is enabled with the pattern() property.
    Optional<Set<String>>
    maskedHeaders()
    Set of HTTP headers whose values must be masked when the `%{ALL_REQUEST_HEADERS}` attribute is enabled with the pattern() property.
    String
    pattern()
    The access log pattern.
    boolean
    rotate()
    If the log should be rotated daily

  • Method Details

    • enabled

      @WithDefault("false") boolean enabled()
      If access logging is enabled. By default this will log via the standard logging facility

    • excludePattern

      Optional<String> excludePattern()
      A regular expression that can be used to exclude some paths from logging.

    • pattern

      @WithDefault("common") String pattern()
      The access log pattern.

      If this is the string `common`, `combined` or `long` then this will use one of the specified named formats:

      - common: `%h %l %u %t "%r" %s %b` - combined: `%h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"` - long: `%r\n%{ALL_REQUEST_HEADERS}`

      Otherwise, consult the Quarkus documentation for the full list of variables that can be used. Note that enabling the `%{ALL_REQUEST_HEADERS}` attribute directly or with a `long` named format introduces a risk of sensitive header values being logged.

      HTTP `Authorization` header value is always masked. Use the maskedHeaders() property to mask other sensitive headers.

    • maskedHeaders

      Optional<Set<String>> maskedHeaders()
      Set of HTTP headers whose values must be masked when the `%{ALL_REQUEST_HEADERS}` attribute is enabled with the pattern() property.

    • maskedCookies

      Optional<Set<String>> maskedCookies()
      Set of HTTP Cookie headers whose values must be masked when the `%{ALL_REQUEST_HEADERS}` attribute is enabled with the pattern() property.

    • logToFile

      @WithDefault("false") boolean logToFile()
      If logging should be done to a separate file.

    • baseFileName

      @WithDefault("quarkus") String baseFileName()
      The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.

    • logDirectory

      Optional<String> logDirectory()
      The log directory to use when logging access to a file

      If this is not set then the current working directory is used.

    • logSuffix

      @WithDefault(".log") String logSuffix()
      The log file suffix

    • category

      @WithDefault("io.quarkus.http.access-log") String category()
      The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty).

    • rotate

      @WithDefault("true") boolean rotate()
      If the log should be rotated daily

    • consolidateReroutedRequests

      @WithDefault("false") boolean consolidateReroutedRequests()
      If rerouted requests should be consolidated into one log entry