feat: cache_check_count added

Permify · Jan 31, 2024 · 0e5deef · 0e5deef
1 parent da7d486
commit 0e5deef
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 29 deletions.
diff --git a/internal/engines/cache/cache.go b/internal/engines/cache/cache.go
@@ -4,6 +4,8 @@ import (
 	"context"
 	"encoding/hex"
 
+	api "go.opentelemetry.io/otel/metric"
+
 	"github.com/cespare/xxhash/v2"
 
 	"github.com/Permify/permify/internal/engines"
@@ -19,15 +21,30 @@ type CheckEngineWithCache struct {
 	schemaReader storage.SchemaReader
 	checker      invoke.Check
 	cache        cache.Cache
+
+	// Metrics
+	cacheCounter api.Int64Counter
 }
 
 // NewCheckEngineWithCache creates a new instance of EngineKeyManager by initializing an EngineKeys
 // struct with the provided cache.Cache instance.
-func NewCheckEngineWithCache(checker invoke.Check, schemaReader storage.SchemaReader, cache cache.Cache) invoke.Check {
+func NewCheckEngineWithCache(
+	checker invoke.Check,
+	schemaReader storage.SchemaReader,
+	cache cache.Cache,
+	meter api.Meter,
+) invoke.Check {
+	// Cache Counter
+	cacheCounter, err := meter.Int64Counter("cache_check_count", api.WithDescription("Number of permission cached checks performed"))
+	if err != nil {
+		panic(err)
+	}
+
 	return &CheckEngineWithCache{
 		schemaReader: schemaReader,
 		checker:      checker,
 		cache:        cache,
+		cacheCounter: cacheCounter,
 	}
 }
 
@@ -52,6 +69,8 @@ func (c *CheckEngineWithCache) Check(ctx context.Context, request *base.Permissi
 
 	// If a cached result is found, handle exclusion and return the result.
 	if found {
+		// Increase the check count in the metrics.
+		c.cacheCounter.Add(ctx, 1)
 		// If the request doesn't have the exclusion flag set, return the cached result.
 		return &base.PermissionCheckResponse{
 			Can:      res.GetCan(),
@@ -60,8 +79,7 @@ func (c *CheckEngineWithCache) Check(ctx context.Context, request *base.Permissi
 	}
 
 	// Perform the actual permission check using the provided request.
-	res, err = c.checker.Check(ctx, request)
-
+	cres, err := c.checker.Check(ctx, request)
 	// Check if there's an error or the response is nil, and return the result.
 	if err != nil {
 		return &base.PermissionCheckResponse{
@@ -73,12 +91,12 @@ func (c *CheckEngineWithCache) Check(ctx context.Context, request *base.Permissi
 	}
 
 	c.setCheckKey(request, &base.PermissionCheckResponse{
-		Can:      res.GetCan(),
+		Can:      cres.GetCan(),
 		Metadata: &base.PermissionCheckResponseMetadata{},
 	}, isRelational)
 
 	// Return the result of the permission check.
-	return res, err
+	return cres, err
 }
 
 // GetCheckKey retrieves the value for the given key from the EngineKeys cache.

diff --git a/internal/engines/cache/cache_test.go b/internal/engines/cache/cache_test.go
@@ -43,7 +43,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			// Initialize a new EngineKeys struct with a new cache.Cache instance
-			engineKeys := CheckEngineWithCache{nil, nil, cache}
+			engineKeys := CheckEngineWithCache{nil, nil, cache, nil}
 
 			// Create a new PermissionCheckRequest and PermissionCheckResponse
 			checkReq := &base.PermissionCheckRequest{
@@ -93,7 +93,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			// Initialize a new EngineKeys struct with a new cache.Cache instance
-			engineKeys := CheckEngineWithCache{nil, nil, cache}
+			engineKeys := CheckEngineWithCache{nil, nil, cache, nil}
 
 			// Create a new PermissionCheckRequest and PermissionCheckResponse
 			checkReq := &base.PermissionCheckRequest{
@@ -143,7 +143,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			// Initialize a new EngineKeys struct with a new cache.Cache instance
-			engineKeys := CheckEngineWithCache{nil, nil, cache}
+			engineKeys := CheckEngineWithCache{nil, nil, cache, nil}
 
 			// Create a new PermissionCheckRequest and PermissionCheckResponse
 			checkReq := &base.PermissionCheckRequest{
@@ -287,7 +287,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			// Initialize a new EngineKeys struct with a new cache.Cache instance
-			engineKeys := CheckEngineWithCache{nil, nil, cache}
+			engineKeys := CheckEngineWithCache{nil, nil, cache, nil}
 
 			// Create a new PermissionCheckRequest
 			checkReq := &base.PermissionCheckRequest{
@@ -322,7 +322,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			// Initialize a new EngineKeys struct with a new cache.Cache instance
-			engineKeys := CheckEngineWithCache{nil, nil, cache}
+			engineKeys := CheckEngineWithCache{nil, nil, cache, nil}
 
 			// Create some new PermissionCheckRequests and PermissionCheckResponses
 			checkReq1 := &base.PermissionCheckRequest{
@@ -513,7 +513,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -623,7 +623,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -735,7 +735,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -867,7 +867,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -991,7 +991,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1108,7 +1108,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1263,7 +1263,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1389,7 +1389,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1526,7 +1526,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1654,7 +1654,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1772,7 +1772,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -1890,7 +1890,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -2054,7 +2054,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -2206,7 +2206,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -2361,7 +2361,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -2500,7 +2500,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,
@@ -2651,7 +2651,7 @@ var _ = Describe("cache", func() {
 			Expect(err).ShouldNot(HaveOccurred())
 
 			checkEngine := engines.NewCheckEngine(schemaReader, dataReader)
-			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checkEngineWithCache := NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache, telemetry.NewNoopMeter())
 
 			invoker := invoke.NewDirectInvoker(
 				schemaReader,

diff --git a/pkg/cmd/serve.go b/pkg/cmd/serve.go
@@ -295,9 +295,19 @@ func serve() func(cmd *cobra.Command, args []string) error {
 			if err != nil {
 				return err
 			}
-			checker = cache.NewCheckEngineWithCache(checker, schemaReader, engineKeyCache)
+			checker = cache.NewCheckEngineWithCache(
+				checker,
+				schemaReader,
+				engineKeyCache,
+				meter,
+			)
 		} else {
-			checker = cache.NewCheckEngineWithCache(checkEngine, schemaReader, engineKeyCache)
+			checker = cache.NewCheckEngineWithCache(
+				checkEngine,
+				schemaReader,
+				engineKeyCache,
+				meter,
+			)
 		}
 
 		// Create a localChecker which directly checks without considering distributed setup.
@@ -306,6 +316,7 @@ func serve() func(cmd *cobra.Command, args []string) error {
 			checkEngine,
 			schemaReader,
 			engineKeyCache,
+			meter,
 		)
 
 		// Initialize the lookupEngine, which is responsible for looking up certain entities or values.