Package io.quarkus.vertx.http.runtime

Class AccessLogConfig

java.lang.Object

io.quarkus.vertx.http.runtime.AccessLogConfig

public class AccessLogConfig
extends Object

Field Summary

Fields

Modifier and Type	Field	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.
boolean	enabled	If access logging is enabled.
(package private) 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 If this is not set then the current working directory is used.
String	logSuffix	The log file suffix
boolean	logToFile	If logging should be done to a separate file.
String	pattern	The access log pattern.
boolean	rotate	If the log should be rotated daily

Constructor Summary

Constructors

Constructor	Description
AccessLogConfig()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

enabled

@ConfigItem(defaultValue="false")
public boolean enabled

If access logging is enabled. By default this will log via the standard logging facility

excludePattern

@ConfigItem
Optional<String> excludePattern

A regular expression that can be used to exclude some paths from logging.

pattern

@ConfigItem(defaultValue="common")
public 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.

logToFile

@ConfigItem(defaultValue="false")
public boolean logToFile

If logging should be done to a separate file.

baseFileName

@ConfigItem(defaultValue="quarkus")
public String baseFileName

The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.

logDirectory

@ConfigItem
public 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

@ConfigItem(defaultValue=".log")
public String logSuffix

The log file suffix

category

@ConfigItem(defaultValue="io.quarkus.http.access-log")
public 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

@ConfigItem(defaultValue="true")
public boolean rotate

If the log should be rotated daily

Constructor Detail

AccessLogConfig

public AccessLogConfig()