org.apache.catalina.valves
public final class JDBCAccessLogValve extends ValveBase implements Lifecycle
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 (with autoReconnect option) 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.
Field Summary | |
---|---|
protected String | connectionName
The connection username to use when trying to connect to the database. |
protected String | connectionPassword
The connection URL to use when trying to connect to the database. |
protected Driver | driver
Instance of the JDBC Driver class we use as a connection factory. |
protected static String | info
The descriptive information about this implementation. |
protected LifecycleSupport | lifecycle
The lifecycle event support for this component. |
protected boolean | useLongContentLength
Use long contentLength as you have more 4 GB output. |
Constructor Summary | |
---|---|
JDBCAccessLogValve()
Class constructor. |
Method Summary | |
---|---|
void | addLifecycleListener(LifecycleListener listener)
Adds a Lifecycle listener.
|
protected void | close()
Close the specified database connection. |
LifecycleListener[] | findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. |
String | getConnectionName()
Return the username to use to connect to the database.
|
String | getConnectionPassword()
Return the password to use to connect to the database.
|
long | getCurrentTimeMillis() |
boolean | getUseLongContentLength()
get useLongContentLength |
void | invoke(Request request, Response response)
This method is invoked by Tomcat on each query.
|
protected void | open()
Open (if necessary) and return a database connection for use by
this AccessLogValve.
|
void | removeLifecycleListener(LifecycleListener listener)
Removes a Lifecycle listener.
|
void | setBytesField(String bytesField)
Sets the name of the field containing the number of bytes returned.
|
void | setConnectionName(String connectionName)
Set the username to use to connect to the database.
|
void | setConnectionPassword(String connectionPassword)
Set the password to use to connect to the database.
|
void | setConnectionURL(String connectionURL)
Sets the JDBC URL for the database where the log is stored.
|
void | setDriverName(String driverName)
Sets the database driver name.
|
void | setMethodField(String methodField)
Sets the name of the field containing the HTTP request method.
|
void | setPattern(String pattern)
Sets the logging pattern. |
void | setQueryField(String queryField)
Sets the name of the field containing the URL part of the HTTP query.
|
void | setRefererField(String refererField)
Sets the name of the field containing the referer.
|
void | setRemoteHostField(String remoteHostField)
Sets the name of the field containing the remote host.
|
void | setResolveHosts(String resolveHosts)
Determines whether IP host name resolution is done.
|
void | setStatusField(String statusField)
Sets the name of the field containing the HTTP response status code.
|
void | setTableName(String tableName)
Sets the name of the table where the logs are stored.
|
void | setTimestampField(String timestampField)
Sets the name of the field containing the server-determined timestamp.
|
void | setUseLongContentLength(boolean useLongContentLength) |
void | setUserAgentField(String userAgentField)
Sets the name of the field containing the user agent.
|
void | setUserField(String userField)
Sets the name of the field containing the remote user name.
|
void | setVirtualHostField(String virtualHostField)
Sets the name of the field containing the virtual host information
(this is in fact the server name).
|
void | start()
Invoked by Tomcat on startup. |
void | stop()
Invoked by tomcat on shutdown. |
Since: 6.0.15
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;
Parameters: listener The listener to add.
Parameters: request The Request object. response The Response object.
Throws: IOException Should not be thrown. ServletException Database SQLException is wrapped in a ServletException.
Throws: SQLException if a database error occurs
Parameters: listener The listener to remove.
Parameters: bytesField The name of the returned bytes field.
Parameters: connectionName Username
Parameters: connectionPassword User password
Parameters: connectionURL The JDBC URL of the database.
Parameters: driverName The complete name of the database driver class.
Parameters: methodField The name of the HTTP request method field.
TO DO: more flexible field choices.
Parameters: pattern The name of the logging pattern.
Parameters: queryField The name of the field containing the URL part of the HTTP query.
Parameters: refererField The referer field name.
Parameters: remoteHostField The name of the remote host field.
Parameters: resolveHosts "true" or "false", if host IP resolution is desired or not.
Parameters: statusField The name of the HTTP response status code field.
Parameters: tableName The name of the table.
Parameters: timestampField The name of the server-determined timestamp field.
Parameters: useLongContentLength the useLongContentLength to set
Parameters: userAgentField The name of the user agent field.
Parameters: userField The name of the remote user field.
Parameters: virtualHostField The name of the virtual host field.
Throws: LifecycleException Can be thrown on lifecycle inconsistencies or on database errors (as a wrapped SQLException).
Throws: LifecycleException Can be thrown on lifecycle inconsistencies or on database errors (as a wrapped SQLException).