Jade Node Health Endpoint

Every Jade node has a built‑in Health Endpoint that responds to a simple HTTP GET request. This enables the basic health status of a Jade application server (or any Jade executable with an Object Manager) to be remotely queried by its hosting environment.

The Health Endpoint has:

• Minimal overhead that will not impact your production performance

• The ability to determine if Jade applications can be started on the node

• The number of available thin client connections

• The ability to configure the interval at which health checks are performed

To enable the Health Endpoint, add an entry for the Address parameter in the [Health] section of the Jade initialization file. This parameter specifies the IP-address:port-number format; for example:

Address=0.0.0.0:9999

If the Health Endpoint fails to respond, the most likely cause is a configuration problem; that is, the configured port is already in use or the IP address is invalid.

Check the jommsg.log file for error messages. All entries related to the Health Endpoint are prefixed with the text "HealthEndpoint". If the Health Endpoint is configured correctly, there will be only one entry in the log file, and it is similar to the following.

2026/01/15 13:13:44.995 063f8-3a1c HealthEndpoint: Accepting connections on 0.0.0.0:9999

Each external request will return the health status as determined by the latest internal check of the node health.

The health of the node is checked internally at regular intervals, independently of any external requests. The default interval for this check is 5 seconds. The interval is configured in seconds using the HealthCheckInterval parameter in the [Health] section of the Jade initialization file. The minimum value is 5 seconds and the maximum value is 3600 seconds (that is, 1 hour).

The health status of the Jade node is returned in the JSON‑formatted payload of an HTTP response. For example, the GET /Health HTTP/1 HTTP request results in a Health Endpoint response similar to the following.

HTTP/1.1 200 OK
Content-Length: 140
Connection: close
Content-Type: application/json; charset=utf-8

{
    "status": "healthy",
    "node": "XYZWILBUR3A1",
    "device": "XYZWILBUR3A",
    "unused licences": 1000,
    "timestamp": "2026-01-15T00:13:50.930Z"
}

The health status fields are as follows.

• The possible values for the status field are "healthy" or "unhealthy".

  If the status of the node is unhealthy, the response will be sent with an HTTP 500 Internal Server Error response; for example:

  HTTP/1.1 500 Internal Server Error
  Content-Length: 191
  Connection: close
  Content-Type: application/json; charset=utf-8
  
  {
      "status": "unhealthy",
      "node": "XYZWILBUR3A1",
      "device": "XYZWILBUR3A",
      "error": "SignOff failure: Already signed on",
      "unused licences": 1000,
      "timestamp": "2026-01-15T01:01:48.136Z"
  }

  The unhealthy response will contain an error message in the error field.

• The node field contains the name of the Jade node.

• The device field contains the name of the device that is hosting the node.

• The unused licences field contains the number of process licences remaining for the node. (This value is the same as that reported in the nProcessesLeft attribute property of the JadeLicenceInfo class.)

  These process licences are also available to any other Jade node connected to the same database server as the node that has the Health Endpoint.

• The timestamp field contains the UTC time that the response was sent by the Health Endpoint.

2025 R2 and higher