Rename index retention metrics (#43232)

It's confusing that some retention metrics are named without specifying that they are for index retention, not document retention.

GitOrigin-RevId: f506c4ced78e84a5445abb56e1d6546b5052a5b1

Author: emmaling27

crates/database/src/metrics.rs

@@ -447,11 +447,11 @@ pub fn retention_advance_timestamp_timer() -> Timer<VMHistogram> {
 }
 
 register_convex_histogram!(
-    RETENTION_DELETE_SECONDS,
-    "Time for retention to complete deletions"
+    INDEX_RETENTION_DELETE_SECONDS,
+    "Time for index retention to complete deletions"
 );
-pub fn retention_delete_timer() -> Timer<VMHistogram> {
-    Timer::new(&RETENTION_DELETE_SECONDS)
+pub fn index_retention_delete_timer() -> Timer<VMHistogram> {
+    Timer::new(&INDEX_RETENTION_DELETE_SECONDS)
 }
 
 register_convex_histogram!(
@@ -463,11 +463,11 @@ pub fn retention_delete_documents_timer() -> Timer<VMHistogram> {
 }
 
 register_convex_histogram!(
-    RETENTION_DELETE_CHUNK_SECONDS,
-    "Time for retention to delete one chunk"
+    INDEX_RETENTION_DELETE_CHUNK_SECONDS,
+    "Time for index retention to delete one chunk"
 );
-pub fn retention_delete_chunk_timer() -> Timer<VMHistogram> {
-    Timer::new(&RETENTION_DELETE_CHUNK_SECONDS)
+pub fn index_retention_delete_chunk_timer() -> Timer<VMHistogram> {
+    Timer::new(&INDEX_RETENTION_DELETE_CHUNK_SECONDS)
 }
 
 register_convex_histogram!(
@@ -478,17 +478,20 @@ pub fn retention_delete_document_chunk_timer() -> Timer<VMHistogram> {
     Timer::new(&RETENTION_DELETE_DOCUMENT_CHUNK_SECONDS)
 }
 
-register_convex_histogram!(RETENTION_CURSOR_AGE_SECONDS, "Age of the retention cursor");
-pub fn log_retention_cursor_age(age_secs: f64) {
-    log_distribution(&RETENTION_CURSOR_AGE_SECONDS, age_secs)
+register_convex_histogram!(
+    INDEX_RETENTION_CURSOR_AGE_SECONDS,
+    "Age of the index retention cursor"
+);
+pub fn log_index_retention_cursor_age(age_secs: f64) {
+    log_distribution(&INDEX_RETENTION_CURSOR_AGE_SECONDS, age_secs)
 }
 
 register_convex_histogram!(
-    RETENTION_CURSOR_LAG_SECONDS,
-    "Lag between the retention cursor and the min index snapshot"
+    INDEX_RETENTION_CURSOR_LAG_SECONDS,
+    "Lag between the index retention cursor and the min index snapshot"
 );
-pub fn log_retention_cursor_lag(age_secs: f64) {
-    log_distribution(&RETENTION_CURSOR_LAG_SECONDS, age_secs)
+pub fn log_index_retention_cursor_lag(age_secs: f64) {
+    log_distribution(&INDEX_RETENTION_CURSOR_LAG_SECONDS, age_secs)
 }
 
 register_convex_histogram!(
@@ -508,11 +511,11 @@ pub fn log_document_retention_cursor_lag(age_secs: f64) {
 }
 
 register_convex_counter!(
-    RETENTION_MISSING_CURSOR_INFO,
+    INDEX_RETENTION_MISSING_CURSOR_INFO,
     "Index retention has no cursor"
 );
-pub fn log_retention_no_cursor() {
-    log_counter(&RETENTION_MISSING_CURSOR_INFO, 1)
+pub fn log_index_retention_no_cursor() {
+    log_counter(&INDEX_RETENTION_MISSING_CURSOR_INFO, 1)
 }
 
 register_convex_counter!(
@@ -524,13 +527,13 @@ pub fn log_document_retention_no_cursor() {
 }
 
 register_convex_counter!(
-    RETENTION_SCANNED_DOCUMENT_TOTAL,
-    "Count of documents scanned by retention",
+    INDEX_RETENTION_SCANNED_DOCUMENT_TOTAL,
+    "Count of documents scanned by index retention",
     &["tombstone", "prev_rev"]
 );
-pub fn log_retention_scanned_document(is_tombstone: bool, has_prev_rev: bool) {
+pub fn log_index_retention_scanned_document(is_tombstone: bool, has_prev_rev: bool) {
     log_counter_with_labels(
-        &RETENTION_SCANNED_DOCUMENT_TOTAL,
+        &INDEX_RETENTION_SCANNED_DOCUMENT_TOTAL,
         1,
         vec![
             StaticMetricLabel::new(

crates/database/src/retention.rs

@@ -132,26 +132,26 @@ use value::InternalDocumentId;
 
 use crate::{
     metrics::{
+        index_retention_delete_chunk_timer,
+        index_retention_delete_timer,
         latest_min_document_snapshot_timer,
         latest_min_snapshot_timer,
         log_document_retention_cursor_age,
         log_document_retention_cursor_lag,
         log_document_retention_no_cursor,
         log_document_retention_scanned_document,
-        log_retention_cursor_age,
-        log_retention_cursor_lag,
+        log_index_retention_cursor_age,
+        log_index_retention_cursor_lag,
+        log_index_retention_no_cursor,
+        log_index_retention_scanned_document,
         log_retention_documents_deleted,
         log_retention_expired_index_entry,
         log_retention_index_entries_deleted,
-        log_retention_no_cursor,
-        log_retention_scanned_document,
         log_retention_ts_advanced,
         log_snapshot_verification_age,
         retention_advance_timestamp_timer,
-        retention_delete_chunk_timer,
         retention_delete_document_chunk_timer,
         retention_delete_documents_timer,
-        retention_delete_timer,
     },
     snapshot_manager::SnapshotManager,
     BootstrapMetadata,
@@ -579,7 +579,7 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
             // If this happens for a tombstone, it means the document was created and
             // deleted in the same transaction, with no index rows.
             let Some(prev_rev) = prev_rev else {
-                log_retention_scanned_document(maybe_doc.is_none(), false);
+                log_index_retention_scanned_document(maybe_doc.is_none(), false);
                 continue;
             };
             let DocumentRevision {
@@ -594,10 +594,10 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
                     prev_ts = prev_rev.ts
                 );
                 report_error(&mut e).await;
-                log_retention_scanned_document(maybe_doc.is_none(), false);
+                log_index_retention_scanned_document(maybe_doc.is_none(), false);
                 continue;
             };
-            log_retention_scanned_document(maybe_doc.is_none(), true);
+            log_index_retention_scanned_document(maybe_doc.is_none(), true);
             for (index_id, (_, index_fields)) in all_indexes
                 .iter()
                 .filter(|(_, (index, _))| *index.table() == id.table())
@@ -967,7 +967,7 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
         persistence: Arc<dyn Persistence>,
         mut new_cursor: Timestamp,
     ) -> anyhow::Result<(Timestamp, usize)> {
-        let _timer = retention_delete_chunk_timer();
+        let _timer = index_retention_delete_chunk_timer();
         let index_entries_to_delete = delete_chunk.len();
         tracing::trace!("delete: got entries to delete {index_entries_to_delete:?}");
         for index_entry_to_delete in delete_chunk.iter() {
@@ -1087,7 +1087,7 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
             );
             let span = get_sampled_span("", "delete_indexes", &mut rt.rng());
             let r: anyhow::Result<()> = async {
-                let _timer = retention_delete_timer();
+                let _timer = index_retention_delete_timer();
                 let cursor = Self::get_checkpoint(
                     reader.as_ref(),
                     snapshot_reader.clone(),
@@ -1307,11 +1307,11 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
                     );
                 },
                 RetentionType::Index => {
-                    log_retention_cursor_age(
+                    log_index_retention_cursor_age(
                         (*snapshot_reader.lock().persisted_max_repeatable_ts())
                             .secs_since_f64(*cursor),
                     );
-                    log_retention_cursor_lag(
+                    log_index_retention_cursor_lag(
                         bounds_reader
                             .lock()
                             .min_index_snapshot_ts
@@ -1322,7 +1322,7 @@ impl<RT: Runtime> LeaderRetentionManager<RT> {
         } else {
             match retention_type {
                 RetentionType::Document => log_document_retention_no_cursor(),
-                RetentionType::Index => log_retention_no_cursor(),
+                RetentionType::Index => log_index_retention_no_cursor(),
             }
         }
         Ok(())