From b78089631d5633c18e3334732b9b7bcb89f7a17e Mon Sep 17 00:00:00 2001 From: Ray Offiah Date: Thu, 18 Dec 2025 16:28:43 +0000 Subject: [PATCH 1/2] [DOC-12408]: Feedback on Index Service Metrics | Couchbase Docs Added additional details for `index_cache_hits` and `index_cache_misses` Fixed minor error on the template. Signed-off-by: Ray Offiah --- .../metrics-reference/attachments/index_metrics_metadata.json | 4 ++-- modules/metrics-reference/partials/metrics.hbs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/metrics-reference/attachments/index_metrics_metadata.json b/modules/metrics-reference/attachments/index_metrics_metadata.json index 877ce46e5c..179e508f3c 100644 --- a/modules/metrics-reference/attachments/index_metrics_metadata.json +++ b/modules/metrics-reference/attachments/index_metrics_metadata.json @@ -54,7 +54,7 @@ "unit": "Nanoseconds" }, "index_cache_hits": { - "help": "The number of times the required index page for both scan and mutations is found in memory, for this index", + "help": "The number of times the required index page for both scan and mutations is found in memory, for this index. It is normal to see activity in `index_cache_hits` even when no index scans are occurring. This is because the metric track memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; a successful find is recorded as a hit.", "labels": [ "bucket", "scope", @@ -65,7 +65,7 @@ "type": "counter" }, "index_cache_misses": { - "help": "The number of times the required index page for both scan and mutations is NOT found in memory, for this index", + "help": "The number of times the required index page for both scan and mutations is NOT found in memory, for this index. It is normal to see activity in `index_cache_misses` even when no index scans are occurring. This is because the metric tracks memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; if a disk fetch is required, it is recorded as a miss.", "labels": [ "bucket", "scope", diff --git a/modules/metrics-reference/partials/metrics.hbs b/modules/metrics-reference/partials/metrics.hbs index 324647f7a6..c1025bb2d9 100644 --- a/modules/metrics-reference/partials/metrics.hbs +++ b/modules/metrics-reference/partials/metrics.hbs @@ -12,7 +12,7 @@ [TIP.key] ==== * The [.edition]#x.y.z# badge shows the Couchbase Server version the metric was added in. -* The [.status]#type / unit# badge shows shows the Prometheus +* The [.status]#type / unit# badge shows the Prometheus https://prometheus.io/docs/tutorials/understanding_metric_types/[type] and https://prometheus.io/docs/practices/naming/#base-units[unit] (if present). ==== From 890e972170cf715b2ce350339ed359dc607c688b Mon Sep 17 00:00:00 2001 From: Ray Offiah Date: Fri, 19 Dec 2025 10:09:30 +0000 Subject: [PATCH 2/2] [DOC-12408]: Feedback on Index Service Metrics | Couchbase Docs Changes following review. The change is being made here so we don't forget what it says! Signed-off-by: Ray Offiah --- .../metrics-reference/attachments/index_metrics_metadata.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/metrics-reference/attachments/index_metrics_metadata.json b/modules/metrics-reference/attachments/index_metrics_metadata.json index 179e508f3c..de09e49377 100644 --- a/modules/metrics-reference/attachments/index_metrics_metadata.json +++ b/modules/metrics-reference/attachments/index_metrics_metadata.json @@ -54,7 +54,7 @@ "unit": "Nanoseconds" }, "index_cache_hits": { - "help": "The number of times the required index page for both scan and mutations is found in memory, for this index. It is normal to see activity in `index_cache_hits` even when no index scans are occurring. This is because the metric track memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; a successful find is recorded as a hit.", + "help": "The number of times an index page is found in the memory cache. It is normal to see activity in `index_cache_hits` even when no index scans are occurring. This is because the metric track memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; a successful find is recorded as a hit.", "labels": [ "bucket", "scope", @@ -65,7 +65,7 @@ "type": "counter" }, "index_cache_misses": { - "help": "The number of times the required index page for both scan and mutations is NOT found in memory, for this index. It is normal to see activity in `index_cache_misses` even when no index scans are occurring. This is because the metric tracks memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; if a disk fetch is required, it is recorded as a miss.", + "help": "The number of times an index page is found not in the memory cache. It is normal to see activity in `index_cache_misses` even when no index scans are occurring. This is because the metric tracks memory access for both scans and mutations. When an index is updated, the system checks if the relevant record is in memory; if a disk fetch is required, it is recorded as a miss.", "labels": [ "bucket", "scope",