| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
After testing in a staging environment, roll out the Listing Cache to production by deploying the necessary configurations and code changes.
Monitor performance impact closely during the rollout phase.
Optional. Pre-warm the cache with commonly accessed listings before enabling it in production, so the initial requests are served from the cache.
How to Determine if the Listing Cache is Working Correctly
Monitor Cache Hit Rate
If you have telemetry and Grafana available, check the Listing Cache dashboard.
Check Response Time
Compare the response time before and after enabling the Listing Cache. Reduced response times, particularly for frequently requested folder listings, indicate the cache functions correctly.
Resource Utilization
Monitor memory usage and CPU utilization. Increased memory usage and steady CPU activity are normal in a caching system, but excessively high CPU or memory usage may indicate misconfiguration.
Metrics
| Code Block |
|---|
caringo_listingcache_request (Summary)
Request counts and latencies for write/delete/list, versioned/nonversioned.
Labels: method=[write, delete, list], mode=[V, NV]
caringo_listingcache_request_errors (Counter)
Request error counts for write/delete/list, versioned/nonversioned.
Labels: method=[write, delete, list], mode=[V, NV]
caringo_listingcache_listed_recs (Counter)
Total number of records returned by the listing cache, versioned/nonversioned.
Labels: mode=[V, NV]
caringo_listingcache_backend_query (Summary)
Counts and latencies of ES queries for priming/listing, versioned/nonversioned.
Labels: method=["list", "prime"], mode=[V, NV]
caringo_listingcache_backend_query_recs (Counter)
Number of ES records queried for priming/listing, versioned/nonversioned.
Labels: method=["list", "prime"], mode=[V, NV]
caringo_listingcache_cache_query (Summary)
Counts and latencies of SqliteDB queries for priming/listing, versioned/nonversioned.
Labels: method=["list", "prime", "reconciliation"], mode=[V, NV]
caringo_listingcache_cache_query_recs (Counter)
Number of SqliteDB records queried for priming/listing, versioned/nonversioned.
Labels: method=["list", "prime", "reconciliation"], mode=[V, NV]
caringo_listingcache_flushes_pending (Gauge)
Folder updates pending flush to SqliteDB disk cache.
caringo_listingcache_flushes_done (Counter)
Folder updates flushed to SqliteDB disk cache.
caringo_listingcache_trims_pending (Gauge)
Folders pending trim in memory cache.
caringo_listingcache_trims_done (Counter)
Folders trimmed in memory cache.
caringo_listingcache_folder_pulls_pending (Gauge)
Folders marked to be internally pulled into cache.
caringo_listingcache_folder_pulls_done (Counter)
Folders internally pulled into cache.
caringo_listingcache_mem_cached (Gauge)
Folders currently in memory cache.
caringo_listingcache_mem_evicted (Counter)
Folders evicted from memory cache.
caringo_listingcache_dbhandle_cached (Gauge)
SqliteDB handles currently in memory cache.
caringo_listingcache_dbhandle_evicted (Counter)
SqliteDB handles evicted from memory cache.
caringo_listingcache_disk_cached (Gauge)
SqliteDBs currently in disk cache.
caringo_listingcache_disk_evicted (Counter)
Folders evicted from disk cache.
caringo_listingcache_disk_cached_bytes (Gauge)
Size in bytes of SqliteDBs currently in disk cache.
caringo_listingcache_disk_evicted_bytes (Counter)
Size in bytes of SqliteDBs evicted from disk cache.
caringo_listingcache_reconciliations_done (Counter)
Number of cache records reconciled (versionid mismatches corrected based on etag).
Labels: origin=[backend,cache]
caringo_listingcache_memory_used (Gauge)
Memory use as perceived by the listing cache.
caringo_listingcache_disk_free (Gauge)
Disk free space as perceived by the listing cache. |
How to Determine if the Listing Cache is Working Correctly
...
Monitor Cache Hit Rate
If you have telemetry and Grafana available, check the Listing Cache dashboard.
...
Check Response Time
Compare the response time before and after enabling the Listing Cache. Reduced response times, particularly for frequently requested folder listings, indicate the cache functions correctly.
Resource Utilization
...
. |