Enable events cache background eviction

common/dynamicconfig/constants.go

@@ -1484,6 +1484,11 @@ This can help reduce effects of shard movement.`,
 		false,
 		`EnableHostLevelEventsCache controls if the events cache is host level`,
 	)
+	EventsCacheBackgroundEvict = NewGlobalTypedSetting(
+		"history.eventsCacheBackgroundEvict",
+		DefaultHistoryCacheBackgroundEvictSettings,
+		`EventsCacheBackgroundEvict configures background processing to purge expired entries from the events cache.`,
+	)
 	AcquireShardInterval = NewGlobalDurationSetting(
 		"history.acquireShardInterval",
 		time.Minute,

service/history/configs/config.go

@@ -68,6 +68,7 @@ type Config struct {
 	// Change of these configs require shard restart
 	EventsShardLevelCacheMaxSizeBytes dynamicconfig.IntPropertyFn
 	EventsCacheTTL                    dynamicconfig.DurationPropertyFn
+	EventsCacheBackgroundEvict        dynamicconfig.TypedPropertyFn[dynamicconfig.CacheBackgroundEvictSettings]
 	// Change of these configs require service restart
 	EnableHostLevelEventsCache       dynamicconfig.BoolPropertyFn
 	EventsHostLevelCacheMaxSizeBytes dynamicconfig.IntPropertyFn
@@ -429,6 +430,7 @@ func NewConfig(
 		EventsHostLevelCacheMaxSizeBytes:  dynamicconfig.EventsHostLevelCacheMaxSizeBytes.Get(dc), // 256MB
 		EventsCacheTTL:                    dynamicconfig.EventsCacheTTL.Get(dc),
 		EnableHostLevelEventsCache:        dynamicconfig.EnableHostLevelEventsCache.Get(dc),
+		EventsCacheBackgroundEvict:        dynamicconfig.EventsCacheBackgroundEvict.Get(dc),
 
 		RangeSizeBits: 20, // 20 bits for sequencer, 2^20 sequence number for any range
 

service/history/events/cache.go

@@ -10,6 +10,7 @@ import (
 	"go.temporal.io/api/serviceerror"
 	"go.temporal.io/server/common"
 	"go.temporal.io/server/common/cache"
+	"go.temporal.io/server/common/dynamicconfig"
 	"go.temporal.io/server/common/log"
 	"go.temporal.io/server/common/log/tag"
 	"go.temporal.io/server/common/metrics"
@@ -60,7 +61,11 @@ func NewHostLevelEventsCache(
 	logger log.Logger,
 	disabled bool,
 ) Cache {
-	return newEventsCache(executionManager, handler, logger, config.EventsHostLevelCacheMaxSizeBytes(), config.EventsCacheTTL(), disabled)
+	return newEventsCache(executionManager, handler, logger,
+		config.EventsHostLevelCacheMaxSizeBytes(),
+		config.EventsCacheTTL(),
+		config.EventsCacheBackgroundEvict,
+		disabled)
 }
 
 func NewShardLevelEventsCache(
@@ -70,7 +75,11 @@ func NewShardLevelEventsCache(
 	logger log.Logger,
 	disabled bool,
 ) Cache {
-	return newEventsCache(executionManager, handler, logger, config.EventsShardLevelCacheMaxSizeBytes(), config.EventsCacheTTL(), disabled)
+	return newEventsCache(executionManager, handler, logger,
+		config.EventsShardLevelCacheMaxSizeBytes(),
+		config.EventsCacheTTL(),
+		config.EventsCacheBackgroundEvict,
+		disabled)
 }
 
 func newEventsCache(
@@ -79,9 +88,12 @@ func newEventsCache(
 	logger log.Logger,
 	maxSize int,
 	ttl time.Duration,
+	backgroundEvict func() dynamicconfig.CacheBackgroundEvictSettings,
 	disabled bool,
 ) *CacheImpl {
-	opts := &cache.Options{}
+	opts := &cache.Options{
+		BackgroundEvict: backgroundEvict,
+	}
 	opts.TTL = ttl
 
 	taggedMetricHandler := metricsHandler.WithTags(metrics.CacheTypeTag(metrics.EventsCacheTypeTagValue))

service/history/events/cache_test.go

@@ -11,6 +11,7 @@ import (
 	enumspb "go.temporal.io/api/enums/v1"
 	historypb "go.temporal.io/api/history/v1"
 	"go.temporal.io/server/common"
+	"go.temporal.io/server/common/dynamicconfig"
 	"go.temporal.io/server/common/log"
 	"go.temporal.io/server/common/metrics"
 	"go.temporal.io/server/common/namespace"
@@ -66,6 +67,9 @@ func (s *eventsCacheSuite) newTestEventsCache() *CacheImpl {
 		s.logger,
 		32,
 		time.Minute,
+		func() dynamicconfig.CacheBackgroundEvictSettings {
+			return dynamicconfig.DefaultHistoryCacheBackgroundEvictSettings
+		},
 		false)
 }