Merge pull request #8 from FishGoddess/develop

给 Reporter 增加缓存分片数量方法

Author: FishGoddess

FUTURE.md

@@ -15,7 +15,11 @@
 * [x] 增加 report 机制用于监控缓存的情况
 * [x] 提取 now 和 hash 到缓存级别配置
 * [x] 提供定时缓存时间的机制，可选快速时钟
-* [ ] 增加对不存在的数据做防穿透的机制
+* [x] 增加缓存名字配置，主要用于区分每个监控数据的来源
+* [x] 给 Reporter 增加缓存分片数量方法，主要用于监控缓存分片数量
+* [ ] 给 Reporter 增加缓存类型方法，主要用于监控不同类型的缓存情况
+* [ ] ~~增加对不存在的数据做防穿透的机制~~
+  经过实践，这个更适合业务方自己处理，所以这边就先去掉了
 * [ ] 提供一个清空并设置全量值的方法，方便定时数据的全量替换
 
 ### v0.3.x

HISTORY.md

@@ -1,5 +1,11 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.4.9
+
+> 此版本发布于 2023-05-09
+
+* 给 Reporter 增加缓存分片数量方法，主要用于监控缓存分片数量
+
 ### v0.4.8
 
 > 此版本发布于 2023-03-13

README.en.md

@@ -8,7 +8,7 @@
 **cachego** is an api friendly memory-based cache for [GoLang](https://golang.org) applications.
 
 > It has been used by many services in production, all services are running stable, and the highest qps in services is
-> 96w/s, so just use it if you want! 👏🏻
+> 96w/s by using v0.3.x, so just use it if you want! 👏🏻
 
 [阅读中文版的 Read me](./README.md).
 

README.md

@@ -7,7 +7,7 @@
 
 **cachego** 是一个拥有分片机制的轻量级内存缓存库，API 友好，支持多种数据淘汰机制，可以应用于所有的 [GoLang](https://golang.org) 应用程序中。
 
-> 目前 v0.3.x 版本已经在多个线上服务中运行稳定，服务日常请求过万 qps，瞬时最高抵御过 96w/s qps 的冲击，欢迎使用！👏🏻
+> 目前已经在多个线上服务中运行稳定，服务日常请求过万 qps，v0.3.x 版本最高抵御过 96w/s qps 的冲击，欢迎使用！👏🏻
 
 [Read me in English](./README.en.md).
 

entry_test.go

@@ -20,6 +20,10 @@ import (
 	"time"
 )
 
+const (
+	testDurationGap = 10 * time.Microsecond
+)
+
 // go test -v -cover -run=^TestNewEntry$
 func TestNewEntry(t *testing.T) {
 	e := newEntry("key", "value", 0, now)
@@ -60,7 +64,7 @@ func TestNewEntry(t *testing.T) {
 	}
 
 	// Keep one us for code running.
-	if expiration < e.expiration || e.expiration < expiration-time.Microsecond.Nanoseconds() {
+	if expiration < e.expiration || e.expiration < expiration-testDurationGap.Nanoseconds() {
 		t.Errorf("e.expiration %d != expiration %d", e.expiration, expiration)
 	}
 }
@@ -102,7 +106,7 @@ func TestEntrySetup(t *testing.T) {
 	}
 
 	// Keep one us for code running.
-	if expiration < e.expiration || e.expiration < expiration-time.Microsecond.Nanoseconds() {
+	if expiration < e.expiration || e.expiration < expiration-testDurationGap.Nanoseconds() {
 		t.Errorf("e.expiration %d != expiration %d", e.expiration, expiration)
 	}
 }

global_test.go

@@ -42,7 +42,7 @@ func TestNow(t *testing.T) {
 	got := now()
 	expect := time.Now().UnixNano()
 
-	if got > expect || got < expect-time.Microsecond.Nanoseconds() {
+	if got > expect || got < expect-testDurationGap.Nanoseconds() {
 		t.Errorf("got %d != expect %d", got, expect)
 	}
 }

report.go

@@ -52,6 +52,13 @@ func (r *Reporter) CacheName() string {
 	return r.conf.cacheName
 }
 
+// CacheShardings returns the shardings of cache.
+// You can use WithShardings to set cache's shardings.
+// Zero shardings means cache is non-sharding.
+func (r *Reporter) CacheShardings() int {
+	return r.conf.shardings
+}
+
 // CountMissed returns the missed count.
 func (r *Reporter) CountMissed() uint64 {
 	return atomic.LoadUint64(&r.missedCount)

report_test.go

@@ -21,13 +21,16 @@ import (
 )
 
 const (
-	testCacheName = "test"
+	testCacheName      = "test"
+	testCacheShardings = 16
 )
 
 func newTestReportableCache() (*reportableCache, *Reporter) {
 	conf := newDefaultConfig()
 	conf.cacheName = testCacheName
+	conf.shardings = testCacheShardings
 	conf.maxEntries = maxTestEntries
+
 	cache, reporter := report(conf, newStandardCache(conf))
 	return cache.(*reportableCache), reporter
 }
@@ -203,11 +206,27 @@ func TestReportableCacheReportLoad(t *testing.T) {
 // go test -v -cover -run=^TestReporterCacheName$
 func TestReporterCacheName(t *testing.T) {
 	_, reporter := newTestReportableCache()
+	if reporter.CacheName() != reporter.conf.cacheName {
+		t.Errorf("CacheName %s is wrong compared with conf", reporter.CacheName())
+	}
+
 	if reporter.CacheName() != testCacheName {
 		t.Errorf("CacheName %s is wrong", reporter.CacheName())
 	}
 }
 
+// go test -v -cover -run=^TestReporterCacheShardings$
+func TestReporterCacheShardings(t *testing.T) {
+	_, reporter := newTestReportableCache()
+	if reporter.CacheShardings() != reporter.conf.shardings {
+		t.Errorf("CacheShardings %d is wrong compared with conf", reporter.CacheShardings())
+	}
+
+	if reporter.CacheShardings() != testCacheShardings {
+		t.Errorf("CacheShardings %d is wrong", reporter.CacheShardings())
+	}
+}
+
 // go test -v -cover -run=^TestReporterCacheSize$
 func TestReporterCacheSize(t *testing.T) {
 	cache, reporter := newTestReportableCache()