Tomcat Mongo Access Log

Tomcat Mongo Access Log can be used to save tomcat access logs to mongodb. Before start you should got a mongodb installed (MongoDB installation guide).

This project is inspired by two articles:

1. MongoDB is fantastic for logging
2. MongoDB use case - storing log data

Besides, you can also use Tomcat Mongo Access Log Console to query access logs.

Usage

1. Have a Apache Tomcat 7.0.54(or above) installed.
2. Clone and build it with maven. mvn clean package
3. copy target/tomcat-mongo-access-log-${version}.jar to ${TOMCAT_HOME}/lib.
4. Configure MongoAccessLogValve in ${tomcat}/conf/server.xml, ${tomcat}/conf/context.xml or in a context file. Example:

<Valve 
    className="me.chanjar.tomcat.valves.MongoAccessLogValve" 
    uri="mongodb://localhost/tomcat"
    pattern="default" />

If you want to develop based on this project, you can add following maven dependency to pom.xml:

<dependency>
  <groupId>me.chanjar</groupId>
  <artifactId>tomcat-mongo-access-log</artifactId>
  <version>1.0.0</version>
</dependency>

Attributes

MongoAccessLogValve supports the following configuration attributes of AccessLogValve :

1. condition
2. resolveHosts
3. conditionIf
4. excludes
5. pattern. A little different from AccessLogValve, see below
6. requestAttributesEnabled

And some attributes differs from AccessLogValve:

Collection Indexes

While it's hard to determine which fields should be indexed, but MongoAccessLogVavle provide the following indexes when it creates the Collection, so the query performance is not guaranteed. May be it's better to determine how to create index by yourself.

{ sessionId : 1}
{ datetime : -1}
{ user : 1}
{ statusCode : 1}
{ elapsedSeconds : 1}
{ elapsedMilliseconds : 1}
{ bytesSent : 1}
{ url : 1}
{ method : 1}

{ url : 1, datetime : -1}

{ user : 1, statusCode : 1}
{ user : 1, datetime : -1}
{ user : 1, sessionId : 1, statusCode : 1, datetime : -1}
{ user : 1, sessionId : 1, url : 1, statusCode : 1, datetime : -1}

{ sessionId : 1, datetime : -1}
{ sessionId : 1, statusCode : 1}
{ sessionId : 1, statusCode : 1, datetime : -1}
{ sessionId : 1, url : 1, statusCode : 1, datetime : -1}

Patterns

All the pattern of AccessLogValve are supported while MongoAccessLogValve save them in a JSON form.

Shorthand pattern

The shorthand patterns common and combined are also supported.

And MongoAccessLogValve provides two more shorthand patterns:

1. default equivalent to %a %b %l %m %s %S %t %U %T %P %{Referer}i %{User-Agent}i
2. all equivalent to %a %A %b %B %h %H %l %m %p %q %r %s %S %t %u %U %v %D %T %I %P %{Referer}i %{User-Agent}i