Understanding Pod Health Check (Release 9.2.6)

Note: The pod health check described in this section is not invoked from the Server Manager console nor as a Server Manager REST API. It is included here because of its relativity to the other Server Manager health checks.

In the recommended EnterpriseOne production architecture, the web tier comprises a set of interrelated servers:

  • An HTML Server, sometimes called a "front-end" HTML Server because it receives the requests from end users' browsers
  • An application interface services (AIS) Server
  • A second HTML Server, sometimes called a "back-end" HTML Server because it fulfills the requests from the AIS Server

Taken collectively, these servers are called a "pod". For scalability and fault tolerance, it is common to deploy redundant sets of pods, often behind a load balancer, which directs traffic across the pods. The Enterprise Server and the database are also essential parts of the complete stack. If any servers in the stack are experiencing a fault, EnterpriseOne transactions will fail.

The pod health check is a lightweight service which returns the health information of the POD. In a load-balanced environment, the load balancer can run this service to determine if it is possible to forward load to a particular POD. You can send a HTTP GET request to an HTML Server instance to verify the health of a group of interdependent servers:

https://<IP Address/Fully Qualified Domain Name>Port>/jde/PODHealthChecker

If the servers are available, an HTTP response with the 200 status is returned, otherwise, the status is either 500 (servers down) or 404 (front end JAS is down).

Note: To run the POD health check, AIS and Server Manager Health Check must be configured on this server instance.

In addition, the system returns the details in the JSON format. Here are some sample responses.

  • If the servers are available, the system returns {"status":"POD available"}
  • If the servers are down, the system returns{"status":"AIS or backend JAS not available"}

Starting with Tools Release 9.2.7.4, if the JAS instance reaches the maximum user limit, the pod health check service returns the 409 status with the message "Exceeds maximum JAS user limit".