Package org.apache.catalina.valves

Class JDBCAccessLogValve

  • All Implemented Interfaces:
    javax.management.MBeanRegistration, AccessLog, Contained, JmxEnabled, Lifecycle, Valve
    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.

    Author:
    Andre de Jesus, Peter Rossbach

    • Constructor Detail

      • JDBCAccessLogValve

        public JDBCAccessLogValve()
        Class constructor. Initializes the fields with the default values. The defaults are: 
              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;

    • Method Detail

      • 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
        Default is true.
        Specified by:
        setRequestAttributesEnabled in interface AccessLog
        Parameters:
        requestAttributesEnabled - true causes the attributes to be used, false causes the original values to be used.

      • getConnectionName

        public java.lang.String getConnectionName()
        Returns:
        the username to use to connect to the database.

      • setConnectionName

        public void setConnectionName​(java.lang.String connectionName)
        Set the username to use to connect to the database.
        Parameters:
        connectionName - Username

      • setDriverName

        public void setDriverName​(java.lang.String driverName)
        Sets the database driver name.
        Parameters:
        driverName - The complete name of the database driver class.

      • getConnectionPassword

        public java.lang.String getConnectionPassword()
        Returns:
        the password to use to connect to the database.

      • setConnectionPassword

        public void setConnectionPassword​(java.lang.String connectionPassword)
        Set the password to use to connect to the database.
        Parameters:
        connectionPassword - User password

      • setConnectionURL

        public void setConnectionURL​(java.lang.String connectionURL)
        Sets the JDBC URL for the database where the log is stored.
        Parameters:
        connectionURL - The JDBC URL of the database.

      • setTableName

        public void setTableName​(java.lang.String tableName)
        Sets the name of the table where the logs are stored.
        Parameters:
        tableName - The name of the table.

      • setRemoteHostField

        public void setRemoteHostField​(java.lang.String remoteHostField)
        Sets the name of the field containing the remote host.
        Parameters:
        remoteHostField - The name of the remote host field.

      • setUserField

        public void setUserField​(java.lang.String userField)
        Sets the name of the field containing the remote user name.
        Parameters:
        userField - The name of the remote user field.

      • setTimestampField

        public void setTimestampField​(java.lang.String timestampField)
        Sets the name of the field containing the server-determined timestamp.
        Parameters:
        timestampField - The name of the server-determined timestamp field.

      • setVirtualHostField

        public void setVirtualHostField​(java.lang.String virtualHostField)
        Sets the name of the field containing the virtual host information (this is in fact the server name).
        Parameters:
        virtualHostField - The name of the virtual host field.

      • setMethodField

        public void setMethodField​(java.lang.String methodField)
        Sets the name of the field containing the HTTP request method.
        Parameters:
        methodField - The name of the HTTP request method field.

      • setQueryField

        public void setQueryField​(java.lang.String queryField)
        Sets the name of the field containing the URL part of the HTTP query.
        Parameters:
        queryField - The name of the field containing the URL part of the HTTP query.

      • setStatusField

        public void setStatusField​(java.lang.String statusField)
        Sets the name of the field containing the HTTP response status code.
        Parameters:
        statusField - The name of the HTTP response status code field.

      • setBytesField

        public void setBytesField​(java.lang.String bytesField)
        Sets the name of the field containing the number of bytes returned.
        Parameters:
        bytesField - The name of the returned bytes field.

      • setRefererField

        public void setRefererField​(java.lang.String refererField)
        Sets the name of the field containing the referer.
        Parameters:
        refererField - The referer field name.

      • setUserAgentField

        public void setUserAgentField​(java.lang.String userAgentField)
        Sets the name of the field containing the user agent.
        Parameters:
        userAgentField - The name of the user agent field.

      • setPattern

        public void setPattern​(java.lang.String pattern)
        Sets the logging pattern. The patterns supported correspond to the file-based "common" and "combined". These are translated into the use of tables containing either set of fields.

        TO DO: more flexible field choices.

        Parameters:
        pattern - The name of the logging pattern.

      • setResolveHosts

        public void setResolveHosts​(java.lang.String resolveHosts)
        Determines whether IP host name resolution is done.
        Parameters:
        resolveHosts - "true" or "false", if host IP resolution is desired or not.

      • getUseLongContentLength

        public boolean getUseLongContentLength()
        Returns:
        true if content length should be considered a long rather than an int, defaults to false

      • setUseLongContentLength

        public void setUseLongContentLength​(boolean useLongContentLength)
        Parameters:
        useLongContentLength - the useLongContentLength to set

      • invoke

        public void invoke​(Request request,
                   Response response)
            throws java.io.IOException,
                   ServletException
        This method is invoked by Tomcat on each query.
        Specified by:
        invoke in interface Valve
        Parameters:
        request - The Request object.
        response - The Response object.
        Throws:
        java.io.IOException - Should not be thrown.
        ServletException - Database SQLException is wrapped in a ServletException.

      • log

        public void log​(Request request,
                Response response,
                long time)
        Description copied from interface: AccessLog
        Add the request/response to the access log using the specified processing time.
        Specified by:
        log in interface AccessLog
        Parameters:
        request - Request (associated with the response) to log
        response - Response (associated with the request) to log
        time - 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

      • open

        protected void open()
             throws java.sql.SQLException
        Open (if necessary) and return a database connection for use by this AccessLogValve.
        Throws:
        java.sql.SQLException - if a database error occurs

      • close

        protected void close()
        Close the specified database connection.

      • getCurrentTimeMillis

        public long getCurrentTimeMillis()