Skip to content

docs(readme): a plain read that fails counts nothing, even when degraded (LAB-11422) #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
27b-merge-warden merged 1 commit into from
Nov 10, 2026
+4 −1
Merged

docs(readme): a plain read that fails counts nothing, even when degraded (LAB-11422) #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/cachekit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -996,7 +996,10 @@ createCache({ backend: { apiKey: process.env.CACHEKIT_API_KEY!, telemetry: false

Pass your own `metricsProvider` in the backend config to override the counters. Those counters, and the
Prometheus hit and miss counters, count one outcome per read: a plain `get()` or
`exists()` counts a hit by the layer that served it, or a miss. A `wrap()` call
`exists()` counts a hit by the layer that served it, or a miss. A plain read
that fails counts nothing, even when degradation returns `null` (`false` from
`exists()`) in its place: a backend failure, or an L2 entry that fails to
decrypt or decode. A `wrap()` call
also counts one outcome: an L1 or L2 hit by the layer that served its value
(a caller that joined another in-process call for the same key counts an L1
hit), or one miss when it runs the function. A call that fails before either,
Expand Down
Loading