Skip to main content
Version: 1.7.x.x LTS

Management Endpoints

nevisLogRend implements two management endpoints that can, for example, be used to integrate with Kubernetes. One of the endpoints provides liveness information and the other one readiness information. Check the Kubernetes documentation for more information on how to configure the liveness and readiness probes.

info

The management endpoints are only supported when using the standalone deployment of nevisLogRend.

The endpoints described in this section are experimental and might change in future releases.

Readiness endpoint​

The readiness endpoint informs whether the server is ready to properly handle requests or not. The readiness endpoint is accessible when using the server port which is configured using the server.port property as described in the Server configuration properties. The following table describes the HTTP API of the readiness endpoint:

| Readiness endpoint | | | --- | | | Default URL | https://hostname:8997/nevislogrend/liveness | | Request HTTP method | GET | | Response content-type | application/json;charset=utf-8 | | Response body if nevisLogRend is ready | { "status" : "UP" } | | HTTP status code if nevisLogRend is ready | 200 (OK) | | Response body if nevisLogRend is not ready | { "status" : "DOWN" } | | HTTP status code if nevisLogRend is not ready | 503 (Service Unavailable) |

Liveness endpoint​

The liveness endpoint informs whether the server is up or not. The server might be up and running but it might not be ready to properly handle requests (for instance, because of a misconfiguration). The liveness endpoint is accessible using the management port which is configured when using the management.server.port property as described in the Server configuration properties. Currently, only HTTP is supported.

The following table describes the HTTP API of the liveness endpoint:

| Liveness endpoint | | | --- | | | Default URL | https://hostname:8997/nevislogrend/liveness | | Request HTTP method | GET | | Response content-type | application/json;charset=utf-8 | | Response body if nevisLogRend is alive | { "status" : "UP" } | | HTTP status code if nevisLogRend is alive | 200 (OK) |