I. Overview
1. Version
| Report Server Version | JAR Package | Function Changes |
|---|---|---|
| 10.0 | 2020-04-26 | Provide functions in the plugin form of 「system check plugin」 |
| 10.0.16 | - | Plug-in functions are directly built into the product |
| 10.0.17 | - | Check items and check logic update, please refer to: system check extended content |
| 10.0.19 | 2022-03-01 | Add a value that supports one click configuration of detection items |
2. Application scenarios
If the memory environment configuration is unreasonable, it is very easy to cause downtime of the reporting system, and such downtime is difficult to reproduce, and it is difficult to troubleshoot.
3. Function introduction
「System Check」can help users check whether the various configurations in the system are reasonable, to assist users in optimizing the environment configuration, and to better prevent the occurrence of downtime.
User manual check/the platform regularly checks whether the various environmental configurations of the reporting system are reasonable
When the system environment configuration is unreasonable, push messages to users
Provide users with reasonable improvement guidance for system environment configuration
II. Plugin introduction
For report projects of versions prior to 10.0.16, a plugin needs to be installed to obtain the "system check" function.
Report projects of 10.0.16 and later versions have built-in functions directly without installing plugins.
1. Install the plugin
Click to download the plugin: System Check Plugin.zip
For the installation method of the designer plugin, please refer to: Plugin Management
For the installation method of the server plugin, Server plugin management
2. Introduction to the interface
The administrator logs in to the decision-making platform clicks Manage>Intelligent Operations>System Check, as shown in the figure below:
III. Check the content
The system checks has the following seven items:
In-heap memory, Spare memory, Off-heap memory, Free disk space,Garbage collector type,The ratio of the old age to the new age in the heap,Stack space
The inspection result includes Check Items, Current Configuration, Proposed changes, and Status. As shown below:
The check results and improvement suggestions are shown in the following table:
Note 1: This article only introduces the check items of 10.0.16 and earlier versions. For the system check items and check logic of 10.0.17 and later versions, please refer to:System Check Extended Content
Note 2: For the modification method of each check item, please refer to: Modify FineReport configuration parameters
| Check Item | Check Results | Improvement Suggestions |
|---|---|---|
| In-heap memory | The actual memory used by the user matches the recommended memory | This configuration is good, no need to adjust |
| The actual memory used by the user does not match the recommended memory | Different configurations give different opinions. | |
| Spare memory | When the physical memory minus the container memory is greater than or equal to 10GB | This configuration is good, no need to adjust |
When the physical memory minus the container memory is less than 10GB | It is recommended that the total memory of the physical machine minus the memory used by the container where the system is located should not be less than 10GB | |
| Off-heap memory | MaxDirectMemorySize usage less than or equal to 4GB | This configuration is good, no need to adjust |
MaxDirectMemorySize usage greater than 4GB | It is recommended that JVM NIO use up to 4GB of memory | |
| Free disk space | The remaining space of the disk where the project is located is greater than or equal to 5GB | This configuration is good, no need to adjust |
The remaining space of the disk where the project is located is less than 5GB | It is recommended that JVM use the garbage collector type as ParallelScavenge | |
Garbage collector type | GC type is ParallelScavenge | This configuration is good, no need to adjust |
| GC type is not ParallelScavenge | It is recommended that the size ratio of the old generation to the new generation of JVM be set to 2 | |
The ratio of the old generation to the new generation in the heap | The size ratio of the old generation to the young generation in the heap is 2 (-XX:NewRatio=2, the default value of JVM | This configuration is good, no need to adjust |
The ratio of the size of the old generation to the young generation in the heap is not 2 | It is recommended that the remaining space of the disk where the system is located should not be less than 5G, please clean up in time | |
| Stack space | -Xss value is less than or equal to 512 | This configuration is good, no need to adjust |
| -Xss value is greater than 512 | It is recommended that a single thread uses no more than 512KB of stack space |
Note 1: If the current configuration cannot be detected, the current configuration is empty, and the modification comment is "This item is not currently supported". Click "Details" behind the status to view the specific reasons.
Note 2: If the system is a cluster environment, you can select specific cluster nodes for testing in the upper left corner of the "System Check" page.
IV. One click configuration
2022-03-01 and later versions support one key configuration and system check recommended values.
4.1 unsupported environment
The one click configuration function is not supported for the following environments:
1) Non Tomcat deployment environments do not support one click configuration and system check recommendations, such as was deployment and Weblogic deployment.
2) Finereport is an integrated environment with finebi, which does not support one click configuration of recommended values for system check.
3) If there is a setenv file set by yourself in the engineering system, it does not support one click configuration of recommended values for system inspection.
4) Tomcat projects started in the form of services do not support one click configuration of recommended values for system checks.
5) The Tomcat project launched by exe under Windows environment does not support one click configuration of recommended values for system check.
6) The finereport project in the designer environment does not support one click configuration of system check recommended values.
7) The environment with physical memory of 16 GB or less does not support one click configuration of the recommended value for system check.
8) In the cluster engineering environment, the recommended value of system check for one click configuration is not supported.
4.2 configuration method
If the current engineering environment meets the requirements of one click configuration and there are check items requiring one click configuration, the button "view recommended configuration" will appear in the upper left corner of the "system check" page.
Click "view suggested configuration" to check the check items to be configured. Click "application configuration" to configure the value of abnormal items with one click. After the configuration is successful, the prompt "application configuration is successful, and it will take effect after restarting the server" will pop up.
After the report project is restarted, it can be found that all the abnormal items have been configured successfully.
Note 1: the check items that support one click configuration are: in heap memory, out of heap NiO memory, out of heap fineio memory, garbage collector type, old generation to new generation ratio, stack space.
Note 2: if you do not have file read / write permission or cannot modify the configuration file, you will be prompted with "failed to apply configuration: you do not have read / write permission to the configuration file". Click "OK" to modify the configuration file and return to the system check interface.
V. Trigger check
1. Manual check
After the system restarts, the system configuration status is obtained every hour.
When the administrator logs in to the decision-making system and opens the System Check page, the system automatically checks to obtain the latest system configuration and update the check result.
2. Automatic check
On the System Check page, the administrator can open the System automatic check and save it.
After it is turned on, the system will automatically check at 1:00 am every day. When there is an unreasonable configuration, the administrator can be notified through three forms: SMS Reminder, Platform Message, and Email Reminder.
Note:
1) SMS Reminder: You need to open the SMS platform, click SMS Service for details
2) Email reminder: Need to configure a mail server, click Email Service for details
3) Platform message: The websocket port needs to be configured and opened at the load balancing level, related documents: Websocket Port is occupied
