Introduction to Log

  • Last update:  2022-08-03
  • Ⅰ. Overview

    1. Version

    BI server version

    Functional changes

    5.1

    -

    5.1.15

    In Section 2.3, the "Clean System Log" function adds an anti-swipe mechanism

    Section 3.3, "Log Cleanup" renamed "Operation Log Cleanup"

    2. Function introduction

    When the FineBI project runs, relevant log files will be generated for recording.

    log type

    log storage

    log content

    System log

    Stored in %BI_HOME%\logs\fanruan.log by default

    Modifying the log storage location is not allowed

    Record some information during system operation

    Log data computation execution logs in self-service datasets/dashboards

    According to the data type, it is divided into: real-time data log / extracted data log

    Operation log

    Stored in %BI_HOME%\webapps\webroot\logs\cubes

    Allow modification of log storage location

    Record the usage actions of ordinary users and administrators

    Record statistical logs such as data decision system usage, user behavior, template access, etc.

    Ⅱ. System log

    The system log records some information during the operation of the system.

    The log is stored in the %BI_HOME%\logs\fanruan.log file, and the log file catalina.out of the Tomcat server is also generated. Modifying the server project log storage location is not supported.

    1. Introduction to log levels

    There are five system log output levels: DEBUG, INFO, WARN, ERROR, and FATAL.

    • Log level size order (severity): FATAL>ERROR>WARN>INFO>DEBUG

    • Log verbosity sorting: FATAL<ERROR<WARN<INFO<DEBUG


    Log level

    Introduction

    DEBUG (debug)

    Pointing out fine-grained information events is very helpful for debugging applications, mainly for printing some running information during development.

    Note: If the log output level is set to DEBUG mode, there may be no console display or a black screen after BI is started due to excessive log printing. If you need to use DEBUG mode, it is recommended to deploy BI on tomcat.

    INFO (Information)

    Highlight the running process of the application at a coarse-grained level, printing some interesting or important information.

    It can be used in the production environment to output some important information about the running of the program, but it cannot be abused to avoid printing too many logs.

    WARN (warning)

    Indicates a potential error situation, some messages are not error messages, but also some hints to the programmer.

    ERROR

    It is pointed out that although an error event occurs, it still does not affect the continued operation of the system. Print error and exception information.

    Use this level if you don't want to output too many logs.

    FATAL

    Point out that each serious error event will cause the application to exit.

    This level is relatively high, which is a major error, and the program can be stopped directly.

    2. Set the log level

    The super administrator logs in to the data decision system, clicks "Manage > Intelligent Operations > Platform Log", and clicks "Global Setting" to adjust the log level according to your needs. As shown below:

    Note: Adjusting the log level only affects the output of the system log, not the operation log.

     平台日志.png

    3. Clean up system logs

    1) Before version 5.1.11

    system does not automatically clean up the %BI_HOME%\logs\fanruan.log file. The default level of system log is "ERROR".

    If the "BI Log Auto Cleanup" plug-in is installed, the default system log level is changed to "INFO", and the system automatically detects the %BI_HOME%\logs\fanruan.log file every morning, and only retains the logs files of the last month.

    2) Version 5.1.11 and later

    The product has built-in "BI log automatic cleaning" plug-in, and the default level of system log is "INFO". The system automatically detects the %BI_HOME%\logs\fanruan.log file every morning, and only retains the logs files of the last month.

    To cancel the automatic cleaning of system logs, please uninstall the "BI Log Auto Cleanup" plugin in "System Management > Plug-in Management".

    Note: In order to avoid the redundant log file information caused by the repeated log output and occupy too much space, the "BI Log Auto Cleanup" plugin of V1.0.2 and above has added the log anti-duplication function.

    • Logs that need to be printed with the same content are regarded as duplicate logs.

    • For the log without stack information, record 20 historical log information (not repeated).

    • For logs with stack information, record 10 historical log information (not repeated).

    • The newly printed log is in the history record, and if the number of repeated printing exceeds 3 times, it will not be printed to the log file.

    • The log information that is not printed is repeated, and the number of repetitions exceeds a certain limit, and the log information with the number of repetitions will be printed on the 5th/10th/full ten/full hundred/thousand/thousandth time.

    Ⅲ. Operation log

    1. View the operation log

    Operation logs are stored in the %BI_HOME%\webapps\webroot\logs\cubes folder by default, and the storage location cannot be modified.

    • The system has actively analyzed the commonly used operation logs for you. For details, please refer to: Platform Logs .

    • All operation logs are stored in the cubes folder and can be queried and analyzed through data connections. For details, see: Report Log LogDB Database .

    2. Modify the storage location

    Operation logs are stored in the %BI_HOME%\webapps\webroot\logs\cubes folder by default, and the 5.1.7 and later projects support changing the storage location.

    1) Windows Modify the catalina.bat file in the %Tomcat%/bin directory, add configuration, and restart the project after the configuration is complete.

    Specify the path after the equal sign "=". The relative path will automatically generate the logs folder in the bin directory, or an absolute path can be used.

    SET JAVA_OPTS="$JAVA_OPTS -DSWIFT_HOME=logs""

    2) Linux/Unix Modify the catalina.sh file in the %Tomcat%/bin directory, add configuration, and restart the project after the configuration is complete.

    Specify the path after the equal sign "=". The relative path will automatically generate the logs folder in the bin directory, or an absolute path can be used.

    JAVA_OPTS="$JAVA_OPTS -DSWIFT_HOME=logs"

    3. Clean up the operation log

    The super administrator logs in to the data decision system, clicks "Manage > Intelligent Operations > Platform Log", and clicks "Global Setting" to clean up the operation log files, and can set "Auto Cleanup" and "Manual Clean"

    1) Auto cleanup : It is automatically cleaned every 3 months, and the data of nearly 3 months is retained. There will be a minimum of 3 months, and a maximum of 6 months in practice.

    2) Manual clean : By default, data of nearly 3 months is retained, and you can choose 0 days, 1 day, 1 week, 1 month, 3 months, 6 months, and 12 months.

    Note 1: The "Operation Log Cleanup" setting only affects the cleanup of the operation log, not the system log.

    Note 2: The last 3 months refers to the data of 3 months before the current date, for example, the data from 2019-5-19 ~ 2019-8-19 is retained by default if manually cleaned on 2019-8-19.

    Note 3: After cleaning the log, it is found that the cubes folder still takes up a lot of space. The reason is that it only cleans the files in the folder, not the folder. There are many folders in this directory, and they take up a lot of space.

    Note 4: The "current log size" displayed after cleaning is not the concept of disk space, but the actual size of all files. 

    As shown below:

    平台日志清理.png

    3) Clear the warning

    When the log file is too large, the relevant users are notified, and the relevant users can manually clean up the log to reduce the size of the log file.

    Enable the early warning function and set trigger conditions, such as log files larger than xxxM.

    SMS reminders need to "enable SMS function", please check SMS for detailed settings , and email reminders also need to configure the sender, for detailed settings, please check Mail .

    Then check "SMS Reminder, Platform Message, Email Reminder", and then set the recipients respectively. After the settings are completed, click "Save", as shown in the following figure:

     平台日志清理警告.png

    The platform message effect is shown in the following figure:

     平台.png

    The effect of the email reminder is shown in the following figure:

     email.png

     


    附件列表


    主题: System Management
    Previous
    Next
    • 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