Metrics REST API
Description of the Sync Gateway Metrics Rest API
Related REST API topics: Public REST API | Admin REST API | Use the REST API? | Monitor | Prometheus Integration
Introduction
Sync Gateway makes collecting performance data easy and secure by providing a Metrics REST API. It exposes Sync Gateway’s stats on two endpoints, which deliver the same data in one of two formats:
-
The
_metricsendpoint returns Sync Gateway statistics in Prometheus
format.
For example:GET host:4986/_metricsFor information on integration with Prometheus — see Prometheus Integration and our blog entry Monitoring Couchbase Sync Gateway with Prometheus and Grafana.
-
The
_expvarsendpoint returns Sync Gateway statistics in JSON format.
This API, separate from both the Public and Admin REST APIs, is available by default on port 4986 — see Configuration for how to change this, if needed.
To allow users to access the Metrics API up you need to create a Couchbase Server-based RBAC-user for them — see: REST API Access
Configuration
The Metrics REST API is enabled by default on port 4986.
To change this you need to edit the api.metricsInterface setting in your bootstrap configuration file and define the Sync Gateway URL and the port you want the API served on (for example: 4986) — see: Example 1.
- Alternatively
-
If you are using 2.x file-based configuration then edit the
metricsInterfacesetting in thesync-gateway-config.jsonconfiguration file — see: Legacy Pre-3.0 Configuration
-
Persistent Configuration
-
2.x File-based Configuration
Within the bootstrap configuration file:
"api.metricsInterface": "127.0.0.1:4986" (1)Within the sync gateway configuration file:
"metricsInterface": "127.0.0.1:4986" (1)| 1 | Here we define the Sync Gateway URL and the port (4986 in this instance) that we require the Metrics REST API to be served on. |
API Reference
The API reference groups all the endpoints by functionality. For more information, refer to View Statistics and Metrics. You can also generate curl requests if required, for each endpoint: