Test Metrics monitoring with REST

The Access Gateway /metrics REST API endpoint is used to return node-specific metrics. To perform a metrics request, specify the following parameters:

Protocol HTTPS
Request GET
IP IP Address of admin or worker node

Available options:

  • -X GET: Optional. Defaults to a get request.
  • -v: Verbose. Optional
  • -k: Insecure

The following curl example requests the status of the 10.0.0.10 node using the /metrics endpoint using an IP address:

Copy 
curl -X GET -v http://10.0.0.10:8889/metrics

The following curl example requests the status of the 10.0.0.10 node using the /metrics endpoint using a domain name:

Copy 
curl -X GET -v http://gw.atko.com:8889/metrics

On success

The request returns 200 on success followed by the current set of metrics. See Supported metrics for more information.

#HELP OAG_go_goroutines Number of goroutines that currently exist. #TYPE OAG_go_goroutines gauge OAG_go_goroutines 7 . . . # HELP OAG_syslog_ng_service_state The current state of syslog_ng service # TYPE OAG_syslog_ng_service_state gauge OAG_syslog_ng_service_state 1

On error

The request returns 404 if it times out or if there's an error.

404 page not found