Health Checks

The CEP provide a health check URL (/health) for monitoring. This URL can only be accessed by trusted clients. It returns a JSON body for detailed analysis and HTTP codes for quick status checks. The CEP run an internal health check the first time after startup and periodically every 30 seconds. The internal check cover an existing or successful creation of new endpoint session. Available disk space (>= 10 MB) and internal functionality of the portal itself will be checked.

Request

Curl Command

    curl https://cep.example.com/health/status

Response

Healthy Result (HTTP 200)

    {"status":"OK","endpoint":"OK","storage":"OK", "version": "1.9.27"}

Unhealthy Result (HTTP 503)

    {"status":"FAILED","endpoint":"FAILED","storage":"OK", "version": "1.9.27"}

No Result Available During Startup (HTTP 503)

    {"status":"UNKNOWN","endpoint":"UNKNOWN","storage":"UNKNOWN", "version": "1.9.27"}

Configuration

Add Additional Trusted Hosts

The following parameter allows configuring additional trusted client IP addresses. The IP address :1 and 127.0.0.1 are always trusted. Untrusted clients can check the cached result of the last health check via /health/status. /health/status will be updated every 30 seconds by the internal checks. The first status will be set after the container turned into the healthy status.

If the /health request comes from a trusted proxy, the X-Forwarded-For header overwrite the client IP address. The IP address of the proxy servers must be configured by CEP_AAF_TRUSTED_PROXIES parameter.

Example

    environment:
      - CEP_TRUSTED_HEALTHCHECK_IPS=["192.168.100.100", "192.168.100.1"]

Default

    environment:
      - CEP_TRUSTED_HEALTHCHECK_IPS=[]

Disable Version Disclosure

You can hide the version by disabling version disclosure for the CEP with the following parameter.

Example

    environment:
      - CEP_HIDE_VERSION=true

Default

    environment:
      - CEP_HIDE_VERSION=false