Add a configuration for an index cache ttl

SungJin1212 · SungJin1212 · commit 3b0fb0c11e0e · 2024-09-26T13:49:46.000+09:00
Signed-off-by: SungJin1212 &lt;tjdwls1201@gmail.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 * [CHANGE] Enable Compactor and Alertmanager in target all. #6204
 * [FEATURE] Ruler: Experimental: Add `ruler.frontend-address` to allow query to query frontends instead of ingesters. #6151
 * [FEATURE] Ruler: Minimize chances of missed rule group evaluations that can occur due to OOM kills, bad underlying nodes, or due to an unhealthy ruler that appears in the ring as healthy. This feature is enabled via `-ruler.enable-ha-evaluation` flag. #6129
+* [ENHANCEMENT] Index Cache: Add a configuration for an index cache ttl. #6234
 * [ENHANCEMENT] Ingester: Add `blocks-storage.tsdb.wal-compression-type` to support zstd wal compression type. #6232
 * [ENHANCEMENT] Query Frontend: Add info field to query response. #6207
 * [ENHANCEMENT] Query Frontend: Add peakSample in query stats response. #6188
diff --git a/docs/blocks-storage/querier.md b/docs/blocks-storage/querier.md
@@ -642,6 +642,10 @@ blocks_storage:
         # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.enabled-items
         [enabled_items: <list of string> | default = []]
 
+        # How long to cache an index for a block.
+        # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.index-ttl
+        [index_ttl: <duration> | default = 24h]
+
       redis:
         # Comma separated list of redis addresses. Supported prefixes are: dns+
         # (looked up as an A/AAAA query), dnssrv+ (looked up as a SRV query,
@@ -772,6 +776,10 @@ blocks_storage:
         # CLI flag: -blocks-storage.bucket-store.index-cache.redis.enabled-items
         [enabled_items: <list of string> | default = []]
 
+        # How long to cache an index for a block.
+        # CLI flag: -blocks-storage.bucket-store.index-cache.redis.index-ttl
+        [index_ttl: <duration> | default = 24h]
+
       multilevel:
         # The maximum number of concurrent asynchronous operations can occur
         # when backfilling cache items.
diff --git a/docs/blocks-storage/store-gateway.md b/docs/blocks-storage/store-gateway.md
@@ -757,6 +757,10 @@ blocks_storage:
         # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.enabled-items
         [enabled_items: <list of string> | default = []]
 
+        # How long to cache an index for a block.
+        # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.index-ttl
+        [index_ttl: <duration> | default = 24h]
+
       redis:
         # Comma separated list of redis addresses. Supported prefixes are: dns+
         # (looked up as an A/AAAA query), dnssrv+ (looked up as a SRV query,
@@ -887,6 +891,10 @@ blocks_storage:
         # CLI flag: -blocks-storage.bucket-store.index-cache.redis.enabled-items
         [enabled_items: <list of string> | default = []]
 
+        # How long to cache an index for a block.
+        # CLI flag: -blocks-storage.bucket-store.index-cache.redis.index-ttl
+        [index_ttl: <duration> | default = 24h]
+
       multilevel:
         # The maximum number of concurrent asynchronous operations can occur
         # when backfilling cache items.
diff --git a/docs/configuration/config-file-reference.md b/docs/configuration/config-file-reference.md
@@ -1194,6 +1194,10 @@ bucket_store:
       # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.enabled-items
       [enabled_items: <list of string> | default = []]
 
+      # How long to cache an index for a block.
+      # CLI flag: -blocks-storage.bucket-store.index-cache.memcached.index-ttl
+      [index_ttl: <duration> | default = 24h]
+
     redis:
       # Comma separated list of redis addresses. Supported prefixes are: dns+
       # (looked up as an A/AAAA query), dnssrv+ (looked up as a SRV query,
@@ -1323,6 +1327,10 @@ bucket_store:
       # CLI flag: -blocks-storage.bucket-store.index-cache.redis.enabled-items
       [enabled_items: <list of string> | default = []]
 
+      # How long to cache an index for a block.
+      # CLI flag: -blocks-storage.bucket-store.index-cache.redis.index-ttl
+      [index_ttl: <duration> | default = 24h]
+
     multilevel:
       # The maximum number of concurrent asynchronous operations can occur when
       # backfilling cache items.
diff --git a/pkg/storage/tsdb/index_cache.go b/pkg/storage/tsdb/index_cache.go
@@ -157,6 +157,7 @@ func (cfg *InMemoryIndexCacheConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, pr
 type MemcachedIndexCacheConfig struct {
 	ClientConfig MemcachedClientConfig `yaml:",inline"`
 	EnabledItems []string              `yaml:"enabled_items"`
+	IndexTTL     time.Duration         `yaml:"index_ttl"`
 }
 
 func (cfg *MemcachedIndexCacheConfig) Validate() error {
@@ -169,16 +170,19 @@ func (cfg *MemcachedIndexCacheConfig) Validate() error {
 func (cfg *MemcachedIndexCacheConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string) {
 	cfg.ClientConfig.RegisterFlagsWithPrefix(f, prefix)
 	f.Var((*flagext.StringSlice)(&cfg.EnabledItems), prefix+"enabled-items", "Selectively cache index item types. Supported values are Postings, ExpandedPostings and Series")
+	f.DurationVar(&cfg.IndexTTL, prefix+"index-ttl", defaultTTL, "How long to cache an index for a block.")
 }
 
 type RedisIndexCacheConfig struct {
 	ClientConfig RedisClientConfig `yaml:",inline"`
 	EnabledItems []string          `yaml:"enabled_items"`
+	IndexTTL     time.Duration     `yaml:"index_ttl"`
 }
 
 func (cfg *RedisIndexCacheConfig) RegisterFlagsWithPrefix(f *flag.FlagSet, prefix string) {
 	cfg.ClientConfig.RegisterFlagsWithPrefix(f, prefix)
 	f.Var((*flagext.StringSlice)(&cfg.EnabledItems), prefix+"enabled-items", "Selectively cache index item types. Supported values are Postings, ExpandedPostings and Series")
+	f.DurationVar(&cfg.IndexTTL, prefix+"index-ttl", defaultTTL, "How long to cache an index for a block.")
 }
 
 func (cfg *RedisIndexCacheConfig) Validate() error {
@@ -217,8 +221,7 @@ func NewIndexCache(cfg IndexCacheConfig, logger log.Logger, registerer prometheu
 			if err != nil {
 				return nil, err
 			}
-			// TODO(yeya24): expose TTL
-			cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, defaultTTL)
+			cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, cfg.Memcached.IndexTTL)
 			if err != nil {
 				return nil, err
 			}
@@ -229,8 +232,7 @@ func NewIndexCache(cfg IndexCacheConfig, logger log.Logger, registerer prometheu
 			if err != nil {
 				return nil, err
 			}
-			// TODO(yeya24): expose TTL
-			cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, defaultTTL)
+			cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, cfg.Redis.IndexTTL)
 			if err != nil {
 				return nil, err
 			}

Original file line number	Diff line number	Diff line change
`@@ -157,6 +157,7 @@ func (cfg InMemoryIndexCacheConfig) RegisterFlagsWithPrefix(f flag.FlagSet, pr`
`157`	`157`	`type MemcachedIndexCacheConfig struct {`
`158`	`158`	ClientConfig MemcachedClientConfig `yaml:",inline"`
`159`	`159`	EnabledItems []string `yaml:"enabled_items"`
	`160`	+ IndexTTL time.Duration `yaml:"index_ttl"`
`160`	`161`	`}`
`161`	`162`
`162`	`163`	`func (cfg *MemcachedIndexCacheConfig) Validate() error {`
`@@ -169,16 +170,19 @@ func (cfg *MemcachedIndexCacheConfig) Validate() error {`
`169`	`170`	`func (cfg MemcachedIndexCacheConfig) RegisterFlagsWithPrefix(f flag.FlagSet, prefix string) {`
`170`	`171`	`cfg.ClientConfig.RegisterFlagsWithPrefix(f, prefix)`
`171`	`172`	`f.Var((*flagext.StringSlice)(&cfg.EnabledItems), prefix+"enabled-items", "Selectively cache index item types. Supported values are Postings, ExpandedPostings and Series")`
	`173`	`+ f.DurationVar(&cfg.IndexTTL, prefix+"index-ttl", defaultTTL, "How long to cache an index for a block.")`
`172`	`174`	`}`
`173`	`175`
`174`	`176`	`type RedisIndexCacheConfig struct {`
`175`	`177`	ClientConfig RedisClientConfig `yaml:",inline"`
`176`	`178`	EnabledItems []string `yaml:"enabled_items"`
	`179`	+ IndexTTL time.Duration `yaml:"index_ttl"`
`177`	`180`	`}`
`178`	`181`
`179`	`182`	`func (cfg RedisIndexCacheConfig) RegisterFlagsWithPrefix(f flag.FlagSet, prefix string) {`
`180`	`183`	`cfg.ClientConfig.RegisterFlagsWithPrefix(f, prefix)`
`181`	`184`	`f.Var((*flagext.StringSlice)(&cfg.EnabledItems), prefix+"enabled-items", "Selectively cache index item types. Supported values are Postings, ExpandedPostings and Series")`
	`185`	`+ f.DurationVar(&cfg.IndexTTL, prefix+"index-ttl", defaultTTL, "How long to cache an index for a block.")`
`182`	`186`	`}`
`183`	`187`
`184`	`188`	`func (cfg *RedisIndexCacheConfig) Validate() error {`
`@@ -217,8 +221,7 @@ func NewIndexCache(cfg IndexCacheConfig, logger log.Logger, registerer prometheu`
`217`	`221`	`if err != nil {`
`218`	`222`	`return nil, err`
`219`	`223`	`}`
`220`		`- // TODO(yeya24): expose TTL`
`221`		`- cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, defaultTTL)`
	`224`	`+ cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, cfg.Memcached.IndexTTL)`
`222`	`225`	`if err != nil {`
`223`	`226`	`return nil, err`
`224`	`227`	`}`
`@@ -229,8 +232,7 @@ func NewIndexCache(cfg IndexCacheConfig, logger log.Logger, registerer prometheu`
`229`	`232`	`if err != nil {`
`230`	`233`	`return nil, err`
`231`	`234`	`}`
`232`		`- // TODO(yeya24): expose TTL`
`233`		`- cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, defaultTTL)`
	`235`	`+ cache, err := storecache.NewRemoteIndexCache(logger, c, nil, iReg, cfg.Redis.IndexTTL)`
`234`	`236`	`if err != nil {`
`235`	`237`	`return nil, err`
`236`	`238`	`}`