From 0fdb6adcb2451a6ef3bfc8c63d621747de7aeef2 Mon Sep 17 00:00:00 2001
From: WeblWabl <devandbenz@gmail.com>
Date: Tue, 3 Jun 2025 09:05:52 -0500
Subject: [PATCH] feat: Add new logging for compaction level 5 and remove bug
 with opt holdoff time (#26488) (#26490)

Previously

```go
// StartOptHoldOff will create a hold off timer for OptimizedCompaction
func (e *Engine) StartOptHoldOff(holdOffDurationCheck time.Duration, optHoldoffStart time.Time, optHoldoffDuration time.Duration) {
	startOptHoldoff := func(dur time.Duration) {
		optHoldoffStart = time.Now()
		optHoldoffDuration = dur
		e.logger.Info("optimize compaction holdoff timer started", logger.Shard(e.id), zap.Duration("duration", optHoldoffDuration), zap.Time("endTime", optHoldoffStart.Add(optHoldoffDuration)))
	}
	startOptHoldoff(holdOffDurationCheck)
}
```
was not passing the data by reference which meant we were never modifying the `optHoldoffDuration` and `optHoldoffStart` vars.

This PR also adds additional logging to Optimized level 5 compactions to clear up a little bit of confusion around log messages.

(cherry picked from commit 7437f275ff88d203d369459d740d9addb2911298)
---
 tsdb/engine/tsm1/engine.go | 22 +++++++++-------------
 1 file changed, 9 insertions(+), 13 deletions(-)

diff --git a/tsdb/engine/tsm1/engine.go b/tsdb/engine/tsm1/engine.go
index f05aa4d23c..84bc642bf1 100644
--- a/tsdb/engine/tsm1/engine.go
+++ b/tsdb/engine/tsm1/engine.go
@@ -2163,16 +2163,6 @@ const optimizationHoldoff = 5 * time.Minute
 // tickPeriod is the interval between successive compaction loops.
 const tickPeriod = time.Second
 
-// StartOptHoldOff will create a hold off timer for OptimizedCompaction
-func (e *Engine) StartOptHoldOff(holdOffDurationCheck time.Duration, optHoldoffStart time.Time, optHoldoffDuration time.Duration) {
-	startOptHoldoff := func(dur time.Duration) {
-		optHoldoffStart = time.Now()
-		optHoldoffDuration = dur
-		e.logger.Info("optimize compaction holdoff timer started", logger.Shard(e.id), zap.Duration("duration", optHoldoffDuration), zap.Time("endTime", optHoldoffStart.Add(optHoldoffDuration)))
-	}
-	startOptHoldoff(holdOffDurationCheck)
-}
-
 func (e *Engine) GetPlanTypeBasedOnHoldOff(start time.Time, dur time.Duration) PlanType {
 	planType := PT_SmartOptimize
 	if time.Since(start) < dur {
@@ -2186,7 +2176,12 @@ func (e *Engine) compact(wg *sync.WaitGroup) {
 	defer t.Stop()
 	var optHoldoffStart time.Time
 	var optHoldoffDuration time.Duration
-	e.StartOptHoldOff(initialOptimizationHoldoff, optHoldoffStart, optHoldoffDuration)
+	startOptHoldoff := func(dur time.Duration) {
+		optHoldoffStart = time.Now()
+		optHoldoffDuration = dur
+		e.logger.Info("optimize compaction holdoff timer started", logger.Shard(e.id), zap.Duration("duration", optHoldoffDuration), zap.Time("endTime", optHoldoffStart.Add(optHoldoffDuration)))
+	}
+	startOptHoldoff(initialOptimizationHoldoff)
 
 	var nextDisabledMsg time.Time
 
@@ -2253,7 +2248,7 @@ func (e *Engine) compact(wg *sync.WaitGroup) {
 					}
 					log := e.logger.With(zap.Strings("files", theGroup), zap.Bool("aggressive", isAggressive))
 
-					log.Info("Running optimized compaction for level 5 group")
+					log.Debug("Checking optimized level 5 group is compactable")
 					if err := e.compactOptimize(theGroup, pointsPerBlock, wg); err != nil {
 						if errors.Is(err, ErrOptimizeCompactionLimited) {
 							// We've reached the limit of optimized compactions. Let's not schedule anything else this schedule cycle
@@ -2267,9 +2262,10 @@ func (e *Engine) compact(wg *sync.WaitGroup) {
 							log.Error("Error during compactOptimize", zap.Error(err))
 						}
 					} else {
+						log.Info("Optimized level 5 group compacted")
 						level5Groups = level5Groups[1:]
 					}
-					e.StartOptHoldOff(optimizationHoldoff, optHoldoffStart, optHoldoffDuration)
+					startOptHoldoff(optimizationHoldoff)
 				}
 			}