Configure > Networking > Health Check URLs

Force Health Checks to Report Proxy Down
Enable/Disable

When enabled, all health check URLs sent to this proxy report WSDOWN.

The URL response will be similar to: 
HTTP/1.0 503 Service Unavailable
Server: Content Gateway Manager 7.7.0
Date: Thu, 26 Jul 2012 20:26:14 GMT
Cache-Control: no-store
Pragma: no-cache
Content-type: text/plain
Content-length: 6
WSDOWN
Health Check URLs
  1. health.basic: This URL checks the connectivity with the Content Gateway and returns a status of WSUP (up) or WSDOWN (down). It is accessed via http://[Content Gateway IP address]:8083/health.basic.
  2. health.app.filtering: This URL checks the health of the Filtering Service and also returns WSUP or WSDOWN based on its status. It is accessed via http://[Content Gateway IP address]:8083/health.app.filtering.
  3. health.load: This URL provides detailed metrics such as CPU usage, connection usage, and bandwidth usage. It is accessed via http://[Content Gateway IP address]:8083/health.load.

    It returns these metrics unless the health.basic URL reports WSDOWN, in which case it will also report WSDOWN. Otherwise, health.load returns:

    • CPU usage (operating system load average)
    • Connection usage (number of open connections)
    • Bandwidth usage

    How these values are calculated and how they can be customized is described below.

    The default response will look similar to:
    HTTP/1.0 200 OK
Server: Content Gateway Manager 7.7.0
Date: Thu, 26 Jul 2012 20:26:14 GMT
Cache-Control: no-store
Pragma: no-cache
Content-type: text/plain
Content-length: xx
Load=2253
Conns=5150
Mbps=6.42
Note: The load balancer should consider the service down if the URL request fails for any of the following reasons: no TCP connection (proxy down), response too slow (proxy deadlocked or not responsive), or an invalid response.
Note: The default port for these health check URLs is 8083, but it can be changed in the configuration file. The value can be changed in records.config by assigning the desired value to proxy.config.admin.autoconf_port. These URLs help ensure that the system is functioning correctly and allow for proactive management of the network's performance.

A format file, /opt/WCG/config/health.load.template, allows for customization of the response format.

Format specifiers are:

%L = Load (integer)

%C = Connections integer)

%B = Bandwidth in Mbps (double)

%% = %

The default health.load.template file is:

Load=%L Conns=%C Mbps=%B

Here is health.load.template modified to respond with an xml-like format:

<load>

<item name="Load" value="%L" />

<item name="Conns" value="%C" />

<item name="Mbps" value="%B" />

</load>