System Status and Metrics REST API

System Status Checks

Available Purpose URL Requires Auth
3.16.0 ready for read operations? /service/rest/v1/status no
3.16.0 ready for write operations? ie. non-frozen /service/rest/v1/status/writable no
3.20.0 System Status Checks /service/rest/v1/status/check yes

/status/check - requires authentication by an administrator user or a user with the "nx-metrics-all" privilege, responds with 200 status code even if one or more status checks fail

/status , /status/writable - success is represented as 200 status code, failure is represented as 503 

Metrics

Nexus 3 has metrics information available in the administration support UI.

A REST API is also available.

Supported Metrics REST API

Available Purpose URL Requires Auth
3.0.0 JSON formatted metric data /service/metrics/data yes
3.0.0 HTTP connector alive? /service/metrics/ping yes
3.0.0 capture a thread dump /service/metrics/threads yes
3.19.0 Prometheus consumable metrics /service/metrics/prometheus yes

/service/metrics/* - require authentication by an administrator user or a user with the "nx-metrics-all" privilege.

Deprecated Metrics REST API

/service/metrics/healthcheck - available 3.0.0, deprecated in 3.29.0, alternate is /service/rest/v1/status/check

Have more questions? Submit a request

0 Comments

Article is closed for comments.