refactor: consider migrating from hashicorp/golang-lru/v2/expirable to jellydator/ttlcache/v3
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- go
- 领域
- backend, performance, testing
调研方向
Start by reviewing the listed cache call sites, beginning with pkg/processtree/process_tree_manager.go and pkg/rulebindingmanager/cache/cache.go, then inspect the existing golang-lru usage and run the relevant tests. Compare golang-lru with ttlcache using the requested parallel, allocation, lifecycle, and end-to-end benchmarks. Done means the benchmark criteria are met, remaining call sites are migrated, imports are removed where applicable, and leak coverage is added for stoppable caches.
由索引模型根据 Issue 内容生成。
描述
Problem Statement
Several subsystems across node-agent currently use github.com/hashicorp/golang-lru/v2/expirable for in-memory TTL/LRU caching:
- Process Tree:
pkg/processtree/process_tree_manager.go(containerProcessTreeCache) - Rule Manager & CEL Libraries:
pkg/rulemanager/rule_manager.go(alertLogDedup)pkg/rulebindingmanager/cache/cache.go(rulesForPod)pkg/rulemanager/rulecooldown/rulecooldown.go(cooldownMap)pkg/rulemanager/ruleadapters/creator.go(hashCache)pkg/rulemanager/cel/libraries/cache/function_cache.go(CEL function cache)pkg/rulemanager/cel/libraries/containerprofile/prestop_cache.go(prestop_cache)
- SBOM Manager:
pkg/sbommanager/v1/sbom_manager.go(failureRetries,crashLoopRetries,busyRetries) - Host FIM Sensor:
pkg/hostfimsensor/v1/dedup_cache.go(dedupCache)
Limitations of golang-lru/v2/expirable:
- Uncloseable Background Goroutines: In
golang-lruv2.0.7,expirable.NewLRUspawns a background ticker goroutine (deleteExpired) that runs indefinitely because the package does not provide aClose()method (explicitly noted in upstream comments inexpirable_lru.goand upstream issue #159 / PR #161). While acceptable for node-agent startup singletons, any stoppable or dynamically created component leaks goroutines on shutdown. - Release Stagnation: The upstream repository is in low-touch maintenance; the last tagged release (
v2.0.7) was published in September 2023.
Proposed Solution
Evaluate and migrate from hashicorp/golang-lru/v2/expirable to github.com/jellydator/ttlcache/v3.
Why jellydator/ttlcache/v3?
- Explicit Lifecycle Control: Exposes
Start()andStop()methods for background expiration, or can run in purely passive/lazy eviction mode without spawning any background goroutines. - Modern Go Generics: Type-safe (
ttlcache.Cache[K, V]). - Flexible Eviction & Sizing: Supports capacity bounds with LRU / FIFO eviction policies.
- Active Maintenance: Widely adopted in the Go ecosystem as a standard replacement for
go-cacheand unmaintained expirable caches.
Benchmarking & Performance Requirements
Because several of these caches sit on critical, high-frequency event processing paths (e.g. ProcessTreeManager on every event, rulesForPod on every pod evaluation), the migration must satisfy the following benchmarking criteria:
- Hot-Path Concurrency & Latency (
Benchmark*):- Implement comparative Go microbenchmarks using
testing.B.RunParallelcomparinggolang-lru/v2vsjellydator/ttlcache/v3. - Test under representative access patterns:
- Read-heavy (90% read / 10% write) hit scenarios.
- Miss-heavy and high-churn insertion scenarios.
- Measure lock contention and ensure p95/p99 operation latencies do not regress.
- Implement comparative Go microbenchmarks using
- Memory Footprint & Allocation Overhead:
- Measure
B/opandallocs/opwithgo test -benchmem. - Profile heap allocations and verify that memory usage remains stable under sustained maximum entry capacity.
- Compare performance and memory overhead between active background sweeper mode vs passive (lazy on-access) eviction mode.
- Measure
- Goroutine Lifecycle & Leak Verification:
- Automated tests must verify that stopping or discarding caches leaves zero running background goroutines (e.g. using
go.uber.org/goleakorruntime.NumGoroutine()).
- Automated tests must verify that stopping or discarding caches leaves zero running background goroutines (e.g. using
- End-to-End System Benchmark:
- Validate against the existing node-agent performance benchmark suite (
make benchmark/ CI performance workflow) to ensure no regressions in overall node-agent CPU utilization and event throughput under load.
- Validate against the existing node-agent performance benchmark suite (
Implementation Plan
- Implement comparative microbenchmarks (
golang-lruvsttlcache/v3) covering read/write contention and memory allocations. - Prototype
ttlcache/v3in one subsystem (e.g.pkg/processtreeorpkg/rulebindingmanager). - Validate microbenchmark and CI benchmark results against the baseline.
- Migrate remaining
expirable.LRUcall sites across the codebase. - Remove
github.com/hashicorp/golang-lru/v2/expirableimports where applicable. - Add goroutine leak tests for all stoppable cache instances.
- 主要语言
- Go
- 星标
- 39
- 派生
- 42
- 平均合并
- 1 天 18 小时
- 30 天内合并 PR
- 40
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
kubescape/node-agent 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 72/100
kubescape/node-agent#1099 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
kubescape/node-agent#1093 ·
维护者通常 1 天内回复
-
Upgrade Inspektor Gadget to v0.57.0 via kubescape fork and preserve exec/path semantics可能已有人在做 @ANAMASGARD 于 18 天前认领。 未关闭enhancement
kubescape/node-agent#1050 · 2 条评论 · 已指派 1 人 ·
维护者通常 1 天内回复
-
Scan container images for misplaced secrets可能重新可做 @khuswant18 于 48 天前认领,目前没有进行中的 PR。 未关闭
kubescape/node-agent#987 · 已指派 1 人 ·
维护者通常 1 天内回复
-
难度 4/5 3-5 天 新手友好度 55/100
kubescape/node-agent#963 · 1 条评论 ·
维护者通常 1 天内回复
查看 kubescape/node-agent 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
-
evener-transcript-v2-upgrade tool still scans transcript files through bufio's 4 KiB default buffer未关闭
难度 1/5 1 小时以内 新手友好度 78/100
prime-radiant-inc/evener#6370 ·
维护者通常 1 天内回复
-
ManageSieve proxy: a backend's NO/BYE greeting is skipped as a capability line and reported as EOF未关闭bug
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
Mend: dependency security vulnerability
难度 2/5 1-3 小时 新手友好度 65/100
-
Mend: dependency security vulnerability
难度 2/5 1-3 小时 新手友好度 62/100
ManageIQ/manageiq-pods#1476 ·
维护者通常 1 天内回复