Index Statistics API
Overview
The Index Statistics REST API is provided by the Index service. This API enables you to get Index service statistics.
The API schemes and host URLs are as follows:
-
https://node:19102/(for secure access)
where node is the host name or IP address of a computer running the index service.
Paths
This section describes the operations available with this REST API.
Table of Contents
Get Statistics for an Index Node
GET /api/v1/stats
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
pretty |
Whether the output should be formatted with indentations and newlines. |
boolean |
|
Query |
skipEmpty |
Whether empty, null, or zero statistics should be omitted from the output. |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success.
Returns an object containing a nested |
Node and Indexes
| Name | Description | Schema |
|---|---|---|
indexer |
A nested object containing statistics for the current index node. |
|
<keyspace>:<index> |
A nested object containing statistics for an entire index.
|
Example HTTP request
Request 1: Return statistics for an index node and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats?pretty=true"Request 2: Return statistics for an index node, omit empty results, and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats?skipEmpty=true&pretty=true"Example HTTP response
Result of request 1.
{
"indexer": {
"indexer_state": "Active",
"memory_quota": 536870912,
"memory_total_storage": 14708736,
"memory_used": 290727936,
"total_indexer_gc_pause_ns": 309778455
},
"travel-sample:def_airportname": {
"avg_drain_rate": 0,
"avg_item_size": 73,
"avg_scan_latency": 0,
"cache_hit_percent": 0,
"cache_hits": 0,
"cache_misses": 0,
"data_size": 514623,
"disk_size": 872448,
"frag_percent": 56,
"initial_build_progress": 100,
"items_count": 1968,
"last_known_scan_time": 0,
"memory_used": 3498,
"num_docs_indexed": 0,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 0,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 0,
"recs_on_disk": 1968,
"resident_percent": 0,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
"travel-sample:def_city": {
"avg_drain_rate": 0,
"avg_item_size": 59,
"avg_scan_latency": 0,
"cache_hit_percent": 0,
"cache_hits": 0,
"cache_misses": 0,
"data_size": 1083447,
"disk_size": 1138688,
"frag_percent": 56,
"initial_build_progress": 100,
"items_count": 7380,
"last_known_scan_time": 0,
"memory_used": 16330,
"num_docs_indexed": 0,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 0,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 0,
"recs_on_disk": 7380,
"resident_percent": 0,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
...
}
}Result of request 2.
{
"indexer": {
"indexer_state": "Active",
"memory_quota": 536870912,
"memory_total_storage": 14708736,
"memory_used": 376973312
},
"travel-sample:def_airportname": {
"avg_item_size": 73,
"data_size": 514623,
"disk_size": 872448,
"frag_percent": 56,
"initial_build_progress": 100,
"items_count": 1968,
"memory_used": 3498,
"recs_on_disk": 1968
},
"travel-sample:def_city": {
"avg_item_size": 59,
"data_size": 1083447,
"disk_size": 1138688,
"frag_percent": 56,
"initial_build_progress": 100,
"items_count": 7380,
"memory_used": 16330,
"recs_on_disk": 7380
},
...
}Get Statistics for Indexes in a Keyspace
GET /api/v1/stats/{keyspace}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
keyspace |
The name of a keyspace.
This must contain a bucket name, which may be followed by an optional scope name and an optional collection name, separated by dots.
For example, If any part of the keyspace name contains a dot, that part of the keyspace name must be wrapped in backticks.
For example, |
string |
|
Query |
pretty |
Whether the output should be formatted with indentations and newlines. |
boolean |
|
Query |
skipEmpty |
Whether empty, null, or zero statistics should be omitted from the output. |
boolean |
|
|
If the keyspace path parameter specifies just a bucket name, the response contains statistics for all indexes in all collections in all scopes within that bucket. If this parameter specifies a bucket name and a scope name, the response contains statistics for all indexes in all collections within that scope. Similarly, if this parameter specifies a bucket name, a scope name, and a collection, the response contains statistics for all indexes in that collection. To get statistics for the indexes in the default collection in the default scope within a bucket only, you must specify the scope and collection explicitly.
For example, |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success.
Returns an object containing one or more nested |
|
404 |
Not found. Returns the complete specified keyspace name, and the specified index name if provided. The keyspace name may be incorrect, the keyspace may contain no indexes, the index may not be located in the specified keyspace, or the index may be warming up after a restart. |
string |
Indexes
| Name | Description | Schema |
|---|---|---|
<keyspace>:<index> |
A nested object containing statistics for an entire index.
|
Example HTTP request
Request 3: Return statistics for all indexes in a scope, omit empty results, and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats/travel-sample.inventory?pretty=true&skipEmpty=true"Request 4: Return statistics for all indexes in a collection, omit empty results, and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats/travel-sample.inventory.airline?pretty=true&skipEmpty=true"Example HTTP response
Result of request 3.
{
"travel-sample:inventory:airline:def_inventory_airline_primary": {
"avg_item_size": 12,
"avg_scan_latency": 2898606,
"cache_hit_percent": 75,
"cache_hits": 3,
"cache_misses": 1,
"data_size": 213281,
"disk_size": 747993,
"frag_percent": 79,
"initial_build_progress": 100,
"items_count": 187,
"last_known_scan_time": 1620385003874921293,
"memory_used": 12258,
"num_requests": 4,
"num_rows_returned": 748,
"recs_in_mem": 187,
"resident_percent": 100,
"scan_bytes_read": 9016,
"total_scan_duration": 12789504
},
"travel-sample:inventory:airport:def_inventory_airport_airportname": {
"avg_item_size": 73,
"data_size": 514569,
"disk_size": 1664271,
"frag_percent": 72,
"initial_build_progress": 100,
"items_count": 1968,
"memory_used": 3880,
"recs_on_disk": 1968
},
...
}Result of request 4.
{
"travel-sample:inventory:airline:def_inventory_airline_primary": {
"avg_item_size": 12,
"avg_scan_latency": 2898606,
"cache_hit_percent": 75,
"cache_hits": 3,
"cache_misses": 1,
"data_size": 213281,
"disk_size": 747993,
"frag_percent": 79,
"initial_build_progress": 100,
"items_count": 187,
"last_known_scan_time": 1620385003874921293,
"memory_used": 12258,
"num_requests": 4,
"num_rows_returned": 748,
"recs_in_mem": 187,
"resident_percent": 100,
"scan_bytes_read": 9016,
"total_scan_duration": 12789504
}
}Get Statistics for an Index
GET /api/v1/stats/{keyspace}/{index}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
keyspace |
The name of a keyspace.
This must contain a bucket name, which may be followed by an optional scope name and an optional collection name, separated by dots.
For example, If any part of the keyspace name contains a dot, that part of the keyspace name must be wrapped in backticks.
For example, |
string |
|
Path |
index |
The name of an index. |
string |
|
Query |
pretty |
Whether the output should be formatted with indentations and newlines. |
boolean |
|
Query |
partition |
Whether statistics for index partitions should be included. |
boolean |
|
Query |
skipEmpty |
Whether empty, null, or zero statistics should be omitted from the output. |
boolean |
|
|
In most cases, the keyspace path parameter must specify the complete name of the keyspace containing the index. It may not omit the scope name or the collection name. However, if the specified index is stored in the default collection in the default scope within a bucket, then the keyspace path parameter may specify just the bucket name alone. |
|
It is not possible to specify an individual index partition in the path. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success.
Returns an object containing one nested If the partition query parameter was set to |
|
404 |
Not found. Returns the complete specified keyspace name, and the specified index name if provided. The keyspace name may be incorrect, the keyspace may contain no indexes, the index may not be located in the specified keyspace, or the index may be warming up after a restart. |
string |
Index and Partitions
| Name | Description | Schema |
|---|---|---|
<keyspace>:<index> |
A nested object containing statistics for an entire index.
|
|
Partition-<num> |
A nested object containing statistics.
|
Example HTTP request
Request 5: Return statistics for an index and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats/travel-sample.inventory.route/def_sourceairport_partn?pretty=true"Request 6: Return statistics for an index, include partitions, and format the output.
curl -X GET -u Administrator:password \
"http://localhost:9102/api/v1/stats/travel-sample.inventory.route/def_sourceairport_partn?partition=true&pretty=true"Example HTTP response
Result of request 5.
{
"travel-sample:inventory:route:def_sourceairport_partn": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 12003,
"cache_misses": 0,
"data_size": 2495580,
"disk_size": 2102624,
"frag_percent": 64,
"initial_build_progress": 100,
"items_count": 12003,
"last_known_scan_time": 0,
"num_docs_indexed": 15778,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 15778,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 15815,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
}
}Result of request 6.
{
"Partition-2": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 3006,
"cache_misses": 0,
"data_size": 625087,
"disk_size": 528728,
"frag_percent": 65,
"initial_build_progress": 0,
"items_count": 3006,
"last_known_scan_time": 0,
"num_docs_indexed": 3926,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 3926,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 4010,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
"Partition-3": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 2992,
"cache_misses": 0,
"data_size": 622348,
"disk_size": 520536,
"frag_percent": 64,
"initial_build_progress": 0,
"items_count": 2992,
"last_known_scan_time": 0,
"num_docs_indexed": 3933,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 3933,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 3996,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
"Partition-4": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 3008,
"cache_misses": 0,
"data_size": 625267,
"disk_size": 528728,
"frag_percent": 65,
"initial_build_progress": 0,
"items_count": 3008,
"last_known_scan_time": 0,
"num_docs_indexed": 3965,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 3965,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 4011,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
"Partition-5": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 2997,
"cache_misses": 0,
"data_size": 622878,
"disk_size": 524632,
"frag_percent": 64,
"initial_build_progress": 0,
"items_count": 2997,
"last_known_scan_time": 0,
"num_docs_indexed": 3954,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 3954,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 3798,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
},
"travel-sample:inventory:route:def_sourceairport_partn": {
"avg_drain_rate": 0,
"avg_item_size": 41,
"avg_scan_latency": 0,
"cache_hit_percent": 100,
"cache_hits": 12003,
"cache_misses": 0,
"data_size": 2495580,
"disk_size": 2102624,
"frag_percent": 64,
"initial_build_progress": 100,
"items_count": 12003,
"last_known_scan_time": 0,
"num_docs_indexed": 15778,
"num_docs_pending": 0,
"num_docs_queued": 0,
"num_items_flushed": 15778,
"num_pending_requests": 0,
"num_requests": 0,
"num_rows_returned": 0,
"num_scan_errors": 0,
"num_scan_timeouts": 0,
"recs_in_mem": 15815,
"recs_on_disk": 0,
"resident_percent": 100,
"scan_bytes_read": 0,
"total_scan_duration": 0
}
}Definitions
This section describes the properties returned by this REST API.
Table of Contents
Node
| Name | Description | Schema |
|---|---|---|
indexer_state |
Current state of the Index service on this node. |
enum (Active, Pause, Warmup) |
memory_quota |
Memory quota assigned to the Index service on this node by user configuration (bytes). |
integer (int64) |
memory_total_storage |
The total size allocated in the indexer across all indexes (bytes).
This also accounts for memory fragmentation. |
integer |
memory_used |
Amount of memory used by the Index service on this node (bytes). |
integer |
total_indexer_gc_pause_ns |
The total time the indexer has spent in GC pause since last startup (ns). |
integer |
Index
| Name | Description | Schema | ||
|---|---|---|---|---|
avg_array_length |
(Array indexes only.) The average number of items indexed per document. |
integer |
||
avg_drain_rate |
Average number of items flushed from memory to disk storage per second. |
integer |
||
avg_item_size |
Average size of the keys. |
integer |
||
avg_scan_latency |
Average time to serve a scan request (nanoseconds). |
integer |
||
cache_hit_percent |
Percentage of memory accesses that were served from the managed cache. |
integer |
||
cache_hits |
Accesses to this index data from RAM. |
integer |
||
cache_misses |
Accesses to this index data from disk. |
integer |
||
data_size |
The size of indexable data that is maintained for the index or partition (bytes). |
integer |
||
disk_size |
Total disk file size consumed by the index or partition. |
integer |
||
docid_count |
(Array indexes only.) The number of documents currently indexed. |
integer |
||
frag_percent |
Percentage fragmentation of the index.
|
integer |
||
initial_build_progress |
Percentage initial build progress for the index.
When initial build is completed, the value is For an index partition, the value is listed as |
integer |
||
items_count |
The number of items currently indexed. |
integer |
||
last_known_scan_time |
Time of the last scan request received for this index (Unix timestamp in nanoseconds). This may be useful for determining whether this index is currently unused.
|
integer (int64) |
||
num_docs_indexed |
Number of documents indexed by the indexer since last startup. |
integer |
||
num_docs_pending |
Number of documents pending to be indexed. |
integer |
||
num_docs_queued |
Number of documents queued to be indexed. |
integer |
||
num_items_flushed |
Number of items flushed from memory to disk storage. |
integer |
||
num_pending_requests |
Number of requests received but not yet served by the indexer. |
integer |
||
num_requests |
Number of requests served by the indexer since last startup. |
integer |
||
num_rows_returned |
Total number of rows returned so far by the indexer. |
integer |
||
num_scan_errors |
Number of requests that failed due to errors other than timeout. |
integer |
||
num_scan_timeouts |
Number of requests that timed out, either waiting for snapshots or during scan in progress. |
integer |
||
recs_in_mem |
For standard index storage, this is the number of records in this index that are stored in memory. For memory-optimized index storage, this is the same as |
integer |
||
recs_on_disk |
For standard index storage, this is the number of records in this index that are stored on disk. For memory-optimized index storage, this is |
integer |
||
resident_percent |
Percentage of the data held in memory. |
integer |
||
scan_bytes_read |
Number of bytes read by a scan since last startup. |
integer |
||
total_scan_duration |
Total time spent by the indexer in scanning rows since last startup (nanoseconds). |
integer |
Security
The Index Statistics API supports admin credentials. Credentials can be passed via HTTP headers (HTTP basic authentication).
Node Statistics
To get Node statistics, users must have the Query System Catalog RBAC role.
Type : basic
Index Statistics
To get Index statistics for all indexes in a bucket, scope, or collection, users must have the Query System Catalog RBAC role, or the Query Manage Index RBAC role with permissions on that bucket, scope, or collection.
To get Index statistics for an individual index, users must have the Query System Catalog RBAC role, or the Query Manage Index RBAC role with permissions on the bucket, scope, and collection containing that index.
Type : basic
Refer to Roles for more details.