Health
System Health provides a real-time overview of your system's resources, essential for monitoring performance and diagnosing potential issues. It provides key indicators and status updates to help you maintain system health and quickly address potential issues.
Navigation to Health
Step 1: Log in to your Qualytics account and click the Settings button on the left side panel of the interface.
Step 2: You will be directed to the Settings page; then click on the Health section.
Summary Section
The Summary section displays the current platform version, along with the database status and RabbitMQ state.
| REF. | FIELD | ACTION | EXAMPLE |
|---|---|---|---|
| 1 | Current Platform Version | Shows the current version of your platform's core software. | 20240808-3019c60 |
| 2 | Database | Verifies your database connection. An "OK" status means it’s connected. | Status:OK |
| 3 | RabbitMQ | Confirms RabbitMQ (a message broker software) is running correctly with an "OK" state. | State:OK |
Health Indicator
The health status indicator reflects the overall system resources health.For example, in the image below, a green checkmark indicates that our system resources are healthy.
| NOTE: Status indicators are simple: a green checkmark indicates "Healthy," and a red exclamation mark means "Critical." |
Analytics Engine
The Analytics Engine section provides advanced information about the analytics engine's configuration and current state for technical users and developers.
| REF | FIELD | ACTION | EXAMPLE |
|---|---|---|---|
| 1 | Build Date | This shows the date and time when the Analytics Engine was built. | Aug 8 2024,7:39 AM (GMT+5:30) |
| 2 | Implementation Version | The version of the analytics engine implementation being used. | 2.0.0 |
| 3 | Max Executors | Maximum number of executors allocated for processing tasks. | 10 |
| 4 | Max Memory Per Executor | This shows the maximum amount of memory allocated to each executor. | 25000 MB |
| 5 | Driver Free Memory | The amount of free memory available for the driver, which manages the Spark application. | 968 MB |
| 6 | Spark Version | The version of Apache Spark that the Analytics Engine uses for processing. | 3.5.1 |
| 7 | Core Per Executor | This shows the number of CPU cores assigned to each executor. | 3 |
| 8 | Max Dataframe Size | The maximum size of dataframes that can be processed. | 50000 MB |
| 9 | Thread Pool State | Indicates the current state of the thread pool used for executing tasks. | [Running, parallelism \= 3, size \= 0, active \= 0, running \= 0, steals \= 0, tasks \= 0, submissions \= 0] supporting 0 running operation with 0 queued requests |
Manage Health Summary
You can perform essential tasks such as copying the health summary, refreshing it, and restarting the analytics engine. These functionalities help maintain an up-to-date overview of system performance and ensure accurate analytics.
Copy Health Summary
The Copy Health Summary feature lets you duplicate all data from the Health Section for easy sharing or saving.
Step 1: Click the vertical ellipsis from the right side of the summary section and choose Copy Health Summary from the drop-down menu.
Step 2: After clicking on Copy Health Summary, a success message saying Copied.
Refresh Health Summary
The Refresh Health Summary option updates the Health Section with the latest data. This ensures that you see the most current performance metrics and system status.
Step 1: Click the vertical ellipsis from the right side of the summary section and choose Refresh Health Summary to update the latest data.
Restart Analytics Engine
The Restart Analytics Engine option restarts the analytics processing system. This helps resolve issues and ensures that analytics data is accurately processed.
Step 1: Click the vertical ellipsis from the right side of the summary section and choose Restart Analytics Engine from the drop-down menu.
Step 2: A modal window will pop up. Click the Restart button in this window to restart the analytics engine. Restarting the engine helps resolve any issues and ensures that your analytics data is up-to-date and accurately processed.
Step 3: After clicking on Restartbutton a success message saying Successfully triggered Analytics Engine restart.
