Java Virtual Machine Tuning

This document has been updated and ported to Liferay Learn and is no longer maintained here.

Java Virtual Machine (JVM) tuning primarily focuses on adjusting the garbage collector and the Java memory heap. We used Oracle’s 1.8 JVM for the reference architecture. You may choose other supported JVM versions and implementations. Please consult the Liferay DXP Compatibility Matrix for additional compatible JVMs.

Here are the JVM tuning topics:

• Garbage Collector
• Code Cache
• Java Heap
• JVM Advanced Options

Garbage collection is first.

Garbage Collector

Choosing the appropriate garbage collector (GC) helps improve the responsiveness of your Liferay DXP deployment. Use the concurrent low pause collectors:

-XX:+UseParNewGC -XX:ParallelGCThreads=16 -XX:+UseConcMarkSweepGC
-XX:+CMSParallelRemarkEnabled -XX:+CMSCompactWhenClearAllSoftRefs
-XX:CMSInitiatingOccupancyFraction=85 -XX:+CMSScavengeBeforeRemark

You may choose from other available GC algorithms, including parallel throughput collectors and G1 collectors. Start tuning using parallel collectors in the new generation and concurrent mark sweep (CMS) in the old generation.

Note: the ParallelGCThreads value (e.g., ParallelGCThreads=16) varies based on the type of CPUs available. Set the value according to CPU specification. On Linux machines, report the number of available CPUs by running cat /proc/cpuinfo.

Note: There are additional “new” algorithms like G1, but Liferay Engineering’s tests for G1 indicated that it does not improve performance. Since your application performance may vary, you should add G1 to your testing and tuning plans.

Code Cache

Java’s just-in-time (JIT) compiler generates native code to improve performance. The default size is 48m. This may not be sufficient for larger applications. Too small a code cache reduces performance, as the JIT isn’t able to optimize high frequency methods. For Liferay DXP, start with 64m for the initial code cache size.

-XX:InitialCodeCacheSize=64m -XX:ReservedCodeCacheSize=96m

Examine the efficacy of the parameter changes by adding the following logging parameters:

-XX:+PrintCodeCache -XX:+PrintCodeCacheOnCompilation

Java Heap

When most people think about tuning the Java memory heap, they think of setting the maximum and minimum memory of the heap. Unfortunately, most deployments require far more sophisticated heap tuning to obtain optimal performance, including tuning the young generation size, tenuring durations, survivor spaces, and many other JVM internals.

For most systems, it’s best to start with at least the following memory settings:

-server -XX:NewSize=700m -XX:MaxNewSize=700m -Xms2048m -Xmx2048m -XX:MetaspaceSize=512m
-XX:MaxMetaspaceSize=512m -XX:SurvivorRatio=6 -XX:TargetSurvivorRatio=9 -XX:MaxTenuringThreshold=15

On systems that require large heap sizes (e.g., above 4GB), it may be beneficial to use large page sizes. You can activate large page sizes like this:

-XX:+UseLargePages -XX:LargePageSizeInBytes=256m

You may choose to specify different page sizes based on your application profile.

Note: To use large pages in the JVM, you must configure your underlying operating system to activate them. In Linux, run cat /proc/meminfo and look at “huge page” items.

Caution: Avoid allocating more than 32GB to your JVM heap. Your heap size should be commensurate with the speed and quantity of available CPU resources.

JVM Advanced Options

The following advanced JVM options were also applied in the Liferay benchmark environment:

-XX:+UseLargePages -XX:LargePageSizeInBytes=256m 
-XX:+UseCompressedOops -XX:+DisableExplicitGC -XX:-UseBiasedLocking 
-XX:+BindGCTaskThreadsToCPUs -XX:UseFastAccessorMethods

Please consult your JVM documentation for additional details on advanced JVM options.

Combining the above recommendations together, makes this configuration:

-server -XX:NewSize=1024m -XX:MaxNewSize=1024m -Xms4096m
-Xmx4096m -XX:MetaspaceSize=512m -XX:MaxMetaspaceSize=512m
-XX:SurvivorRatio=12 -XX:TargetSurvivorRatio=90
-XX:MaxTenuringThreshold=15 -XX:+UseLargePages 
-XX:LargePageSizeInBytes=256m -XX:+UseParNewGC 
-XX:ParallelGCThreads=16 -XX:+UseConcMarkSweepGC 
-XX:+CMSParallelRemarkEnabled -XX:+CMSCompactWhenClearAllSoftRefs
-XX:CMSInitiatingOccupancyFraction=85 -XX:+CMSScavengeBeforeRemark 
-XX:+UseLargePages -XX:LargePageSizeInBytes=256m
-XX:+UseCompressedOops -XX:+DisableExplicitGC -XX:-UseBiasedLocking
-XX:+BindGCTaskThreadsToCPUs -XX:+UseFastAccessorMethods
-XX:InitialCodeCacheSize=32m -XX:ReservedCodeCacheSize=96m

Caution: The above JVM settings should formulate a starting point for your performance tuning. Every system’s final parameters vary due to many factors, including number of current users and transaction speed.

Monitor the garbage collector statistics to ensure your environment has sufficient allocations for metaspace and also for the survivor spaces. Using the configuration above in the wrong environment could result in dangerous runtime scenarios like out of memory failures. Improperly tuned survivor spaces also lead to wasted heap space.