public final class JDBCAccessLogValve extends ValveBase implements AccessLog
This Tomcat extension logs server access directly to a database, and can be used instead of the regular file-based access log implemented in AccessLogValve. To use, copy into the server/classes directory of the Tomcat installation and configure in server.xml as:
<Valve className="org.apache.catalina.valves.JDBCAccessLogValve" driverName="your_jdbc_driver" connectionURL="your_jdbc_url" pattern="combined" resolveHosts="false" />
Many parameters can be configured, such as the database connection (with
driverName
and connectionURL
),
the table name (tableName
)
and the field names (corresponding to the get/set method names).
The same options as AccessLogValve are supported, such as
resolveHosts
and pattern
("common" or "combined"
only).
When Tomcat is started, a database connection is created and used for all the log activity. When Tomcat is shutdown, the database connection is closed. This logger can be used at the level of the Engine context (being shared by all the defined hosts) or the Host context (one instance of the logger per host, possibly using different databases).
The database table can be created with the following command:
CREATE TABLE access ( id INT UNSIGNED AUTO_INCREMENT NOT NULL, remoteHost CHAR(15) NOT NULL, userName CHAR(15), timestamp TIMESTAMP NOT NULL, virtualHost VARCHAR(64) NOT NULL, method VARCHAR(8) NOT NULL, query VARCHAR(255) NOT NULL, status SMALLINT UNSIGNED NOT NULL, bytes INT UNSIGNED NOT NULL, referer VARCHAR(128), userAgent VARCHAR(128), PRIMARY KEY (id), INDEX (timestamp), INDEX (remoteHost), INDEX (virtualHost), INDEX (query), INDEX (userAgent) );
Set JDBCAccessLogValve attribute useLongContentLength="true" as you have more then 4GB outputs. Please, use long SQL datatype at access.bytes attribute. The datatype of bytes at oracle is number and other databases use bytes BIGINT NOT NULL.
If the table is created as above, its name and the field names don't need to be defined.
If the request method is "common", only these fields are used:
remoteHost, user, timeStamp, query, status, bytes
TO DO: provide option for excluding logging of certain MIME types.
Lifecycle.SingleUse
asyncSupported, container, containerLog, next, sm
mserver
PROTOCOL_ATTRIBUTE, REMOTE_ADDR_ATTRIBUTE, REMOTE_HOST_ATTRIBUTE, SERVER_PORT_ATTRIBUTE
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 and Description |
---|
JDBCAccessLogValve()
Class constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
close()
Close the specified database connection.
|
java.lang.String |
getConnectionName()
Return the username to use to connect to the database.
|
java.lang.String |
getConnectionPassword()
Return the password to use to connect to the database.
|
long |
getCurrentTimeMillis() |
boolean |
getRequestAttributesEnabled() |
boolean |
getUseLongContentLength()
get useLongContentLength
|
void |
invoke(Request request,
Response response)
This method is invoked by Tomcat on each query.
|
void |
log(Request request,
Response response,
long time)
Add the request/response to the access log using the specified processing
time.
|
protected void |
open()
Open (if necessary) and return a database connection for use by
this AccessLogValve.
|
void |
setBytesField(java.lang.String bytesField)
Sets the name of the field containing the number of bytes returned.
|
void |
setConnectionName(java.lang.String connectionName)
Set the username to use to connect to the database.
|
void |
setConnectionPassword(java.lang.String connectionPassword)
Set the password to use to connect to the database.
|
void |
setConnectionURL(java.lang.String connectionURL)
Sets the JDBC URL for the database where the log is stored.
|
void |
setDriverName(java.lang.String driverName)
Sets the database driver name.
|
void |
setMethodField(java.lang.String methodField)
Sets the name of the field containing the HTTP request method.
|
void |
setPattern(java.lang.String pattern)
Sets the logging pattern.
|
void |
setQueryField(java.lang.String queryField)
Sets the name of the field containing the URL part of the HTTP query.
|
void |
setRefererField(java.lang.String refererField)
Sets the name of the field containing the referer.
|
void |
setRemoteHostField(java.lang.String remoteHostField)
Sets the name of the field containing the remote host.
|
void |
setRequestAttributesEnabled(boolean requestAttributesEnabled)
Should this valve set request attributes for IP address, hostname,
protocol and port used for the request?
|
void |
setResolveHosts(java.lang.String resolveHosts)
Determines whether IP host name resolution is done.
|
void |
setStatusField(java.lang.String statusField)
Sets the name of the field containing the HTTP response status code.
|
void |
setTableName(java.lang.String tableName)
Sets the name of the table where the logs are stored.
|
void |
setTimestampField(java.lang.String timestampField)
Sets the name of the field containing the server-determined timestamp.
|
void |
setUseLongContentLength(boolean useLongContentLength) |
void |
setUserAgentField(java.lang.String userAgentField)
Sets the name of the field containing the user agent.
|
void |
setUserField(java.lang.String userField)
Sets the name of the field containing the remote user name.
|
void |
setVirtualHostField(java.lang.String virtualHostField)
Sets the name of the field containing the virtual host information
(this is in fact the server name).
|
protected void |
startInternal()
Start this component and implement the requirements
of
LifecycleBase.startInternal() . |
protected void |
stopInternal()
Stop this component and implement the requirements
of
LifecycleBase.stopInternal() . |
backgroundProcess, event, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setContainer, setNext, toString
destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop
public JDBCAccessLogValve()
driverName = null; connectionURL = null; tableName = "access"; remoteHostField = "remoteHost"; userField = "userName"; timestampField = "timestamp"; virtualHostField = "virtualHost"; methodField = "method"; queryField = "query"; statusField = "status"; bytesField = "bytes"; refererField = "referer"; userAgentField = "userAgent"; pattern = "common"; resolveHosts = false;
public void setRequestAttributesEnabled(boolean requestAttributesEnabled)
AccessLogValve
which will otherwise log the original values.
The attributes set are:
true
.setRequestAttributesEnabled
in interface AccessLog
requestAttributesEnabled
- true
causes the attributes
to be set, false
disables
the setting of the attributes.public boolean getRequestAttributesEnabled()
getRequestAttributesEnabled
in interface AccessLog
true
if the attributes will be logged, otherwise
false
AccessLog.setRequestAttributesEnabled(boolean)
public java.lang.String getConnectionName()
public void setConnectionName(java.lang.String connectionName)
connectionName
- Usernamepublic void setDriverName(java.lang.String driverName)
driverName
- The complete name of the database driver class.public java.lang.String getConnectionPassword()
public void setConnectionPassword(java.lang.String connectionPassword)
connectionPassword
- User passwordpublic void setConnectionURL(java.lang.String connectionURL)
connectionURL
- The JDBC URL of the database.public void setTableName(java.lang.String tableName)
tableName
- The name of the table.public void setRemoteHostField(java.lang.String remoteHostField)
remoteHostField
- The name of the remote host field.public void setUserField(java.lang.String userField)
userField
- The name of the remote user field.public void setTimestampField(java.lang.String timestampField)
timestampField
- The name of the server-determined timestamp field.public void setVirtualHostField(java.lang.String virtualHostField)
virtualHostField
- The name of the virtual host field.public void setMethodField(java.lang.String methodField)
methodField
- The name of the HTTP request method field.public void setQueryField(java.lang.String queryField)
queryField
- The name of the field containing the URL part of
the HTTP query.public void setStatusField(java.lang.String statusField)
statusField
- The name of the HTTP response status code field.public void setBytesField(java.lang.String bytesField)
bytesField
- The name of the returned bytes field.public void setRefererField(java.lang.String refererField)
refererField
- The referer field name.public void setUserAgentField(java.lang.String userAgentField)
userAgentField
- The name of the user agent field.public void setPattern(java.lang.String pattern)
TO DO: more flexible field choices.
pattern
- The name of the logging pattern.public void setResolveHosts(java.lang.String resolveHosts)
resolveHosts
- "true" or "false", if host IP resolution
is desired or not.public boolean getUseLongContentLength()
public void setUseLongContentLength(boolean useLongContentLength)
useLongContentLength
- the useLongContentLength to setpublic void invoke(Request request, Response response) throws java.io.IOException, ServletException
invoke
in interface Valve
invoke
in class ValveBase
request
- The Request object.response
- The Response object.java.io.IOException
- Should not be thrown.ServletException
- Database SQLException is wrapped
in a ServletException.public void log(Request request, Response response, long time)
AccessLog
protected void open() throws java.sql.SQLException
java.sql.SQLException
- if a database error occursprotected void close()
protected void startInternal() throws LifecycleException
LifecycleBase.startInternal()
.startInternal
in class ValveBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedprotected void stopInternal() throws LifecycleException
LifecycleBase.stopInternal()
.stopInternal
in class ValveBase
LifecycleException
- if this component detects a fatal error
that prevents this component from being usedpublic long getCurrentTimeMillis()
Copyright © 2000-2018 Apache Software Foundation. All Rights Reserved.