| | The settings in this section apply specifically to the Oracle/Sun JVM. Other JVMs may or may not have equivalent settings. For a list of supported JDK/JVMs and application servers, see the TIBCO Jaspersoft Platform Support document. |
You may need to set the following options for your JVM:
| • | Memory – Java Virtual Machine (JVM) runtime parameters normally need to be explicitly set so that the memory settings have values larger than the default settings. The options and values depend on your version of Java and the application server you use. You may need to increase the memory assigned for the JVM according to your usage. |
| • | Garbage collection – You may need to tune garbage collection for your JVM, depending on your memory and CPU usage as well as JasperReports Server throughput. Different collectors have different performance characteristics. Consult the documentation for your JVM for information on available collectors. |
| • | Date format in Java 11 – Java 11 changed the default date format to conform to CLDR 33. If you are running on Java 11 and want backwards compatibility with Java 8 date formatting, you need to set -Djava.locale.providers=COMPAT on all nodes. |
Tomcat and JBoss JVM Options
The following tables present some typical settings of JVM options that affect JasperReports Server. For information about changing a JVM option setting for your particular environment, see your application server documentation.
| JVM Options on Windows (64 bit) | |
| Options for all app servers | set JAVA_OPTS=%JAVA_OPTS% -Xms2048m -Xmx4096m -Xss2m set JAVA_OPTS=%JAVA_OPTS% -XX:+UseConcMarkSweepGC |
| Java 11 | set JAVA_OPTS=%JAVA_OPTS% -Djava.locale.providers=COMPAT |
JasperReports Server doesn’t provide a virtual X frame buffer on Linux. If your Linux applications are graphical, set the ‑Djava.awt.headless=true to prevent Java from trying to connect to an X Server for image processing.
| JVM Options on Linux and Mac OSX (64 bit) | |
| Options for all app servers | export JAVA_OPTS="$JAVA_OPTS -Xms2048m -Xmx4096m -Xss2m" export JAVA_OPTS="$JAVA_OPTS -XX:+UseConcMarkSweepGC" |
| Java 11 | export JAVA_OPTS="$JAVA_OPTS -Djava.locale.providers=COMPAT" |
You can set JVM options multiple ways. Sections “Changing JVM Options for Tomcat as a Windows Service” - “Setting JVM Options for Application Servers” present step-by-step instructions for performing this task. Alternatively, you can add your JAVA_OPTS settings to any of the following files.
| File | Add JVM Options After This Line on Windows |
| <tomcat>binsetclasspath.bat | set JAVA_ENDORSED_DIRS=%BASEDIR%commonendorsed |
| <tomcat>binsetenv.bat | JAVA_OPTS setting can go anywhere in this file. |
| <jboss>binstandalone.conf.bat | Find the existing JAVA_OPTS line, remove the default memory settings from this line, and add a new line with the recommended JAVA_OPTS after this line. For example, you might remove the following default settings: -Xms64m -Xmx512m -XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m Then add the recommended settings on a new line. We recommend that you do not set MaxMetaspaceSize. |
| File | Add JVM Options After This Line on Linux |
| <tomcat>/bin/setclasspath.sh | JAVA_ENDORSED_DIRS="$BASEDIR"/common/endorsed |
| <tomcat>/bin/setenv.sh | JAVA_OPTS setting can go anywhere in this file. |
| <jboss>/bin/standalone.conf | Find the existing JAVA_OPTS line, remove the default memory settings from this line, and add a new line with the recommended JAVA_OPTS after this line. For example, you might remove the following default settings: -Xms64m -Xmx512m -XX:MetaspaceSize=96M -XX:MaxMetaspaceSize=256m Then add the recommended settings on a new line. We recommend that you do not set MaxMetaspaceSize. |
Changing JVM Options for Tomcat as a Windows Service
If you installed JasperReports Server to use Tomcat running as a Windows service, you can set Java options on the Java Tab of the Tomcat Properties dialog:
| 1. | Launch the Tomcat configuration application. If you installed the bundled Tomcat, you can do this by going to the <js-install>/apache-tomcat/bin directory and double-clicking the jasperreportsTomcat.exe file. (If you have multiple instances of JasperReports Server installed, the file name will be of the form jasperreportsTomcatnum<number>.exe, for example, jasperreportsTomcatnum2.exe.) If you installed Tomcat using an existing Windows service, look for an .exe file in the same location, with the same name as your Tomcat service, or select the service from the Windows Start menu: |
Start > Programs > Apache Tomcat > Configure Tomcat (Run as administrator)
| 2. | In the Apache Tomcat Properties dialog, click the Java tab. |
| 3. | In the Java Options field, add your JAVA_OPTS values according to the tables above. |
Enter only the options preceded by -X or -D, not set JAVA_OPTS=%JAVA_OPTS%.
Enter only one Java option setting per line.
| 4. | For instance, add options as follows: |
-Xms2048m-Xmx4096m-Xss2m[/code] |
| 5. | Click Apply, then click OK. |
| 6. | Stop and restart Tomcat. |
Changing JVM Options for Bundled Tomcat on Linux
If you installed the bundled Tomcat, you can set Java options by editing the appropriate Tomcat configuration script. The steps to change JVM options are:
| 1. | Open the following file for editing: |
cd <js-install>/apache-tomcat/scripts/ctl.sh
| 2. | Look for the start_tomcat() function and locate the JAVA_OPTS variable inside it. |
| 3. | Modify the JAVA_OPTS values according to the tables above. For example: |
start_tomcat() { is_tomcat_running ... export JAVA_OPTS="-Xms2048m -Xmx4096m" export JAVA_OPTS="-Xss2m -XX:+UseConcMarkSweepGC" ...}[/code] |
| | There may be more than one occurrence of the Java_OPTS variable in the ctl.sh file. Make sure you edit the instance inside the start_tomcat() function. |
| 4. | Save and close the ctl.sh file. |
| 5. | Stop and restart PostgreSQL and Tomcat as described in Starting and Stopping the Server. |
Recommended Comments
There are no comments to display.