Class AbstractAccessLogValve
- All Implemented Interfaces:
MBeanRegistration,AccessLog,Contained,JmxEnabled,Lifecycle,Valve
- Direct Known Subclasses:
AccessLogValve
Abstract implementation of the Valve interface that generates a web server access log with the detailed line
contents matching a configurable pattern. The syntax of the available patterns is similar to that supported by the
Apache HTTP Server mod_log_config module.
Patterns for the logged message may include constant text or any of the following replacement strings, for which the corresponding information from the specified Response is substituted:
%a- Remote IP address%A- Local IP address%b- Bytes sent, excluding HTTP headers, or '-' if no bytes were sent%B- Bytes sent, excluding HTTP headers%h- Remote host name (or IP address ifenableLookupsfor the connector is false)%H- Request protocol%l- Remote logical username from identd (always returns '-')%m- Request method%p- Local port%q- Query string (prepended with a '?' if it exists, otherwise an empty string%r- First line of the request%s- HTTP status code of the response%S- User session ID%t- Date and time, in Common Log Format format%u- Remote user that was authenticated%U- Requested URL path%v- Local server name%D- Time taken to process the request, in microseconds%T- Time taken to process the request, in seconds%F- Time taken to commit the response, in milliseconds%I- current Request thread name (can compare later with stacktraces)%X- Connection status when response is completed:X= Connection aborted before the response completed.+= Connection may be kept alive after the response is sent.-= Connection will be closed after the response is sent.
In addition, the caller can specify one of the following aliases for commonly utilized patterns:
- common -
%h %l %u %t "%r" %s %b - combined -
%h %l %u %t "%r" %s %b "%{Referer}i" "%{User-Agent}i"
There is also support to write information from the cookie, incoming header, the Session or something else in the
ServletRequest.
It is modeled after the Apache HTTP Server log configuration syntax:
%{xxx}ifor incoming headers%{xxx}ofor outgoing response headers%{xxx}cfor a specific cookie%{xxx}rxxx is an attribute in the ServletRequest%{xxx}sxxx is an attribute in the HttpSession%{xxx}txxx is an enhanced SimpleDateFormat pattern (see Configuration Reference document for details on supported time patterns)%{xxx}Txxx is the unit for the time taken to process the request (see Configuration Reference document for details on supported units)
Conditional logging is also supported. This can be done with the conditionUnless and
conditionIf properties. If the value returned from ServletRequest.getAttribute(conditionUnless) yields a
non-null value, the logging will be skipped. If the value returned from ServletRequest.getAttribute(conditionIf)
yields the null value, the logging will be skipped. The condition attribute is synonym for
conditionUnless and is provided for backwards compatibility.
For extended attributes coming from a getAttribute() call, it is you responsibility to ensure there are no newline or control characters.
- Author:
- Craig R. McClanahan, Jason Brittain, Remy Maucherat, Takayuki Kaneko, Peter Rossbach
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static interfaceAccessLogElement writes the partial message into the buffer.protected static classwrite bytes sent, excluding HTTP headers - %b, %Bprotected static interfaceMarks an AccessLogElement as needing to be have the value cached at the start of the request rather than just recorded at the end as the source data for the element may not be available at the end of the request.protected static classWrite connection status when response is completed - %Xprotected static classwrite a specific cookie - %{xxx}cprotected classwrite date and time, in configurable format (default CLF) - %t or %{format}tprotected static classCache structure for formatted timestamps based on seconds.protected static classwrite time taken to process the request - %D, %Tprotected static classwrite time until first byte is written (commit time) in millis - %Fprotected static classwrite incoming headers - %{xxx}iprotected classwrite remote host name - %hprotected static classwrite HTTP status code of the response - %sprotected static classwrite local IP address - %Aprotected classwrite local server name - %vprotected static classwrite remote logical username from identd (always returns '-') - %lprotected static classwrite request method (GET, POST, etc.) - %mprotected classwrite local or remote port for request connection - %p and %{xxx}pprotected classwrite request protocol - %Hprotected static classwrite Query string (prepended with a '?'protected classwrite remote IP address - %aprotected static classwrite an attribute in the ServletRequest - %{xxx}rprotected static classwrite first line of the request (method and request URI) - %rprotected static classwrite requested URL path - %Uprotected static classwrite a specific response header - %{xxx}oprotected static classwrite an attribute in the HttpSession - %{xxx}sprotected static classwrite user session ID - %Sprotected static classwrite any stringprotected static classwrite thread name - %Iprotected static classwrite remote user that was authenticated (if any), else '-' - %uNested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected AbstractAccessLogValve.CachedElement[]Array of elements where the value needs to be cached at the start of the request.protected StringAre we doing conditional logging. default null.protected StringAre we doing conditional logging. default null.protected booleanenabled this componentprotected LocaleLocale used to format timestamps in log entries and in log file name suffix.protected StringName of locale used to format timestamps in log entries and in log file name suffix.protected AbstractAccessLogValve.AccessLogElement[]Array of AccessLogElement, they will be used to make log message.protected StringThe pattern used to format our access log lines.protected booleanShould this valve use request attributes for IP address, hostname, protocol and port used for the request.Fields inherited from class org.apache.catalina.valves.ValveBase
asyncSupported, container, containerLog, next, smFields inherited from interface org.apache.catalina.AccessLog
PROTOCOL_ATTRIBUTE, REMOTE_ADDR_ATTRIBUTE, REMOTE_HOST_ATTRIBUTE, SERVER_NAME_ATTRIBUTE, SERVER_PORT_ATTRIBUTEFields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected AbstractAccessLogValve.AccessLogElementcreateAccessLogElement(char pattern) Create an AccessLogElement implementation.protected AbstractAccessLogValve.AccessLogElementcreateAccessLogElement(String name, char pattern) Create an AccessLogElement implementation which needs an element name.protected AbstractAccessLogValve.AccessLogElement[]Parse pattern string and create the array of AccessLogElement.protected static voidescapeAndAppend(String input, CharArrayWriter dest) protected static LocalefindLocale(String name, Locale fallback) Find a locale by name.Return whether the attribute name to look for when performing conditional logging.Return whether the attribute name to look for when performing conditional logging.Return whether the attribute name to look for when performing conditional logging.booleanbooleanReturn the locale used to format timestamps in log entries and in log file name suffix.intbooleanvoidLog a message summarizing the specified request and response, according to the format specified by thepatternproperty.protected abstract voidlog(CharArrayWriter message) Log the specified message.voidAdd the request/response to the access log using the specified processing time.voidsetCondition(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.voidsetConditionIf(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.voidsetConditionUnless(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.voidsetEnabled(boolean enabled) voidsetIpv6Canonical(boolean ipv6Canonical) voidSet the locale used to format timestamps in log entries and in log file name suffix.voidsetMaxLogMessageBufferSize(int maxLogMessageBufferSize) voidsetPattern(String pattern) Set the format pattern, first translating any recognized alias.voidsetRequestAttributesEnabled(boolean requestAttributesEnabled) Should this valve use request attributes for IP address, hostname, protocol and port used for the request?Methods inherited from class org.apache.catalina.valves.ValveBase
backgroundProcess, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setContainer, setNext, startInternal, stopInternal, toStringMethods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregisterMethods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Field Details
-
enabled
protected boolean enabledenabled this component -
pattern
The pattern used to format our access log lines. -
condition
Are we doing conditional logging. default null. It is the value ofconditionUnlessproperty. -
conditionIf
Are we doing conditional logging. default null. It is the value ofconditionIfproperty. -
localeName
Name of locale used to format timestamps in log entries and in log file name suffix. -
locale
Locale used to format timestamps in log entries and in log file name suffix. -
logElements
Array of AccessLogElement, they will be used to make log message. -
cachedElements
Array of elements where the value needs to be cached at the start of the request. -
requestAttributesEnabled
protected boolean requestAttributesEnabledShould this valve use request attributes for IP address, hostname, protocol and port used for the request. Default isfalse.- See Also:
-
-
Constructor Details
-
AbstractAccessLogValve
public AbstractAccessLogValve()
-
-
Method Details
-
getMaxLogMessageBufferSize
public int getMaxLogMessageBufferSize() -
setMaxLogMessageBufferSize
public void setMaxLogMessageBufferSize(int maxLogMessageBufferSize) -
getIpv6Canonical
public boolean getIpv6Canonical() -
setIpv6Canonical
public void setIpv6Canonical(boolean ipv6Canonical) -
setRequestAttributesEnabled
public void setRequestAttributesEnabled(boolean requestAttributesEnabled) Should this valve use request attributes for IP address, hostname, protocol and port used for the request? The attributes used are:- org.apache.catalina.RemoteAddr
- org.apache.catalina.RemoteHost
- org.apache.catalina.Protocol
- org.apache.catalina.ServerName
- org.apache.catalina.ServerPost
false.- Specified by:
setRequestAttributesEnabledin interfaceAccessLog- Parameters:
requestAttributesEnabled-truecauses the attributes to be used,falsecauses the original values to be used.
-
getRequestAttributesEnabled
public boolean getRequestAttributesEnabled()- Specified by:
getRequestAttributesEnabledin interfaceAccessLog- Returns:
trueif the attributes will be logged, otherwisefalse- See Also:
-
getEnabled
public boolean getEnabled()- Returns:
- the enabled flag.
-
setEnabled
public void setEnabled(boolean enabled) - Parameters:
enabled- The enabled to set.
-
getPattern
- Returns:
- the format pattern.
-
setPattern
Set the format pattern, first translating any recognized alias.- Parameters:
pattern- The new pattern
-
getCondition
Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.- Returns:
- the attribute name
-
setCondition
Set the ServletRequest.attribute to look for to perform conditional logging. Set to null to log everything.- Parameters:
condition- Set to null to log everything
-
getConditionUnless
Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.- Returns:
- the attribute name
-
setConditionUnless
Set the ServletRequest.attribute to look for to perform conditional logging. Set to null to log everything.- Parameters:
condition- Set to null to log everything
-
getConditionIf
Return whether the attribute name to look for when performing conditional logging. If null, every request is logged.- Returns:
- the attribute name
-
setConditionIf
Set the ServletRequest.attribute to look for to perform conditional logging. Set to null to log everything.- Parameters:
condition- Set to null to log everything
-
getLocale
Return the locale used to format timestamps in log entries and in log file name suffix.- Returns:
- the locale
-
setLocale
Set the locale used to format timestamps in log entries and in log file name suffix. Changing the locale is only supported as long as the AccessLogValve has not logged anything. Changing the locale later can lead to inconsistent formatting.- Parameters:
localeName- The locale to use.
-
invoke
Log a message summarizing the specified request and response, according to the format specified by thepatternproperty.- Specified by:
invokein interfaceValve- Parameters:
request- Request being processedresponse- Response being processed- Throws:
IOException- if an input/output error has occurredServletException- if a servlet error has occurred
-
log
Description copied from interface:AccessLogAdd the request/response to the access log using the specified processing time.- Specified by:
login interfaceAccessLog- Parameters:
request- Request (associated with the response) to logresponse- Response (associated with the request) to logtime- Time taken to process the request/response in nanoseconds (use 0 if not known); in Tomcat versions prior to 10, the time unit was milliseconds
-
log
Log the specified message.- Parameters:
message- Message to be logged. This object will be recycled by the calling method.
-
findLocale
Find a locale by name.- Parameters:
name- The locale namefallback- Fallback locale if the name is not found- Returns:
- the locale object
-
createLogElements
Parse pattern string and create the array of AccessLogElement.- Returns:
- the log elements array
-
createAccessLogElement
Create an AccessLogElement implementation which needs an element name.- Parameters:
name- Header namepattern- char in the log pattern- Returns:
- the log element
-
createAccessLogElement
Create an AccessLogElement implementation.- Parameters:
pattern- char in the log pattern- Returns:
- the log element
-
escapeAndAppend
-