Repository navigation
docs(caching): the pingora cache engine is Enterprise-only and falls back silently - #2188
Merged
Merged
Conversation
…back silently The `engine` row and its "Choosing an engine" section offered `pingora` as a plain value on docs.spiceai.org. `pingora` is a Cargo feature that is not in the `spiced` default feature set, so no published open source binary or image contains the backend, and `engine: pingora` there warns and runs on Moka instead of failing. Adds the standard Enterprise callout, quotes the real fallback warning and the startup line that names the engine actually in use, and records that pingora has no TinyLFU implementation.
Contributor
✅ Pull with Spice PassedPassing checks:
|
Contributor
🔍 Pull with Spice FailedPassing checks:
Failed checks:
Please address these issues and update your pull request. |
Contributor
|
🚀 deployed to https://91b82220.spiceai-org-website.pages.dev |
lukekim
approved these changes
Sep 10, 2026
4 tasks done
lukekim
pushed a commit
that referenced
this pull request
Sep 12, 2026
The version-2.3.x snapshot was cut hours before #2188, so the newest release's caching page still presents `engine: pingora` as an ordinary open source backend. On a stock spiced the value parses, the runtime warns and runs Moka instead.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
#2186 added a
caching.*.enginerow and a "Choosing anengine" section to the OSS caching page, offeringpingoraas a plain selectable value alongsidemoka. Two things about it are missing:1. It is not in the open source distribution.
pingorais a Cargo feature, and it is absent fromspiced'sdefaultfeature list. Released images build--features release,modelson top ofdefault(release = []), so no published open source binary or image contains the Pingora backend at all — the whole module is behind#[cfg(feature = "pingora")]. Per the docs convention for capabilities gated out of the default build, this needs the Enterprise callout.2. Selecting it on such a build is a silent downgrade, not an error.
CacheEnginelives inspicepodand is not feature-gated, soengine: pingoraparses everywhere. The dispatch then does:A user who reads the page, sets
engine: pingora, and sees the runtime start normally is on Moka.MokaFallbackalso reportsengine()asCacheEngine::Moka, so the startup line is the honest signal, which is why the note points at it rather than at the configured value.3.
pingorahas no TinyLFU implementation. The same page documentseviction_policy: tiny_lfu; combined withengine: pingorait warns and uses LRU.What changed
website/docs/features/caching/index.mdonly:enginerow now sayspingorarequires an Enterprise build.pingorabullet records thateviction_policy: tiny_lfuis not implemented there, quoting the warning.:::note[Enterprise edition]callout with the verbatim fallback warning and theInitialized … cache; … engine: Mokastartup line to check.Both quoted strings are static format templates with no substituted fields, so they are greppable in a log exactly as written. The startup line does interpolate the configured size and TTL, which the text says explicitly.
Source refs (spiceai/spiceai @
2f10331)crates/cache/src/lru_cache.rs#L53—PINGORA_ENTERPRISE_ONLY_MESSAGEcrates/cache/src/lru_cache.rs#L352-L382— the engine dispatch, the TinyLFU warning, and thenot(feature = "pingora")fallback armbin/spiced/Cargo.toml—pingora = ["runtime/pingora"]is declared but not listed indefaultcrates/runtime/src/init/caching.rs#L54—Initialized sql results cache; {cache_provider}, whoseDisplayends inengine: {}Scope
vNext only — the
engineparameter is not documented in any versioned snapshot, so there is nothing to sweep.reference/distributions.mdwas left alone: its feature-gated section is scoped to data connectors, and widening it to cache engines is a structural change rather than an accuracy fix.Test plan
cd website && npm run buildpassesgrep -rn "pingora" website/docs website/versioned_docs— the only non-acknowledgementshits are on this page