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 ifenableLookups
for 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 millis%T
- Time taken to process the request, in seconds%F
- Time taken to commit the response, in millis%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}i
for incoming headers%{xxx}o
for outgoing response headers%{xxx}c
for a specific cookie%{xxx}r
xxx is an attribute in the ServletRequest%{xxx}s
xxx is an attribute in the HttpSession%{xxx}t
xxx is an enhanced SimpleDateFormat pattern (see Configuration Reference document for details on supported time patterns)
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
Modifier and TypeClassDescriptionprotected static interface
AccessLogElement writes the partial message into the buffer.protected static class
write bytes sent, excluding HTTP headers - %b, %Bprotected static interface
Marks 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 class
Write connection status when response is completed - %Xprotected static class
write a specific cookie - %{xxx}cprotected class
write date and time, in configurable format (default CLF) - %t or %{format}tprotected static class
Cache structure for formatted timestamps based on seconds.protected static class
write time taken to process the request - %D, %Tprotected static class
write time until first byte is written (commit time) in millis - %Fprotected static class
write incoming headers - %{xxx}iprotected class
write remote host name - %hprotected static class
write HTTP status code of the response - %sprotected static class
write local IP address - %Aprotected class
write local server name - %vprotected static class
write remote logical username from identd (always returns '-') - %lprotected static class
write request method (GET, POST, etc.) - %mprotected class
write local or remote port for request connection - %p and %{xxx}pprotected class
write request protocol - %Hprotected static class
write Query string (prepended with a '?'protected class
write remote IP address - %aprotected static class
write an attribute in the ServletRequest - %{xxx}rprotected static class
write first line of the request (method and request URI) - %rprotected static class
write requested URL path - %Uprotected static class
write a specific response header - %{xxx}oprotected static class
write an attribute in the HttpSession - %{xxx}sprotected static class
write user session ID - %Sprotected static class
write any stringprotected static class
write thread name - %Iprotected static class
write remote user that was authenticated (if any), else '-' - %uNested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
Field Summary
Modifier and TypeFieldDescriptionprotected AbstractAccessLogValve.CachedElement[]
Array of elements where the value needs to be cached at the start of the request.protected String
Are we doing conditional logging. default null.protected String
Are we doing conditional logging. default null.protected boolean
enabled this componentprotected Locale
Locale used to format timestamps in log entries and in log file name suffix.protected String
Name 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 String
The pattern used to format our access log lines.protected boolean
Should 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, sm
Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase
mserver
Fields inherited from interface org.apache.catalina.AccessLog
PROTOCOL_ATTRIBUTE, REMOTE_ADDR_ATTRIBUTE, REMOTE_HOST_ATTRIBUTE, SERVER_NAME_ATTRIBUTE, SERVER_PORT_ATTRIBUTE
Fields 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
-
Method Summary
Modifier and TypeMethodDescriptionprotected AbstractAccessLogValve.AccessLogElement
createAccessLogElement
(char pattern) Create an AccessLogElement implementation.protected AbstractAccessLogValve.AccessLogElement
createAccessLogElement
(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 void
escapeAndAppend
(String input, CharArrayWriter dest) protected static Locale
findLocale
(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.boolean
boolean
Return the locale used to format timestamps in log entries and in log file name suffix.int
boolean
void
Log a message summarizing the specified request and response, according to the format specified by thepattern
property.protected abstract void
log
(CharArrayWriter message) Log the specified message.void
Add the request/response to the access log using the specified processing time.void
setCondition
(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.void
setConditionIf
(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.void
setConditionUnless
(String condition) Set the ServletRequest.attribute to look for to perform conditional logging.void
setEnabled
(boolean enabled) void
setIpv6Canonical
(boolean ipv6Canonical) void
Set the locale used to format timestamps in log entries and in log file name suffix.void
setMaxLogMessageBufferSize
(int maxLogMessageBufferSize) void
setPattern
(String pattern) Set the format pattern, first translating any recognized alias.void
setRequestAttributesEnabled
(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, toString
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
Methods 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 ofconditionUnless
property. -
conditionIf
Are we doing conditional logging. default null. It is the value ofconditionIf
property. -
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:
setRequestAttributesEnabled
in interfaceAccessLog
- Parameters:
requestAttributesEnabled
-true
causes the attributes to be used,false
causes the original values to be used.
-
getRequestAttributesEnabled
public boolean getRequestAttributesEnabled()- Specified by:
getRequestAttributesEnabled
in interfaceAccessLog
- Returns:
true
if 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 thepattern
property.- Specified by:
invoke
in 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:AccessLog
Add the request/response to the access log using the specified processing time. -
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
-