Server status endpoint - Platform - BlueCat Gateway - 18.12.1

Gateway Administration Guide

prodname
BlueCat Gateway
version_custom
18.12.1
This endpoint allows you to get the basic application statistics that can be used for monitoring or load balancing.
GET <bluecat_gateway>/serverstatus

The response returns HTTP code 200 with statistics that includes CPU load, memory usage, resource usage score, aggregated access counts, and total traffic since the server was started. Below is an example of values returned:

{"data":
    {
       "cpu_load": 0.0553746,
       "memory_used": 199839744,
       "total_accesses": 79,
       "total_traffic": 116736,
       "resource_usage_score": 0.24
    },
 "current_time": 1513807211
}
Note:
  • cpu_load—score will not go to 1 even if you are running multiple CPU cores; currently BlueCat Gateway only uses a single CPU core.
  • memory_used—displays the memory used on the host machine in bytes. Limit of memory consumption depends on the specifications of the host machine.
CAUTION:
The BlueCat Gateway server will crash if the resource_usage_score reaches 1, so BlueCat recommends that the resource_usage_score be kept below 0.50. You can keep the resource_usage_score below 0.50 by redirecting new requests to a different BlueCat Gateway instance.
Note: No authentication is required.