Memory Modification

FineBI is an intelligent business analysis platform based on a pure B/S architecture. You can deploy FineBI on a server through the web application server to provide a corporate cloud server.

Therefore, there are certain configuration requirements for the server. When the server cannot meet the requirements of BI, a risk of downtime will occur.

You need to modify the memory that can be used and other parameters after FineBI deployment to ensure the stable operation of the server.

Content Classification

The physical memory used by FineBI is divided into Heap memory and direct physical memory.

The memory of the physical machine/cloud host should be at least 16GB. If the physical memory is too small, the computing performance and system stability of FineBI will be seriously affected.

The physical memory BIMax used by FineBI requires: BIMax = Xmx + MaxDirectMemorySize + FineIO + Other. To ensure the stability of the host, the memory used by FineBI (BIMax) needs to be less than or equal to seven-eighths of the user server memory.

You are advised to modify the memory-related configuration settings in the following table.

Memory Configuration Parameter	Description	Recommended Value
Xmx	It can specify the maximum memory size for the Java heap. It can set the upper limit of the heap. When the heap size reaches the value, the JVM will stop allocating new memory and trigger garbage collection.	Suggestions: 8GB <= Xmx < 32 GB or 40GB <= Xmx <= 64GB Note: A parameter value less than 8GB may lead to downtime risks. A parameter value greater than 32GB and less than 40GB may cause serious performance issues. A parameter value greater than 64GB may result in poor performance. You can check the on-heap memory size in Health Inspection.
Xms	It can specify the initial memory size for the Java heap. It can set the initial size of the heap, and the JVM will allocate memory of this size upon startup.	Xms = Xmx is recommended.
MaxDirectMemorySize	It is the off-heap NIO memory, which can specify the maximum size of direct memory. Direct memory, not constrained by the Java heap size, is allocated directly from local memory, rather than within the Java heap.	4GB is recommended. The maximum value is not limited, but the size of the user server memory needs to be considered. The memory used by FineBI (BIMax) needs to be less than or equal to seven-eighths of the user server memory.
Dfineio.read_mem_limit	Memory occupied by FineIO reading	2GB is recommended.
Dfineio.write_mem_limit	Memory occupied by FineIO writing	1GB is recommended.

Memory Overflow Scenario

•  A memory overflow error message is displayed during the template preview with a prompt, saying "java.lang.OutOfMemoryError: Java heap space".

• A prompt is displayed in the Tomcat backend, saying "Memory is over threshold".

• Error message: "gc overhead"

• Error message: "Memory Overflow"

• High memory usage

• Lag appears due to the slow response of the project after prolonged use.

• The prompt "Loading" is displayed frequently during the dashboard preview.

• High pressure on the server

Linux

1. Close the Tomcat server.

2. Enter the bin directory in Tomcat Installation Directory. Find the setenv.sh file. If the file does not exist, create a setenv.sh file.

Note:

Ensure that you have the execution permission on the setenv.sh file. If you do not have the execution permission, use the command chmod +x setenv.sh for configuration.

3. Open the setenv.sh file with a text editor. Add/modify the following lines to the file for configuration:

JAVA_OPTS="$JAVA_OPTS -Xms8192m -Xmx8192m"
JAVA_OPTS="$JAVA_OPTS -XX:MaxDirectMemorySize=2g"
JAVA_OPTS="$JAVA_OPTS -Dfineio.read_mem_limit=2"
JAVA_OPTS="$JAVA_OPTS -Dfineio.write_mem_limit=1"

4. Save and close the setenv.sh file.

5. Restart the Tomcat server to make the modifications take effect.

Windows

1. Close the Tomcat server.

2. Enter the bin directory in Tomcat Installation Directory. Find the setenv.bat file. If the file does not exist, create a setenv.bat file.

3. Open the setenv.sh file with a text editor. Add the following lines to the file for configuration:

set JAVA_OPTS=%JAVA_OPTS% -Xms8192m -Xmx8192m
set JAVA_OPTS=%JAVA_OPTS% -XX:MaxDirectMemorySize=4g
set JAVA_OPTS=%JAVA_OPTS% -Dfineio.read_mem_limit=2
set JAVA_OPTS=%JAVA_OPTS% -Dfineio.write_mem_limit=1

4. Save and close the setenv.bat file.

5. Restart the Tomcat server to make the modifications take effect.

If the project is directly deployed on the operating system, you can directly modify the memory size in the configuration file located in FineBI Installation Directory/bin.

Linux/Windows

1. Close the FineBI Project

1. Enter the bin directory Tomcat Installation Directory. Find the finebi.vmoptions file.

3. Open the finebi.vmoptions file with a text editor, and add/modify the following lines:

-Xms8192m
-Xmx8192m
-XX:MaxDirectMemorySize=4g
-Dfineio.read_mem_limit=2
-Dfineio.write_mem_limit=1

4. Save and close the file. Restart FineBI to make the modifications take effect.

Mac

1. Close the designer.

2. Enter the bin directory in FineReport Installation Directory\bin, right click designer.app, and click Show Package Contents.

3. Open the Content/vmoptions.txt file, and add/modify the following lines:

-Xms8192m
-Xmx8192m
-XX:MaxDirectMemorySize=4g
-Dfineio.read_mem_limit=2
-Dfineio.write_mem_limit=1

4. Save and close the file. Restart FineBI to make the modifications take effect.

Linux

1. Enter the bin directory of WebLogic Domain. Find the setDomainEnv.sh file.

2. Open the setenv.sh file with a text editor. Add the following lines to the file for configuration:

MEM_ARGS="-Xms8g -Xmx8g -XX:MaxPermSize=4g -XX:MaxDirectMemorySize=4g"
MEM_ARGS="-Djava.awt.headless=true -Dfineio.read_mem_limit=2 -Dfineio.write_mem_limit=1"

3. Save and close the setDomainEnv.sh file.

4. Restart the WebLogic server to make the modifications take effect.

Windows

1. Enter the bin directory of WebLogic Domain. Find the setDomainEnv.cmd file.

2. Open the setDomainEnv.cmd file with a text editor. Add the following lines to the file for configuration:

set MEM_ARGS=-Xms8g -Xmx8g -XX:MaxPermSize=4g -XX:MaxDirectMemorySize=4g
set MEM_ARGS=-Djava.awt.headless=true -Dfineio.read_mem_limit=2 -Dfineio.write_mem_limit=1

3. Save and close the setDomainEnv.cmd file.

4. Restart the WebLogic server to make the modifications take effect.

1. Log in to the WebSphere management console as the admin.

2. Choose Servers > Server Types > WebSphere application servers from the navigation bar.

3. Click the application name that needs to be modified, and choose Server Infrastructure > Java and Process Management > Process definition.

4. Click Java Virtual Machine to modify the size of the initial heap and the maximum heap.

5. Add or modify some JVM parameters in Generic JVM arguments.

-Xss1024k
-MaxDirectMemorySize=2096
-Dfineio.read_mem_limit=2
-Dfineio.write_mem_limit=1

6. Click Apply to save the changes to the server configuration after completing the modifications.

7. Restart the WebSphere server to make the modifications take effect.

1. Open the Wildfly installation directory, and navigate to the Wildfly configuration file directory. In Wildfly 10 and later versions, this directory is in the standalone/configuration path.

2. Find the standalone.conf file (Linux) or standalone.conf.bat file (Windows) with a text editor.

3. Find the content related to JVM settings in the opened file. You can set the JVM memory parameter in the JAVA_OPTS variable.