Basic REST API monitoring

The Access Gateway Monitoring REST API endpoint can be used to determine the current health of an Access Gateway cluster or stand alone instance.

Available since Access Gateway version 2021.7.3

The monitoring REST API endpoint is disabled by default. See Enable or Disable monitoring in the Managing REST API monitoring documentation for more information.

Request

To request basic monitor information you make a get request to the nodes /basic_status endpoint.

Include the following:

  • Host - Always monitoring.rest.service.oag.

The following curl example requests current status using the default endpoint.

curl -k -X GET -H "Host:monitoring.rest.service.oag" https://gw.{gateway.tld}/basic_status

On success

On success the following results are returned:

Active connections: {total active and waiting connections} server accepts handled requests {server accepts} {handled accepts} {total requests} Reading: {reads} Writing: {writes} Waiting: {waits}

Defined as:

Field Value
Active connections

The current number of active client connections including Waiting connections.

server accepts

The total number of accepted client connections.

handled The total number of handled connections.
Generally, the parameter value is the same as server accepts unless some resource limits have been reached.
requests The total number of client requests
Reading The current number of connections where Access Gateway is reading the request header.
Writing

The current number of connections where nginx is writing the response back to the client.

Waiting The current number of idle client connections waiting for a request.

For example:

Active connections: 291 server accepts handled requests 16630948 16630948 31070465 Reading: 6 Writing: 179 Waiting: 106

Other return results

400 Unknown host

The status endpoint is disabled.

Example:

<html><head><title>Access Gateway</title></head> <body> . . . <p>Status code: 400. . . The request . . . is not being served by this Access Gateway.</p> . . . </body> </html>

403 Forbidden

The client IP address has not been authorized to access the endpoint.

Example:

<html><head><title>403 Forbidden</title></head> <body> . . . </body> </html>

Related topics