Skip to content

System Health Checks

System Health Checks exposes the health state of Emakin components in JSON form. Use it to confirm system availability, detect degraded dependencies, and understand which internal checks are failing.

The health endpoint is available at:

1
http://<servername>:5121

Result States

Result Description
Healthy Component is functioning correctly
Degraded Component has a non-critical issue
Unhealthy Component has failed

Example 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
{
    "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"
            ]
        }
    ]
}

Documented Health Checks

The documented health checks include:

  • Disk Space
  • CPU Usage
  • Thread Count
  • Cache
  • Application Database Connection
  • Market Connection
  • Mobile Push Connection
  • Timestamp Service Connection
  • Full Text Search Service
  • Mail Sending Jobs
  • Mail Receive Jobs
  • Workflow Processing Jobs
  • OpenAuth <servicename> Service Connection
  • FileRepository <servicename> Directory
  • Ldap <ldaphost> Service Connection
  • WOPI <servicename> Service Connection
  • Message Service <servicehost> Connection
  • Tika Service Connection

Use the detailed per-check configuration and thresholds in your environment as the canonical reference for exact failure conditions and severity levels.