Skip to content

System Health Checks

To ensure the stable operation of the system, Emakin publishes the status of its internal components via health checks. These checks provide insight into the overall health of the system and its various services.

The health check status is provided in JSON format and is accessible via the URL http://<servername>:5121.

Health checks return one of the following statuses based on the check result:

Result Description
Healthy The component is functioning correctly.
Degraded The component has encountered a non-critical issue. Some functions may be affected.
Unhealthy The component has failed.

The health checklist and its parameters are configurable. Below is an example of the JSON response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
    "status": "degraded",
    "statusIcon": "🟠",
    "results": [
        {
            "name": "Disk Space",
            "status": "healthy",
            "statusIcon": "✅",
            "description": "Disk space OK",
            "tags": [
                "system"
            ],
            "data": {
                "required": 100,
                "available": 614183
            }
        },
        .......
        {
            "name": "Timestamp Service Connection",
            "status": "degraded",
            "statusIcon": "🟠",
            "description": "A timeout occurred while running check.",
            "tags": [
                "timestamp"
            ]
        }
    ]
}

Health Check List

The following checks are conducted by Emakin to generate the health report:

Check Description Failure Condition Failure Result
Disk Space Checks the available free disk space. Less than 100MB Degraded
CPU Usage Monitors current CPU usage. Greater than 50% Degraded
Thread Count Monitors the number of currently executing threads. Greater than 200 Degraded
Cache Verifies the connection to the cache service. Any connection error Unhealthy
Application Database Connection Verifies the SQL database connection. Any connection error Unhealthy
Market Connection Verifies the connectivity to the market service. Any connection error Degraded
Mobile Push Connection Verifies the connectivity to the mobile notification gateway. Any connection error Degraded
Timestamp Service Connection Verifies the connectivity to the timestamp service. Any connection error Degraded
Full Text Search Service Checks the connection to the active full text service. Any connection error Unhealthy
Mail Sending Jobs Monitors mail-sending jobs. Any Workflow.Message.Send job in an error state within the last 2 hours. Degraded
Mail Receive Jobs Monitors mail-receiving jobs. Any Workflow.Channel.MailSync job in an error state within the last 1 hour. Degraded
Workflow Processing Jobs Monitors workflow processing jobs. Any Workflow.WorkItem.Process job in an error state within the last 1 hour. Degraded
OpenAuth <servicename> Service Connection Verifies the connectivity to the specified OpenAuth service. Any connection error Unhealthy (If service enabled)

Degraded (If service disabled)
FileRepository <servicename> Directory Checks the file system-based repository. Any connection error Degraded
Ldap <ldaphost> Service Connection Verifies the connectivity to the specified LDAP or AD service. Any connection error Unhealthy (If service enabled)

Degraded (If service disabled)
WOPI <servicename> Service Connection Verifies the connectivity to the specified WOPI-based document editor service. Any connection error Unhealthy (If service enabled)

Degraded (If service disabled)
Message Service <servicehost> Connection Verifies SMTP server connectivity. Any connection error Unhealthy (If service enabled)

Degraded (If service disabled)
Tika Service Connection Verifies the connectivity to the Tika service. Any connection error Degraded