--- title: "Endpoint Security Server Health Module User Guide Release 1.0.7" slug: "endpoint-security-server-health-module-user-guide-release-1-0-7" updated: 2026-09-11T11:11:35Z published: 2026-09-11T11:11:35Z canonical: "docs.trellix.com/endpoint-security-server-health-module-user-guide-release-1-0-7" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Endpoint Security Server Health Module User Guide Release 1.0.7 # Endpoint Security Server Health Module User Guide Release 1.0.7 Last Updated: September 17, 2023     ![Decorative multicolor dashed wave pattern across the page with the Trellix logo at the bottom-right](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0001_img_01.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D) ## Contents --- **Module Overview .............................................................. 3** Supported Platforms ............................................................. 3 Role-Based Access for Server Health Module ................................... 3 **Installing the Server Health Module ..................................... 5** Installing the Server Health Server Module .................................. 5 Verifying the Installation ................................................... 6 **Uninstalling the Module .................................................. 7** **Configuring the Module .................................................. 8** Enabling the Server Health Module ........................................... 8 Disabling the Server Health Module .......................................... 8 **Using the Module ........................................................ 9** Viewing Server Health Monitors .............................................. 9 Process Monitor Details .................................................. 13 Setting the Logging Levels ................................................ 14 Configuring Appliance Health Service Email Notification .................... 15 Configuring Event Notifications Using the CLI ............................. 15 [1](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- # Module Overview The module enables FireEye Endpoint administrators to monitor critical service failures and identify potential issues in the product. The module collects historical data of the server's health and suggests possible remediation actions to reduce reliance on FireEye support for assistance. The Server Health module monitors the following services: - Application Processor - Enterprise Search - Lighthouse - Policy Service - Generic Alert Processor - Malware Alert Processor The Server Health module monitors the following health statistics: - Kyoto DB Casket File Status - Concurrent Host Limit and Sysinfo Interval - Hits Count vs. Condition - Orphan Condition Count - Messagebus - Database Table Bloat Status - Store and Forward Cluster Connectivity - TaskingStatus ## Supported Platforms This release of Server Health Module 1.0.7 is supported on Endpoint Security Server 5.1.1 and later. ## Role-Based Access for Server Health Module Role-based access is managed for the module and the table provides more information about the access allowed to each user role. ---     Endpoint Security Server Health Module User Guide Release 1.0.7     3 ## 1 | Module Overview --- | User Roles | Server Health Accessibility | Module Admin Accessibility | | --- | --- | --- | | Admin | Yes | Yes | | Investigator | Yes | Yes | | Analyst | Yes | No | | Senior Analyst | Yes | No | | Operator | Yes | No | | Monitor | No | No | | Auditor | No | No | ---     4     Endpoint Security Server Health Module User Guide Release 1.0.7 [2](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- # Installing the Server Health Module Server Health is an optional module available for **Endpoint Security Server 5.1.1 and above**. It is installed using your Endpoint Security Web UI. The module installer package .cms file is downloaded from the [FireEye Market](https://www.fireeye.com) and then installed on your Endpoint Security Web UI. Initially, the module is disabled by default and must be enabled before using it. For more information on how to enable the module, see the *Enabling the Server Health Module (Server)* section. After the module is installed successfully, it is displayed on the **Modules** menu. The configuration properties for the module appear on the Endpoint Module Administration **Module Configuration** page. ## Installing the Server Health Server Module Select one of the following options to install the module: To install the Server Health Module using the Endpoint Security Web UI: 1. Log in to the Endpoint Security Web UI as an administrator. 2. From the Modules menu, select **Endpoint Module Administration**. 3. Click the **Available Modules** tab and locate Server Health in the Module list. 4. In the Actions column, click the gear icon, and click **Install**. 5. Click **Install** on the dialog box. To download the module installer CMS package, go to the [FireEye Market](https://www.fireeye.com), then upload the module CMS file in your Endpoint Security Web UI. > Note > > >     >     > > Note down the navigation path to the directory where you have downloaded the .cms file. Perform the following steps to upload the CMS file in your Endpoint Security Web UI: 1. On the Endpoint Security Web UI, click **Install Modules** to upload the module .cms file from your local drive to the Endpoint Security Console. The .cms file includes a server module and an agent module of the Server HealthModule. 2. In the **Upload Module** dialog box, navigate to the downloaded module .cms file, select the .cms file, and click **Open**. The selected .cms file appears in the Upload Module dialog box. 3. Click **Upload**. The module is disabled by default. When the module is installed successfully, it is displayed on the **Modules** menu. --- Endpoint Security Server Health Module User Guide Release 1.0.7 [2](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- # Verifying the Installation To verify that the Logon Tracker module is installed and running: 1. Go to **Modules > Endpoint Module Administration > Installed Modules** and check if the Server Health module is displayed in the list. 2. Verify the status of the module using the Endpoint Server through API. --- 6 Endpoint Security Server Health Module User Guide Release 1.0.7 [3](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- # Uninstalling the Module To uninstall the Server Health Module using the Endpoint Security Web UI, complete the following steps: 1. Log in to the Endpoint Security Web UI as an administrator. 2. From the Modules menu, select **Endpoint Module Administration**. 3. Click the **Installed Modules** tab and locate Server Health in the Module list. 4. On the Modules page, locate the Server Health module and click the **Actions** icon. 5. Select **Uninstall** and click **Uninstall** in the confirmation window. A message at the top of the page tells you that module uninstallation succeeded. ---     Endpoint Security Server Health Module User Guide Release 1.0.7     7 4 | Module Overview --- # Configuring the Module The Server Health Module consists of a server module and an agent module. The agent module is installed and enabled on agents using the Server Health policy. If you disable the server module, this will automatically disable the agent module for all policies. ## Enabling the Server Health Module 1. Log in to the Endpoint Security Web UI. 2. From the Modules menu, select **Endpoint Module Administration**. 3. On the Modules page, click **Installed Modules**. 4. Locate the Server Health module in the list. 5. In the Actions column, click the gear icon, and select **Enable**. ## Disabling the Server Health Module 1. Log in to the Endpoint Security Web UI as an administrator. 2. From the Modules tab, select **Endpoint Module Administration**. 3. On the Modules page, click **Installed Modules**. 4. Locate the Server Health module in the list. 5. In the Actions column, click the gear icon, and select **Disable**. [5](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- # Using the Module Server health statistics are captured as health monitors in **Module** page.     ![Screenshot of the Server Health dashboard — dark theme interface showing multiple health monitor tiles in a grid (Application Processor, Enterprise Search, Lighthouse, Policy Service, etc.) with status icons and 'Details' links; includes top navigation bar with 'Dashboard', 'Alerts', 'Hosts', 'Acquisitions', 'Rules', 'Enterprise Search', 'Admin', 'Modules'.](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0009_img_01.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D) ## Viewing Server Health Monitors The table indicates the time it takes for the Server Health monitors to update the current status of the processes and other health statistics. | **Health Monitor** | **Process Name** | **Monitoring Interval** | **Recovery Steps** | | --- | --- | --- | --- | | **Process Monitoring** | Application Processor | app_processor | 5 mins Visit KB Article page for recovery steps | | Enterprise Search | app_search_processor or | | | Lighthouse | lighthouse | | | Policy Service | policy_service | | --- Endpoint Security Server Health Module User Guide Release 1.0.79 ## 5 | Module Overview | | **Health Monitor** | **Process Name** | **Monitoring Interval** | **Recovery Steps** | | --- | --- | --- | --- | --- | | | Generic Alert Processor | alert_service | | | | Malware Alert Processor | am_service | | | **Health Monitor** | **Monitoring Interval** | **Decision Making Logic** | **Recovery Steps** | | --- | --- | --- | --- | --- | | Health Statistics Monitoring | Kyoto DB Casket File Status | 15 mins | CRITICAL: if casket file size is greater than 10 GB WARNING: if casket file size is between 2 GB and 10 GB | Visit KB Article page for recovery steps | | | Concurrent Host Limit and Sysinfo Interval | 1 Hour | WARNING: if CHL is set below 25% of agent population (Minimum agent count - 100) WARNING: if Sysinfo interval is set below the expected value for the given agent count as in the below table: (Minimum agent count - 5k) 1. If Agent | | ## 5 | Module Overview --- | | Health Monitor | **Monitoring Interval** | Decision Making Logic | Recovery Steps | | --- | --- | --- | --- | --- | | | | | Count Range: Below 50k then Expected Sysinfo interval: 4 Hour 2. If Agent Count Range: 50k - 80k then Expected Sysinfo interval: 6 Hour 3. If Agent Count Range: 80k - 100k then Expected Sysinfo interval: 8 Hour 4. If Agent Count Range: Above 100k then Expected Sysinfo interval: 10 Hour | | | | | Hits Count vs. Condition | 1 Hour | | Minimum agent count - 100 WARNING: if hits count is greater than 100k. (Only top 5 conditions in terms of hits count are shown in warning message) | | --- Endpoint Security Server Health Module User Guide Release 1.0.7 11 [5](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- | | **Health Monitor** | **Monitoring Interval** | **Decision Making Logic** | **Recovery Steps** | | --- | --- | --- | --- | --- | | | Orphan Condition Count | 1 Hour | CRITICAL: if orphaned conditions are more than 200k WARNING: if orphaned conditions are between 50k and 200k | | | | Messagebus | 5 mins | CRITICAL: if we get any error in the response of fetching list of topics WARNING: if messagebus returns no topic | | | | Database Table Bloat Status | 12 Hour | WARNING: if table size is over 500 MB, bloat size is over 200 MB, bloat ratio is over 40. (Only top 5 tables in terms of bloat size are shown in warning message) | | | | Store and Forward Cluster Connectivity | 5 mins | CRITICAL: if sfServer or sfTasker is not running WARNING: if no clusters found or if a cluster | | ## 5 | Module Overview --- | | Health Monitor | **Monitoring Interval** | Decision Making Logic | Recovery Steps | | --- | --- | --- | --- | --- | | | | | responds with any code other than 200 tosfTasker | | | | Tasking Status | 1 hour | **Warning: if** - Active tasks are more than 5 times agent count - Pending tasks count is higher than 5 per agent count - Failed tasks count per day is higher than agent count - Live tasks count is higher than 5 times agent count | | ## Process Monitor Details When the server process stops running, service health monitor reports its health status as **Critical** or **Warning** on the Module --- Endpoint Security Server Health Module User Guide Release 1.0.713 ## 5 | Module Overview --- page.     ![Wide dark-themed dashboard screenshot titled Server Health showing tabs Summary, History, Settings. Two health monitor panels are visible: left panel labeled Application Processor with a red critical alert icon and a Details link; right panel labeled Concurrent Host Limit and Sysinfo Interval with an orange warning icon and a Details link. The background is a textured dark grid.](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0014_img_01.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D) You can click the health monitor to view additional details about the failure and the suggested recovery steps.     ![Dark modal dialog titled Application Processor. The dialog shows lines of information including Last Updated: 2021-08-16T06:32:00, Status: Critical, Message: Process \app_processor\ is not running, and Recovery Steps: Call FireEye Customer Support if the failure persists. A close icon appears in the top-right of the dialog.](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0014_img_02.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D) ## Setting the Logging Levels On the **Endpoint Module Administration** page, click **Configure** to set the logging level of the module for debugging.     ![Screenshot of the Server Health Settings page showing a large dark panel titled Logging Levels Settings. The panel contains descriptive text and a vertical list of radio-button options for log levels (Emergency, Alert, Critical, Error, Warning, Notice, Info, Debug). A Save Settings button and Cancel button are visible in the page header area.](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0014_img_03.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D)     14     Endpoint Security Server Health Module User Guide Release 1.0.7 5 | Module Overview --- > ![Blue note icon with a pencil](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0015_img_01.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D) **Note** > > >     >     > > The log files are created under /var/log/supervisor/server_health*.log # Configuring Appliance Health Service Email Notification You can receive email notifications about your system's health changes with your Endpoint Security appliance. Before configuring email notifications for the Endpoint Security appliance, ensure the following Prerequisites is met: - The Endpoint Security appliance has an established connection to the Internet. - You have an "Admin" or "Operator" access to the Endpoint Security appliance. - Email recipients have been configured. For more information, see the "Configuring Email Notifications" section in “Event Notifications” chapter of the *Endpoint Security System Administration Guide*. ## Configuring Event Notifications Using the CLI Use the CLI commands to configure appliance health service email notifications. To configure event notifications using the CLI: 1. Enable the CLI configuration mode.         ``` hostname > enable hostname # configure terminal ``` 2. Enable Email notifications about the health of an appliance service.         ``` hostname(config)# health configuration service notify enable ``` 3. Configure the failure wait time threshold. An email notification is sent after the service has been in failed state for the specified number of minutes.         ``` hostname (config) # health configuration service notify failure-threshold ``` 4. Configure the recovery time threshold. An email notification is sent after the service recovers and stays in recovered or healthy state for the specified number of minutes. This recovery threshold time prevents multiple notifications if the service changes state intermittently.         ``` hostname (config) # health configuration service notify recovery-threshold ``` 5. Configure the time of day when the email notification to be sent about the health of appliance services.         ``` hostname (config) # health configuration digest notify daily at ``` 6. Configure the backoff time. If the service changes its state to degraded, then an email notification will not be sent until the --- Endpoint Security Server Health Module User Guide Release 1.0.7 15 [5](/docs/endpoint-security-server-health-module-user-guide-release-1-0-7#) | Module Overview --- configured backoff time is reached. ``` hostname # health configuration service notify backoff ``` 7. View the configuration for appliance service email notifications. ``` hostname # show health configuration ``` ## COPYRIGHT Copyright © 2026 Musarubra US LLC. Trellix and FireEye are the trademarks or registered trademarks of Musarubra US LLC, FireEye Security Holdings US LLC, and their affiliates in the US and /or other countries. Other names and brands are the property of these companies or may be claimed as the property of others.     ![Trellix logo — the word Trellix in bold black text with a small multicolor (blue/green) diagonal mark at the end, positioned lower-right of the page](https://cdn.us.document360.io/0d453a50-e1da-4d4a-9409-fea7959614d8/Images/Documentation/endpoint-security-server-health-module-user-guide-release-1.0.7_page_0017_img_01.png?sv=2026-02-06&spr=https&st=2026-11-21T02%3A19%3A03Z&se=2026-11-21T03%3A19%3A03Z&sr=c&sp=r&sig=SQuKSvuSsAIzpBRzIFJ47trQgrukp9ZsZ6HBJK4Gd6A%3D)