Tomcat Clustering Redis Session Manager

Redis session manager is pluggable one. It uses to store sessions into Redis for easy distribution of HTTP Requests across a cluster of Tomcat servers. Sessions are implemented as as non-sticky i.e, each request is forwarded to any server in round-robin manner.

The HTTP Requests session setAttribute(name, value) method stores the session into Redis (session attribute values must be Serializable) immediately and the session getAttribute(name) method request directly from Redis. Also, the inactive sessions has been removed based on the session time-out configuration.

Supports redis default, sentinel and cluster mode, based on the configuration.

Going forward, we no need to enable sticky session (JSESSIONID) in Load balancer.

Supports:

• Apache Tomcat 7
• Apache Tomcat 8
• Apache Tomcat 9

Downloads:

• latest version (3.0)
• older versions

Pre-requisite:

1. jedis.jar
2. commons-pool2.jar
3. commons-logging.jar

more details.. https://github.com/ran-jit/tomcat-cluster-redis-session-manager/wiki

Steps to be done,

1. Move the downloaded jars to tomcat/lib directory

   • tomcat/lib/

2. Add tomcat system property "catalina.base"

   • catalina.base="TOMCAT_LOCATION"
     • edit the tomcat/bin/catalina.sh add JAVA_OPTS for example:

     JAVA_OPTS='-Dcatalina.base=/opt/tomcat'
     

3. Extract downloaded package (tomcat-cluster-redis-session-manager.zip) to configure Redis credentials in redis-data-cache.properties file and move the file to tomcat/conf directory

   • tomcat/conf/redis-data-cache.properties

4. Add the below two lines in tomcat/conf/context.xml

   • <Valve className="tomcat.request.session.redis.SessionHandlerValve" />
   • <Manager className="tomcat.request.session.redis.SessionManager" />

5. Verify the session expiration time in tomcat/conf/web.xml

   • <session-config>
   •         <session-timeout>60</session-timeout>
   • </session-config>

Note:

• All your session attribute values must implement java.io.Serializable.
• Supports redis default, sentinel and cluster mode, based on the redis-data-cache.properties configuration.

Configuration Properties: