Health Checks

Emakin publishes the status of internal components to check everything is running properly.

Health check status is published in JSON format and it can be accessed from the “http://<servername>:5121” URL.

Health checks return only one of the following results, depending on the check result.

Result	Description

Result	Description
Healthy	Working properly
Degraded	The check has failed but is not critical, some functions may not work properly.
Unhealthy	The check completely failed.

Depending on the configuration health checklist can be changed and example JSON is following;

{
  "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

Emakin uses the following checks while generating the health report.

Check	Description	Failure Condition	Failure

Check	Description	Failure Condition	Failure
Disk Space	Check the free space on the machine.	Less than 100MB	Degraded
CPU Usage	CPU usage	Greater than %50 percent	Degraded
Thread Count	Currently executing thread count	Greater than 200	Degraded
Cache	Cache service connection	Any connection error	Unhealthy
Application Database Connection	SQL connection	Any connection error	Unhealthy
Market Connection	Check the market service connectivity.	Any connection error	Degraded
Mobile Push Connection	Check the mobile notification gateway connectivity.	Any connection error	Degraded
Timestamp Service Connection	Check the timestamp service connectivity.	Any connection error	Degraded
Full Text Search Service	Checks connectivity between active full text service.	Any connection error	Unhealthy
Mail Sending Jobs	Checks mail-sending jobs.	Any Workflow.Message.Send job in Error state in the last 2 hours.	Degraded
Mail Receive Jobs	Checks mail-receiving jobs.	Any Workflow.Channel.MailSync job in Error state in the last 1 hour.	Degraded
Workflow Processing Jobs	Checks workflow processing jobs.	Any Workflow.WorkItem.Process job in Error state in the last 1 hour.	Degraded
OpenAuth <servicename> Service Connection	Check the open auth service connectivity.	Any connection error	Unhealthy (If service enabled) Degraded (If service disabled)
FileRepository <servicename> Directory	Check the file system-based repository	Any connection error	Degraded
Ldap <ldaphost> Service Connection	Check the LDAP or AD service connectivity.	Any connection error	Unhealthy (If service enabled) Degraded (If service disabled)
WOPI <servicename> Service Connection	Check WOPI-based document editor service connectivity.	Any connection error	Unhealthy (If service enabled) Degraded (If service disabled)
Message Service <servicehost> Connection	Check SMTP server connectivity.	Any connection error	Unhealthy (If service enabled) Degraded (If service disabled)
Tika Service Connection	Checks Tika service connectivity.	Any connection error	Degraded