Get cache statistics

GET /_searchable_snapshots/{node_id}/cache/stats
GET /_searchable_snapshots/cache/stats

Api key auth Basic auth Bearer auth

Get statistics about the shared cache for partially mounted indices.

Required authorization

Cluster privileges: manage

More about searchable snapshots

Path Parameters

node_id union NodeId | [] NodeId optional

The names of the nodes in the cluster to target.

Leave it out to use /_searchable_snapshots/cache/stats.

Response

application/json

Examples

A successful response from GET /_searchable_snapshots/cache/stats.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_searchable_snapshots/cache/stats

JavaScript Elasticsearch JavaScript Client

const response = await client.searchableSnapshots.cacheStats();

Python Elasticsearch Python Client

resp = client.searchable_snapshots.cache_stats()

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_searchable_snapshots/cache/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.searchableSnapshots().cacheStats(c -> c);

C# Elasticsearch .NET Client

var response = await client.SearchableSnapshots.CacheStatsAsync();

PHP Elasticsearch PHP Client

$resp = $client->searchableSnapshots()->cacheStats();

Ruby Elasticsearch Ruby Client

response = client.searchable_snapshots.cache_stats

Response

{
  "nodes" : {
    "eerrtBMtQEisohZzxBLUSw" : {
      "shared_cache" : {
        "reads" : 6051, // The number of cache region read operations. If reads > writes, the difference represents requests successfully served from the cache without accessing the snapshot repository.
        "bytes_read_in_bytes" : 5448829,
        "writes" : 37, // The number of cache region write operations. If reads == writes, every request required fetching data from the snapshot repository into the cache.
        "bytes_written_in_bytes" : 1208320,
        "evictions" : 5, // The number of cache region evictions. A low eviction count indicates the cache is effectively serving requests. Use this metric to evaluate cache sizing.
        "num_regions" : 65536,
        "size_in_bytes" : 1099511627776,
        "region_size_in_bytes" : 16777216 // The size of each cache region. A region is a contiguous byte range stored on local disk.
      }
    }
  }
}