-
Notifications
You must be signed in to change notification settings - Fork 266
/
caching.go
292 lines (250 loc) · 9.39 KB
/
caching.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
package caching
import (
"context"
"fmt"
"unsafe"
"github.com/dgraph-io/ristretto"
"github.com/dustin/go-humanize"
"github.com/prometheus/client_golang/prometheus"
"github.com/rs/zerolog/log"
"google.golang.org/protobuf/proto"
"github.com/authzed/spicedb/internal/dispatch"
"github.com/authzed/spicedb/internal/dispatch/keys"
"github.com/authzed/spicedb/internal/namespace"
v1 "github.com/authzed/spicedb/pkg/proto/dispatch/v1"
)
const (
errCachingInitialization = "error initializing caching dispatcher: %w"
prometheusNamespace = "spicedb"
)
// Dispatcher is a dispatcher with built-in caching.
type Dispatcher struct {
d dispatch.Dispatcher
c *ristretto.Cache
nsm namespace.Manager
keyHandler keys.Handler
checkTotalCounter prometheus.Counter
checkFromCacheCounter prometheus.Counter
lookupTotalCounter prometheus.Counter
lookupFromCacheCounter prometheus.Counter
cacheHits prometheus.CounterFunc
cacheMisses prometheus.CounterFunc
costAddedBytes prometheus.CounterFunc
costEvictedBytes prometheus.CounterFunc
}
type checkResultEntry struct {
response *v1.DispatchCheckResponse
}
type lookupResultEntry struct {
response *v1.DispatchLookupResponse
}
var (
checkResultEntryCost = int64(unsafe.Sizeof(checkResultEntry{}))
lookupResultEntryEmptyCost = int64(unsafe.Sizeof(lookupResultEntry{}))
)
// NewCachingDispatcher creates a new dispatch.Dispatcher which delegates dispatch requests
// and caches the responses when possible and desirable.
func NewCachingDispatcher(
cacheConfig *ristretto.Config,
nsm namespace.Manager,
prometheusSubsystem string,
keyHandler keys.Handler,
) (*Dispatcher, error) {
if cacheConfig == nil {
cacheConfig = &ristretto.Config{
NumCounters: 1e4, // number of keys to track frequency of (10k).
MaxCost: 1 << 24, // maximum cost of cache (16MB).
BufferItems: 64, // number of keys per Get buffer.
Metrics: true, // collect metrics.
}
} else {
log.Info().Int64("numCounters", cacheConfig.NumCounters).Str("maxCost", humanize.Bytes(uint64(cacheConfig.MaxCost))).Msg("configured caching dispatcher")
}
cache, err := ristretto.NewCache(cacheConfig)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
checkTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "check_total",
})
checkFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "check_from_cache_total",
})
lookupTotalCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_total",
})
lookupFromCacheCounter := prometheus.NewCounter(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "lookup_from_cache_total",
})
cacheHitsTotal := prometheus.NewCounterFunc(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "cache_hits_total",
}, func() float64 {
return float64(cache.Metrics.Hits())
})
cacheMissesTotal := prometheus.NewCounterFunc(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "cache_misses_total",
}, func() float64 {
return float64(cache.Metrics.Misses())
})
costAddedBytes := prometheus.NewCounterFunc(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "cost_added_bytes",
}, func() float64 {
return float64(cache.Metrics.CostAdded())
})
costEvictedBytes := prometheus.NewCounterFunc(prometheus.CounterOpts{
Namespace: prometheusNamespace,
Subsystem: prometheusSubsystem,
Name: "cost_evicted_bytes",
}, func() float64 {
return float64(cache.Metrics.CostEvicted())
})
if prometheusSubsystem != "" {
err = prometheus.Register(checkTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(checkFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupTotalCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(lookupFromCacheCounter)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
// Export some ristretto metrics
err = prometheus.Register(cacheHitsTotal)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(cacheMissesTotal)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(costAddedBytes)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
err = prometheus.Register(costEvictedBytes)
if err != nil {
return nil, fmt.Errorf(errCachingInitialization, err)
}
}
if keyHandler == nil {
keyHandler = &keys.DirectKeyHandler{}
}
return &Dispatcher{
d: fakeDelegate{},
nsm: nsm,
c: cache,
keyHandler: keyHandler,
checkTotalCounter: checkTotalCounter,
checkFromCacheCounter: checkFromCacheCounter,
lookupTotalCounter: lookupTotalCounter,
lookupFromCacheCounter: lookupFromCacheCounter,
cacheHits: cacheHitsTotal,
cacheMisses: cacheMissesTotal,
costAddedBytes: costAddedBytes,
costEvictedBytes: costEvictedBytes,
}, nil
}
// SetDelegate sets the internal delegate to the specific dispatcher instance.
func (cd *Dispatcher) SetDelegate(delegate dispatch.Dispatcher) {
cd.d = delegate
}
// DispatchCheck implements dispatch.Check interface
func (cd *Dispatcher) DispatchCheck(ctx context.Context, req *v1.DispatchCheckRequest) (*v1.DispatchCheckResponse, error) {
cd.checkTotalCounter.Inc()
requestKey, err := cd.keyHandler.ComputeCheckKey(ctx, req, cd.nsm)
if err != nil {
return &v1.DispatchCheckResponse{Metadata: &v1.ResponseMeta{}}, err
}
if cachedResultRaw, found := cd.c.Get(requestKey); found {
cachedResult := cachedResultRaw.(checkResultEntry)
if req.Metadata.DepthRemaining >= cachedResult.response.Metadata.DepthRequired {
cd.checkFromCacheCounter.Inc()
return cachedResult.response, nil
}
}
computed, err := cd.d.DispatchCheck(ctx, req)
// We only want to cache the result if there was no error
if err == nil {
adjustedComputed := proto.Clone(computed).(*v1.DispatchCheckResponse)
adjustedComputed.Metadata.CachedDispatchCount = adjustedComputed.Metadata.DispatchCount
adjustedComputed.Metadata.DispatchCount = 0
toCache := checkResultEntry{adjustedComputed}
cd.c.Set(requestKey, toCache, checkResultEntryCost)
}
// Return both the computed and err in ALL cases: computed contains resolved metadata even
// if there was an error.
return computed, err
}
// DispatchExpand implements dispatch.Expand interface and does not do any caching yet.
func (cd *Dispatcher) DispatchExpand(ctx context.Context, req *v1.DispatchExpandRequest) (*v1.DispatchExpandResponse, error) {
resp, err := cd.d.DispatchExpand(ctx, req)
return resp, err
}
// DispatchLookup implements dispatch.Lookup interface and does not do any caching yet.
func (cd *Dispatcher) DispatchLookup(ctx context.Context, req *v1.DispatchLookupRequest) (*v1.DispatchLookupResponse, error) {
cd.lookupTotalCounter.Inc()
requestKey := dispatch.LookupRequestToKey(req)
if cachedResultRaw, found := cd.c.Get(requestKey); found {
cachedResult := cachedResultRaw.(lookupResultEntry)
if req.Metadata.DepthRemaining >= cachedResult.response.Metadata.DepthRequired {
log.Trace().Object("cachedLookup", req).Int("resultCount", len(cachedResult.response.ResolvedOnrs)).Send()
cd.lookupFromCacheCounter.Inc()
return cachedResult.response, nil
}
}
computed, err := cd.d.DispatchLookup(ctx, req)
// We only want to cache the result if there was no error and nothing was excluded.
if err == nil && len(computed.Metadata.LookupExcludedDirect) == 0 && len(computed.Metadata.LookupExcludedTtu) == 0 {
log.Trace().Object("cachingLookup", req).Int("resultCount", len(computed.ResolvedOnrs)).Send()
adjustedComputed := proto.Clone(computed).(*v1.DispatchLookupResponse)
adjustedComputed.Metadata.CachedDispatchCount = adjustedComputed.Metadata.DispatchCount
adjustedComputed.Metadata.DispatchCount = 0
adjustedComputed.Metadata.LookupExcludedDirect = nil
adjustedComputed.Metadata.LookupExcludedTtu = nil
requestKey := dispatch.LookupRequestToKey(req)
toCache := lookupResultEntry{adjustedComputed}
estimatedSize := lookupResultEntryEmptyCost
for _, onr := range toCache.response.ResolvedOnrs {
estimatedSize += int64(len(onr.Namespace) + len(onr.ObjectId) + len(onr.Relation))
}
cd.c.Set(requestKey, toCache, estimatedSize)
}
// Return both the computed and err in ALL cases: computed contains resolved metadata even
// if there was an error.
return computed, err
}
func (cd *Dispatcher) Close() error {
prometheus.Unregister(cd.checkTotalCounter)
prometheus.Unregister(cd.lookupTotalCounter)
prometheus.Unregister(cd.lookupFromCacheCounter)
prometheus.Unregister(cd.checkFromCacheCounter)
prometheus.Unregister(cd.cacheHits)
prometheus.Unregister(cd.cacheMisses)
prometheus.Unregister(cd.costAddedBytes)
prometheus.Unregister(cd.costEvictedBytes)
if cache := cd.c; cache != nil {
cache.Close()
}
return nil
}