Go to file

Ranjith Manickam aa52190ed1 Updated configuration properties.		6 years ago
src	Bug fixes and added redis sentinel supportability changes.	6 years ago
.gitignore	Updated intellij files.	6 years ago
README.md	Updated configuration properties.	6 years ago
pom.xml	Bug fixes and added redis sentinel supportability changes.	6 years ago

README.md

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:

Pre-requisite:

jedis.jar
commons-pool2.jar
commons-logging.jar

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

Steps to be done,

Move the downloaded jars to tomcat/lib directory
- tomcat/lib/
Add tomcat system property "catalina.base"
- catalina.base="TOMCAT_LOCATION"
  - example: export catalina.base=/opt/tomcat
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
Add the below two lines in tomcat/conf/context.xml
- <Valve className="tomcat.request.session.redis.SessionHandlerValve" />
- <Manager className="tomcat.request.session.redis.SessionManager" />
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:

<html>

Property	Description	Value
redis.hosts	Redis server running instance IP address and port number	default: 127.0.0.1:6379 ex: 127.0.0.1:6379, 127.0.0.2:6379, 127.0.0.2:6380, ....
redis.password	Redis protected password
redis.database	Redis database selection. (Numeric value)	default: 0
redis.timeout	Redis connection timeout	default: 2000
redis.cluster.enabled	To enable redis cluster mode	default: false supported values: true/false
redis.sentinel.enabled	To enable redis sentinel mode	default: false supported values: true/false
redis.sentinel.master	Redis sentinel master name	default: mymaster
lb.sticky-session.enabled	To enable redis and standard session mode If enabled, Must be enabled sticky session in your load balancer configuration. Else this manager may not return the updated session values Session values are stored in local jvm and redis If redis is down/not responding, requests uses jvm stored session values to process user requests. Redis comes back the values will be synced	default: false

</html>