Method | GET /_stats | |
Request | None | |
Response | Server statistics | |
Admin Privileges Required | no | |
Return Codes | ||
200 | Request completed successfully. |
The _stats
method returns a JSON object
containting the statistics for the running server. The object is
structured with top-level sections collating the statistics for a
range of entries, with each individual statistic being easily
identified, and the content of each statistic is self-describing.
For example, the request time statistics, within the
couchdb
section are structured as follows:
{ "couchdb" : { ... "request_time" : { "stddev" : "27.509", "min" : "0.333333333333333", "max" : "152", "current" : "400.976", "mean" : "10.837", "sum" : "400.976", "description" : "length of a request inside CouchDB without MochiWeb" }, ... } }
The fields provide the current, minimum and maximum, and a collection of statistical means and quantities. The quantity in each case is not defined, but the descriptions below provide
The statistics are divided into the following top-level sections:
couchdb
Describes statistics specific to the internals of CouchDB.
Table 9.5. couchdb
statistics
Statistic ID | Description | Unit |
---|---|---|
auth_cache_hits
| Number of authentication cache hits | number |
auth_cache_misses
| Number of authentication cache misses | number |
database_reads
| Number of times a document was read from a database | number |
database_writes
| Number of times a database was changed | number |
open_databases
| Number of open databases | number |
open_os_files
| Number of file descriptors CouchDB has open | number |
request_time
| Length of a request inside CouchDB without MochiWeb | milliseconds |
httpd_request_methods
Table 9.6. httpd_request_methods
statistics
Statistic ID | Description | Unit |
---|---|---|
COPY
| Number of HTTP COPY requests | number |
DELETE
| Number of HTTP DELETE requests | number |
GET
| Number of HTTP GET requests | number |
HEAD
| Number of HTTP HEAD requests | number |
POST
| Number of HTTP POST requests | number |
PUT
| Number of HTTP PUT requests | number |
httpd_status_codes
Table 9.7. httpd_status_codes
statistics
Statistic ID | Description | Unit |
---|---|---|
200
| Number of HTTP 200 OK responses | number |
201
| Number of HTTP 201 Created responses | number |
202
| Number of HTTP 202 Accepted responses | number |
301
| Number of HTTP 301 Moved Permanently responses | number |
304
| Number of HTTP 304 Not Modified responses | number |
400
| Number of HTTP 400 Bad Request responses | number |
401
| Number of HTTP 401 Unauthorized responses | number |
403
| Number of HTTP 403 Forbidden responses | number |
404
| Number of HTTP 404 Not Found responses | number |
405
| Number of HTTP 405 Method Not Allowed responses | number |
409
| Number of HTTP 409 Conflict responses | number |
412
| Number of HTTP 412 Precondition Failed responses | number |
500
| Number of HTTP 500 Internal Server Error responses | number |
httpd
Table 9.8. httpd
statistics
Statistic ID | Description | Unit |
---|---|---|
bulk_requests
| Number of bulk requests | number |
clients_requesting_changes
| Number of clients for continuous _changes | number |
requests
| Number of HTTP requests | number |
temporary_view_reads
| Number of temporary view reads | number |
view_reads
| Number of view reads | number |
You can also access individual statistics by quoting the
statistics sections and statistic ID as part of the URL path. For
example, to get the request_time
statistics,
you can use:
GET /_stats/couchdb/request_time
This returns an entire statistics object, as with the full request, but containining only the request individual statistic. Hence, the returned structure is as follows:
{ "couchdb" : { "request_time" : { "stddev" : 7454.305, "min" : 1, "max" : 34185, "current" : 34697.803, "mean" : 1652.276, "sum" : 34697.803, "description" : "length of a request inside CouchDB without MochiWeb" } } }