System Statistics and Monitor

System Statistics

The <Admin | Servers | System Statistics> menu shows system statistics. This menu and the <Admin | Servers | File System> menu appear only when SUPPORT_SYSTEM_STATISTICS is true. The default is true.

If the data is large, it can take a while.

System Health Check

Supported starting with ManualWorks 6.0.21.

Shows key environment information and health check results for the product and server. You can see the product version and build number, Java and the JVM, the operating system, the database type, and the server uptime.

ManualWorks checks the following items and classifies each result as OK, INFO, WARN, or ERROR.

When the server starts, ManualWorks checks the following and notifies the administrator if any apply.

Details and JSON File Download

The health check, Preference values, Java system properties, and environment variables are shown in tabs. Preferences without a value are not shown. Sensitive values such as passwords, tokens, and API keys are masked as ********.

You can choose the current status or a saved system statistics snapshot from the list. Keep the current status with the <Save> button, and click the <Download> button to download the selected result as 3rabbitz-health-check-{timestamp}.json. Saved system statistics are kept as JSON files in the statistics directory under the data directory.

The JSON file can contain system paths and operating environment information. Share it only for customer support, and handle it securely.

To share just a quick summary of the server environment when you contact support, send the “System Information” from the <About> menu. It shows the operating system, Java, Tomcat, and database in one line. Only users with the Administrator role can see it.

Data Directory Usage

Shows the usage of the data directory. This is an estimate. It also shows the usage of the 1file system where the data directory is, which is also an estimate.

Backup Directory Usage

Shows the usage of the backup directory. This is an estimate. It also shows the usage of the 1file system where the backup directory is, which is also an estimate.

If you did not change the backup directory during installation, the "backup" directory under the data directory is the backup directory.

Database Usage

Shows the usage of database TABLEs and INDEXes. This is an estimate.

With Apache Derby, you cannot see INDEX usage. However, Apache Derby stores its database files in the database directory under the data directory, so you can estimate the database usage from the size of that directory.

Monitor

This feature monitors the status of ManualWorks. Use it as follows.

  1. Open the Console.

  2. Enter the following command.

set-preference -name SUPPORT_MONITORING -value true
  1. Refresh the web browser. The <Admin | Servers | Monitor> menu appears.

1Shows the system status for a specific date.

2Runs garbage collection on the Java heap memory.

3The charts do not update automatically. To see the latest data, click the <Refresh> link. Performance data is collected every 5 minutes.

The following system monitoring data is available.

System monitoring data types

Type

Description

Total HTTP Request

The total number of HTTP requests in 5 minutes. Requests for images, CSS, JS, and other files under /resource are excluded.

Active HTTP Request

The maximum number of HTTP requests processed at the same time in 5 minutes

Active SQL Connection

The maximum number of SQL Connections in use at the same time in 5 minutes

Active HTTP Session

The maximum number of HTTP Sessions in use at the same time in 5 minutes

Active Java Thread

The number of Java threads, measured every 5 minutes

Active Work

The number of Work items, measured every 5 minutes

Heap Memory Used

Java heap memory usage, measured every 5 minutes

CPU Usage

CPU usage, measured every 5 minutes

Monitor data is stored in the monitor directory under the data directory. By default, UserTokenClearScheduler deletes data older than 365 days. Change the retention period with the MONITOR_RETENTION_PERIOD setting. Enter 0 to keep the data.

The data can differ from the actual system status, so use it only for reference. This feature has almost no effect on performance. However, if ManualWorks has no problems, we recommend not using it.

ENABLE_BOT_REQUEST_FILTER Option

Frequent requests from bots and similar clients cause excessive database work (looking up published document addresses and custom chapter or paragraph IDs from arbitrary URLs). This option minimizes that work. It is on by default. To turn it off, run the following command in the Console.

set-preference -name ENABLE_BOT_REQUEST_FILTER -value false

For details, see 악성 봇(Malicious Bot)에 의한 시스템 성능 저하.