Modifying Component Configuration

  • Last update: 2026-04-20
  • Overview

    Version

    FineOps Version
    Functional Change
    V1.5.5
    /
    V2.1.0

    Optimized the configuration modification operation to ensure reasonable adjustments (since various memory configurations were correlated).

    V2.11.0

    Updated memory configuration validation logic for FineBI 6.1 related components.

    V2.12.0

    Made the default FineIO read memory and write memory to 0 for projects where the Elasticsearch component was disabled.

    V2.25.0

    Allowed setting the Java memory CodeCache to at most 2 GB.

    Application Scenario 

    Scenario 1: Demand for a reasonable allocation of CPU and memory for components

    You have deployed a containerized project on the server, but found that the performance of the Elasticsearch component was poor as the fr component has occupied all of the CPU resources, resulting in insufficient memory allocated to the Elasticsearch component.

    Scenario 2: Demand for rapid modification of component configuration on the page

    After deploying a project, you need to regularly maintain the FR/BI components, external MySQL database, load balancer Nginx, and state server Redis, including operations such as Redis cache cleanup and JVM memory adjustment. 

    Performing these operations requires writing commands or modifying configuration files, which is troublesome.

    Function Description 

    FineOps provides the Modify Configuration function for you to quickly adjust and modify the project configuration.

    iconNote:

    For FineOps-deployed FanRuan applications, component configurations should only be modified through Component Management and related functions in FineOps. 

    Other backend manual configuration adjustment methods (for example, manually modifying the nginx.conf file) are neither recommended nor supported, as they may cause configurations to be lost after project upgrades, for which technical support does not provide maintenance guidance.

    011.png

    Procedure 

    Prerequisite 

    This function is valid for FineOps-deployed projects only.

    008.png

    This function is valid for components in a running status. If the component is stopped, start the component.

    013(1).png

    Modifying the Configuration 

    Log in to FineOps as the admin, select an O&M project, and choose Maintenance > Component Management.

    Click the Modify Configuration button of the target component to access the configuration modification page.

    017(1).png

    Modify the configuration and click OK.

    015(1).png

    The configuration items are described in the following table.

    iconNote:

    1. This document does not cover the modification of the SSL configuration. For details, see Enabling SSL for O&M Project

    2. This document only lists configuration values supported by the system, which are not necessarily recommended values. You are not advised to modify them arbitrarily. You can first use the System Inspection function to check configurations, and then adjust them as recommended.

    Component

    Configuration Available for 

    Modification

    Description

    FineBI - Application Node, Engine - Calculation Node, and Engine - Metadata Node

     


    CPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    When the memory reaches its limit, components will be automatically restarted. Refrain from imposing restrictions on components with continuous business requirements.

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    The container memory size must meet the current JAVA memory configuration, that is:

    The memory of the bi-web container must be at least 4/3 * (Xmx value + Off-heap memory + CodeCache configuration + Metaspace memory). 

    The memory of the bi-engine-worker container must be at least 8/7 * (Xmx value + Off-heap memory + CodeCache configuration + Metaspace memory). 

    The memory of the bi-engine-master container must be at least 4/3 * Xmx value.

    Xmx

    Enter a number greater than zero.

    Use the System Inspection function in Health Inspection to view the recommended values.

    Modifying these values will trigger a validation of the memory setting.

    Xms
    Off-Heap Memory

    Metaspace Memory

    CodeCache Configuration

    Enter a number greater than zero. 

    You can set CodeCache to at most 2 GB. 

    Use the System Inspection function in Health Inspection to view the recommended values. 

    Modifying this value will trigger a validation of the previous memory value.

    Week Start Day

    This setting is only supported for the Engine - Calculation Node component.

    Modification is not recommended. Contact FanRuan technical support for assistance if needed.

    • Default value: sunday

    • Supported value: sunday and monday

    Sort SettingThis setting is only supported for the Engine - Calculation Node and Engine - Metadata Node components.

    Modification is not recommended. Contact FanRuan technical support for assistance if needed. 

    • Default value: bytes

    It disables Chinese sorting. Sorting is performed based on the binary representation (byte values) of the characters. 

    • Supported value: bytes and pinyin

    Max. Thread Pool for HTTP

    Enter a number greater than zero.

    Queuing Thread Pool for HTTP
    Max. Thread Pool for Chart
    FineReport and FineDataLinkCPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    When the memory reaches its limit, components will be automatically restarted. Refrain from imposing restrictions on components with continuous business requirements.

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    Container memory must satisfy the current JAVA memory configuration. That is, the container memory must be at least Xmx value + Off-heap memory + FineIO read memory + FineIO write memory + CodeCache configuration + Metaspace memory + 1 GB.

    Xmx

    Enter a number greater than zero.

    Use the System Inspection function in Health Inspection to view the recommended values.

    Modifying these values will trigger a validation of the memory setting.

    Xms
    Off-Heap Memory

    Metaspace Memory

    CodeCache Configuration

    Enter a number greater than zero. 

    You can set CodeCache to at most 2 GB. 

    Use the System Inspection function in Health Inspection to view the recommended values. 

    Modifying this value will trigger a validation of the memory value.

    FineIO Read Memory

    For projects with the Elasticsearch component disabled, the default FineIO read memory is 2 GB, and the write memory is 1 GB.

     For projects with the Elasticsearch component enabled, the default FineIO read memory and write memory are 0, and no modification is needed. If you need to disable the Elasticsearch component, you are advised to configure the FineIO read memory and write memory.

    FineIO Write Memory
    Max. Thread Pool for HTTP

    Enter a number greater than zero.

    Queuing Thread Pool for HTTP
    Max. Thread Pool for Chart
    MySQL
    CPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    When the memory reaches its limit, components will be automatically restarted. Refrain from imposing restrictions on components with continuous business requirements.

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    character_set_server

    The encoding of the database server (mysqld), for example, utf8mb4. It needs to be modified together with collation-server.

    collation-server

    The default sorting order of the database server, for example, utf8mb4_bin. It needs to be modified together with character_set_server.

    max_allowed_packet

    The maximum data size that the client or the database server can accept, for example, 128 MB.

    Write Timeout

    Modify the value of net_write_timeout, for example, 1000 (unit: ms).

    Maximum Connection Timeout Count

    Modify the value of global max_connect_errors, for example, 1000.

    RedisCPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    When the memory reaches its limit, components will be automatically restarted. Refrain from imposing restrictions on components with continuous business requirements.

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    The container memory size must satisfy the current memory configuration, that is, it must be greater than or equal to 1.5 times the value of maxmemory.

    iconNote:

    For the FineOps-deployed Redis component, the default memory policy is noeviction, which does not automatically clean or delete any keys to free memory. Therefore, when the Redis memory exceeds the limit, you are advised to increase the Redis maxmemory value first, and then increase the container memory.

    maxmemory-policy

    Modify the Redis memory policy, for example, volatile-lru.

    The default memory policy is noeviction. If the maximum memory limit of Redis is reached, Redis will not automatically evict or delete any keys to free up memory, and all new write requests will be rejected. This option helps protect critical data in the Redis instance from accidental deletion.

    maxmemory

    Modify the Redis memory (unit: GB).

    Modifying these values will trigger a validation of the Redis memory setting.

    iconNote:
    For the FineOps-deployed Redis component, the default memory policy is noeviction, which does not automatically clean or delete any keys to free memory. Therefore, when the Redis memory exceeds the limit, you are advised to increase the Redis maxmemory value first, and then increase the container memory.
    stop-writes-on-bgsave-error

    Set whether to stop data writes in case of Redis snapshot failure.

    Option: yes, and no.

    NginxCPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    When the memory reaches its limit, components will be automatically restarted. Refrain from imposing restrictions on components with continuous business requirements.

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    client_max_body_size

    Set the maximum size of data that can be uploaded by users according to business requirements. The default value is 100 MB.

    proxy_buffer_sizeSet the size of the buffer, for example, 64 KB.
    proxy_buffers

    Set the number and size of buffers for each connection in a format of number size, for example, 32 64 KB.

    proxy_busy_buffers_size

    When buffering response is enabled, nginx will always send responses to the customer if the buffer size reaches a certain threshold before the entire response is read. The response will only stop when the buffer size decreases below this value, for example, 64 KB.

    proxy_connect_timeout

    Set the timeout duration for the nginx component connecting to the backend server. It is the duration of establishing a connection, not the duration of waiting for a response from the backend. For example, set it to 60 s.

    proxy_read_timeout

    Set the read timeout duration, which defaults to 60 s.

    If the server does not receive the data within the period, it is considered as timeout.

    If no large data calculations or exported templates exist, a timeout duration of no more than 100 s is recommended.

    If large data calculations and exported templates exist, set this value based on the longest template time.

    proxy_send_timeout

    Set the write timeout duration, which defaults to 60 s.

    If the server does not receive the data within the period, it is 

    considered as timeout.

    If no large data calculations or exported templates exist, a timeout duration of no more than 100 s is recommended.

    If large data calculations and exported templates exist, set this value based on the longest template time.

    ElasticsearchCPU

    After successfully modifying the Elasticsearch component configuration, the component will automatically restart for the changes to take effect. Restarting components may affect the normal operation of the project. Do not perform any operations while the system is in use. 

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    After successfully modifying the Elasticsearch component configuration, the component will automatically restart for the changes to take effect. Restarting components may affect the normal operation of the project. Do not perform any operations while the system is in use. 

    If the memory reaches its limit, components will automatically restart. Refrain from imposing restrictions on components with continuous business requirements. 

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    The container memory size must satisfy the current memory configuration, that is, it must be greater than or equal to 1.5 times the value of Xmx.

    Xmx

    After successfully modifying the Elasticsearch component configuration, the component will automatically restart for the changes to take effect. Restarting components may affect the normal operation of the project. Do not perform any operations while the system is in use.  

    Enter a number greater than zero.

    Modifying these values will trigger validation of the Elasticsearch memory setting.

    Other 

    components

    CPU

    The default value is the minimum size of CPU required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container CPU size cannot exceed the server CPU size.

    Memory

    If the memory reaches its limit, components will automatically restart. Refrain from imposing restrictions on components with continuous business requirements. 

    The default value is the minimum size of memory required for the component operation, and the recommended value is twice the minimum value.

    Enter a number greater than zero.

    The container memory size cannot exceed the server memory size.

    Restarting the Component 

    The component will automatically restart if the configuration of the Elasticsearch component has been modified. Other configuration changes require you to restart the component manually.

    Restarting components may affect the normal operation of the project. Do not perform any operations while the system is in use.

    Modify the configuration as the admin, return to the Component Management page, and click the Restart button of the corresponding component.

    010_副本(1).png

    Attachment List


    Theme: Project Management
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy