[fix] Allow es-index-cleaner to delete indices based on current time (jaegertracing#6790)

## Which problem is this PR solving?
- Resolves jaegertracing#6236 
## Description of the changes
- Changes the es-index-cleaner to remove indices older than 24 hours
from the time it runs, so deletions happen hourly instead of just at
midnight.
## How was this change tested?
- CI

## Checklist
- [x] I have read
https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md
- [x] I have signed all commits
- [x] I have added unit tests for the new functionality
- [x] I have run lint and test steps successfully
  - for `jaeger`: `make lint test`
  - for `jaeger-ui`: `npm run lint` and `npm run test`

---------

Signed-off-by: SatyamAgrawal <[email protected]>
Signed-off-by: Yuri Shkuro <[email protected]>
Signed-off-by: Yuri Shkuro <[email protected]>
Co-authored-by: Yuri Shkuro <[email protected]>
Co-authored-by: Yuri Shkuro <[email protected]>

Author: 2 people

cmd/es-index-cleaner/app/cutoff_time.go

@@ -0,0 +1,18 @@
+// Copyright (c) 2025 The Jaeger Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package app
+
+import (
+	"time"
+)
+
+func CalculateDeletionCutoff(currTime time.Time, numOfDays int, relativeIndexEnabled bool) time.Time {
+	year, month, day := currTime.Date()
+	// tomorrow midnight
+	cutoffTime := time.Date(year, month, day, 0, 0, 0, 0, time.UTC).AddDate(0, 0, 1)
+	if relativeIndexEnabled {
+		cutoffTime = currTime
+	}
+	return cutoffTime.Add(-time.Hour * 24 * time.Duration(numOfDays))
+}

cmd/es-index-cleaner/app/cutoff_time_test.go

@@ -0,0 +1,72 @@
+// Copyright (c) 2025 The Jaeger Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package app
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCalculateDeletionCutoff(t *testing.T) {
+	time20250309163053 := time.Date(2025, time.March, 9, 16, 30, 53, 0, time.UTC)
+	tests := []struct {
+		name                 string
+		currTime             time.Time
+		numOfDays            int
+		relativeIndexEnabled bool
+		expectedCutoff       time.Time
+	}{
+		{
+			name:                 "get today's midnight",
+			currTime:             time20250309163053,
+			numOfDays:            1,
+			relativeIndexEnabled: false,
+			expectedCutoff:       time.Date(2025, time.March, 9, 0, 0, 0, 0, time.UTC),
+		},
+		{
+			name:                 "get exactly 24 hours before execution time",
+			currTime:             time20250309163053,
+			numOfDays:            1,
+			relativeIndexEnabled: true,
+			expectedCutoff:       time.Date(2025, time.March, 8, 16, 30, 53, 0, time.UTC),
+		},
+		{
+			name:                 "get the current time if numOfDays is 0 and relativeIndexEnabled is true",
+			currTime:             time20250309163053,
+			numOfDays:            0,
+			relativeIndexEnabled: true,
+			expectedCutoff:       time20250309163053,
+		},
+		{
+			name:                 "get tomorrow's midnight if numOfDays is 0  relativeIndexEnabled is False",
+			currTime:             time20250309163053,
+			numOfDays:            0,
+			relativeIndexEnabled: false,
+			expectedCutoff:       time.Date(2025, time.March, 10, 0, 0, 0, 0, time.UTC),
+		},
+		{
+			name:                 "get (numOfDays-1)'s midnight",
+			currTime:             time20250309163053,
+			numOfDays:            3,
+			relativeIndexEnabled: false,
+			expectedCutoff:       time.Date(2025, time.March, 7, 0, 0, 0, 0, time.UTC),
+		},
+		{
+			name:                 "get exactly (24*numOfDays) hours before execution time",
+			currTime:             time20250309163053,
+			numOfDays:            3,
+			relativeIndexEnabled: true,
+			expectedCutoff:       time.Date(2025, time.March, 6, 16, 30, 53, 0, time.UTC),
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			cutoffTime := CalculateDeletionCutoff(time20250309163053, test.numOfDays, test.relativeIndexEnabled)
+			assert.Equal(t, test.expectedCutoff, cutoffTime)
+		})
+	}
+}

cmd/es-index-cleaner/main.go

@@ -7,21 +7,39 @@ import (
 	"context"
 	"encoding/base64"
 	"errors"
+	"flag"
 	"fmt"
 	"log"
 	"net/http"
 	"strconv"
 	"time"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
+	"go.opentelemetry.io/collector/featuregate"
 	"go.uber.org/zap"
 
 	"github.com/jaegertracing/jaeger/cmd/es-index-cleaner/app"
 	"github.com/jaegertracing/jaeger/pkg/config"
 	"github.com/jaegertracing/jaeger/pkg/es/client"
 )
 
+var relativeIndexCleaner *featuregate.Gate
+
+func init() {
+	relativeIndexCleaner = featuregate.GlobalRegistry().MustRegister(
+		"es.index.relativeTimeIndexDeletion",
+		featuregate.StageAlpha,
+		featuregate.WithRegisterFromVersion("v2.5.0"),
+		featuregate.WithRegisterDescription("Controls whether the indices will be deleted relative to the current time or tomorrow midnight."),
+		featuregate.WithRegisterReferenceURL("https://github.com/jaegertracing/jaeger/issues/6236"),
+	)
+	featureGateFlagSet := flag.NewFlagSet("feature-gates", flag.ExitOnError)
+	featuregate.GlobalRegistry().RegisterFlags(featureGateFlagSet)
+	pflag.CommandLine.AddGoFlagSet(featureGateFlagSet)
+}
+
 func main() {
 	logger, _ := zap.NewProduction()
 	v := viper.New()
@@ -70,9 +88,7 @@ func main() {
 				return err
 			}
 
-			year, month, day := time.Now().UTC().Date()
-			tomorrowMidnight := time.Date(year, month, day, 0, 0, 0, 0, time.UTC).AddDate(0, 0, 1)
-			deleteIndicesBefore := tomorrowMidnight.Add(-time.Hour * 24 * time.Duration(numOfDays))
+			deleteIndicesBefore := app.CalculateDeletionCutoff(time.Now().UTC(), numOfDays, relativeIndexCleaner.IsEnabled())
 			logger.Info("Indices before this date will be deleted", zap.String("date", deleteIndicesBefore.Format(time.RFC3339)))
 
 			filter := &app.IndexFilter{
@@ -100,6 +116,7 @@ func main() {
 		cfg.AddFlags,
 	)
 
+	command.Flags().AddFlagSet(pflag.CommandLine)
 	if err := command.Execute(); err != nil {
 		log.Fatalln(err)
 	}