Overview
Version
FineBI Version |
6.0 |
Application Scenario
Unreasonable memory environment configurations can easily lead tosystem downtime which is difficult to reproduce and troubleshoot.
Function Description
Note:FineBI includes Health Inspection in its built-in System O&M plugin, allowing you to perform the function directly.
Health Inspection can help you inspect whether various configurations in the system are reasonable and optimize your environment configurations for better downtime prevention.
You can manually check or set the FineBI system to auto-check regularly whether various environment configurations in the system are reasonable.
You are messaged if environment configurations are unreasonable.
You are provided with reasonable guidance on improving system environment configurations.
This document introduces the inspection logic and items of Health Inspection.
System Inspection Item
Health Inspection supports system inspection, system operation status inspection, port inspection, network inspection, service connectivity inspection, business inspection, environment inspection, disk inspection, non-containerized deployment inspection, and virtual machine inspection.
Inspection Content | Inspection Item |
System inspection | Only outputs information and no configuration recommendations are provided. The inspection items include operating system information, Glibc/GCC version, hostname, time zone, CPU, clock speed, core quantity, memory size, memory used, available memory, swap, inspection time, root directory disk, and available space of root directory disk. |
System operating status inspection | Plugin information: plugin name, version, and enabled or not Registration authorization information: project registered or not Container version Abnormal project folder size: size of each folder in the WEB-INF folder Temporary output directory: directory path and remaining available space in the directory Project startup path: directory path Whether there is a web.xml file in the WEB-INF folder Project JAR package information: versions of various modules in the project and JAR package dates |
Port inspection | Downtime inspection port: port used by the auto downtime handling tool Cluster port: ports of each node in the cluster WebSocket port: It is mainly used to refresh tokens, check users being kicked out, display platform messages, memory and CPU, check the number of current system online users in the platform log, and determine data connection editing status. |
Network inspection | Checks if the communication between the file server, external database, state server, and application is normal.they can be pinged, and whether there are any packet loss issues. |
Service connectivity inspection | Checks whether the project is connected to Redis components,components, anddatabases. |
Business inspection | finedb: inspects thedatabase type. You are advised to configure an external database. Encoding/character set of the external database: inspects the database encoding/character set of the externaldatabase. Log level: You are advised to set System Log Level to ERROR under System Management > Intelligent O&M > Platform Log > Global Setting. Log cleanup: You are advised to enable Auto Cleanup and set Clearance Frequency to Every3 Months Auto Clear Once under System Management > Intelligent O&M > Platform Log > Global Setting. Limit of disk space occupied by automatic backup: You are advised to limit the disk size that automatic backups can occupy under System Management > Intelligent O&M > Backup & Restoration > Global Setting. Quantity limit of the automatic backup records retained: You are advised to set the automatic backup retention limit to less than 5 records under System Management > Intelligent O&M > Backup & Restoration > Global Setting. Scheduled task cleanup configuration: You are advised to set the file processing method in Task Schedule to keep only the most recent one or to clean up immediately after the task is completed. Cell quantity limit per template: You are advised to enable Template Cell Limit under System Management > Intelligent O&M > Load Management > Template Limit > General Limit. Second-level cache enabling status: You are advised to configure the system second-level cache. Cell quantity limit during Excel import: You are advised to enable Excel Import Limit under System Management > Intelligent O&M > Load Management> Template Limit > General Limit. Load alert enabled: You are advised to enable Intelligent Alert under System Management > Intelligent O&M > Load Management > Load Surveillance. Row quantity limit per dataset: You are advised to enable Dataset Row Limit under System Management > Intelligent O&M > Load Management > Template Limit > General Limit. SQL execution period limit: You are advised to enable SQL Execution Period Limit under System Management > Intelligent O&M > Load Management > Template Limit > General Limit. Cluster parameter configuration: You are advised to configure Internal Forwarding Parameter under System Management > Intelligent O&M > Cluster Configuration > Parameter Configuration. Row quantity limit of memory data: You are advised to set Data Access Volume to less than 1000000 under System Management > System Setting > General > BI Parameter. Cell quantity limit during quick analysis: You are advised to set the DistributedOptimizationConfig.spiderConfig.spider_fast_compute_limit_unit parameter value to less than 10000000. Row quantity limit during quick analysis: You are advised to set the DistributedOptimizationConfig.spiderConfig.spider_fast_compute_limit_row parameter value to less than 10000000. Quantity limit of the updated cell during quick analysis: You are advised to set the DistributedOptimizationConfig.spiderConfig.spider_update_fast_compute_limit_cell parameter value to less than 10000. Memory size limit during quick analysis: You are advised to set the DistributedOptimizationConfig.spiderConfig.spider_fast_compute_limit_memory parameter value to less than 500000000. Memory size limit of spark calculation result: You are advised to set the DistributedOptimizationConfig.spiderConfig.spark_driver_maxResultSize parameter value to less than 10000000. Unlimited period configuration for resource update: It inspects the parameter of Update High Performance Time Interval under System Management > System Setting > General > Spider Parameter. |
Environment inspection | vm.max_map_count: You are advised to configure the vm.max_map_count parameter to 262144. Maximum opened files: You are advised to set the open_files parameter value to more than 65536. overcommit_memory: You are advised to set the vm.overcommit_memory parameter value to 0. overcommit_ratio: You are advised to set the vm.overcommit_ratio parameter value to 50. Glibc memory leak configuration: You are advised to configure export MALLOC_ARENA_MAX=1. |
Disk inspection | Only outputs information and no configuration recommendations. The insepction items include disk space, used disk space, free disk space, sequential read, sequential write, random read, small file creation, and small file deletion. |
Uncontainerized deployment | Only outputs information and no configuration recommendations. The inspection items include process user and server main folder permissions. |
Virtual machine inspection | Physical memory: It outputs information only. On-heap memory: It outputs information only. Off-heap memory occupied by FineIO reading: You are advised to set off-heap memory occupied by FineIO reading to 2 GB for JVM. Off-heap memory occupied by FineIO writing: You are advised to set off-heap memory occupied by FineIO writing to 2 GB for JVM. Headless mode: You are advised to configure -Djava.awt.headless=true to enable headless mode. Dump export: You are advised to configure HeapDumpOnOutOfMemoryError and HeapDumpPath to ensure a normal dump export. DisableExplicitGC parameter: You are advised not to configure the DisableExplicitGC parameter, which may disable System.gc(), reducing system stability. JDK version: You are advised to use V1.8.0_181 or above in JDK8. Stack space: You are advised to set the stack space per thread to less than 1024 KB (namely, the -Xss parameter value less than 1024). Garbage collector type: You are advised to set the garbage collector type to ParallelScavenge for JVM. Ratio of old-generation memory to young-generation memory: You are advised to set the ratio of old-generation to young-generation memory in a heap to 2 (namely, -XX:NewRatio=2). recompilationCutoff parameter: You are advised to set the recompilationCutoff-related parameter value to -1. Debug mode: You are advised to disable debug mode and delete two parameters -agentlib:jdwp and -Xrunjdwp. Xms configuration: You are advised to set Xms to the same size as Xmx. Zip-related configuration -Dsun.zip.disableMemoryMapping: You are advised to configure -Dsun.zip.disableMemoryMapping=true. Language configuration -Duser.country: You are advised to configure -Duser.country=CN. Language configuration -Duser.language: You are advised to configure -Duser.language=zh. Code cache configuration: You are advised to configure -XX:ReservedCodeCacheSize=250m. Installation package deployment: It outputs information only. Stack information: It outputs information only. |
Abnormal items are displayed on the page after inspection.
One-Click Configuration
Unsupported Environment
One-click configuration does not support the following environments.
1. Non-Tomcat deployment environments, such as WAS deployment and WebLogic deployment
2. Environments integrated with FineReport and FineBI
3. Project systems with the self-set setenv file
4. Tomcat projects started as a service
5. Tomcat projects started with an exe file in a Windows environment
6. FineReport projects in the designer environment
7. Environments with 16 GB or less of system physical memory
8. Cluster project environments
Configuration Methods
If the current project environment meets the requirements for one-click configuration and exists inspection items that need one-click configuration, View Recommended Configuration appears in the top left corner of the Health Inspection page.
Click View Recommended Configuration, select the needed items, and click Apply Configurations to configure the values of the exception items with one click. After successful configuration, a prompt "The configuration is applied successfully and takes effect after server restart." appears.
All the exception items are successfully configured after the restart.
Note:1. The supported inspection items for one-click configuration are on-heap memory, off-heap NIO memory, off-heap FineIO memory, garbage collector type, ratio of old-generation memory to young-generation memory, and stack space.
2. If you have no file read and write permission or are unable to modify the configuration file, a prompt "Failed to apply configurations as no read/write permission was granted to the configuration file." appears. Click OK to return to the Health Inspection page.
Inspection Report
An inspection report is generated after each health inspection. You can download the report to the local device or preview it online.
The inspection report displays only the inspection items with issues by default. Besides, you can switch to view all inspection items for different nodes.
Inspection Triggering
Manual Inspection
System configurations are obtained every hour after the system restarts.
When conducting the first health inspection, you need to click Start Inspection. The system automatically performs the inspection, obtains the latest system configurations, and updates the inspection results.
When conducting the health inspection again, you need to click Re-diagnosis. The system automatically performs the inspection, obtains the latest system configuration, and updates the inspection results.
Automatic Inspection
The admin can enable System Auto Inspection and click Save to save the settings on the Health Inspection Handling page.
After the function is enabled, the system automatically inspects whether any unreasonable configuration exists every Sunday at 11 AM. If so, the admin can be notified through SMS, platform message, and mailbox.
Note:1. SMS reminder: You need to enable the SMS platform.
2. Mailbox reminder: You need to configure the mailbox server. For details, see Mailbox.
3. Platform message: You need to configure the WebSocket port and open it at the load-balancing level. For details, see WebSocket Connection Failed.
O&M Tool
Notes
Quick Fix for Abnormalities
Problem:
After you modify the Tomcat memory through the Quick Fix function, Tomcat crashes, and no process appears when you start the project with the command ./startup.sh.
Cause:
Insufficient system memory
Solution:
Delete the setenv.sh file (a configuration file generated when a quick fix is conducted) in the path %TOMCAT_HOME%/bin.
This combination of host and port requires TLS
Problem:
All health inspections failed.
Trigger inspections and open log with info level. An error occurs: This combination of host and port requires TLS.
Cause:
HTTPS is not configured properly in the port.
Solution:
In the fine_conf_entity table of finedb, add a new field ClusterNodeConfig.useHttps, with the field value as true.
