Metrics REST API
API reference guide for the Couchbase Capella App Services Metrics API.
Prerequisites
You will first need to grant access to the admin REST APIs.
App Services
Endpoints
Prometheus
GET /_metrics
Debugging/monitoring runtime stats in Prometheus format
Description
| You will need to set up credentials and use the metrics endpoint address for the metrics service. (See the Setting Up a Connection for details). |
The _metrics method returns {SGW}'s statistics and other runtime variables in Prometheus format.
This makes for a convenient feed for your debugging or performance monitoring purposes.
- For more details on the metrics collected and reported by {SGW} -- see: {SGW} Statistics Schema.
- For more details on Monitoring {SGW} using the
_metricsfeed -- see: our blog on Monitoring and Visualization of Couchbase {SGW} with Prometheus and Grafana
{SGW} Roles Required:
- Sync Gateway Dev Ops
- External Stats Reader