docs(proxy): document env vars missing from the reference table - #767
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
5 tasks
Eight are read through a bare get_secret_bool call, which the CI gate that enforces this table does not recognise, so they have never been required to have a row. Each description is written from the call site rather than from the name. Two more, LITELLM_PRISMA_BOOTSTRAP_TIMEOUT and LITELLM_PRISMA_COMMAND_TIMEOUT, come from a separate change and are included here to avoid a second PR conflicting on the same table. Also scopes the NUM_WORKERS recommendation on DEFAULT_NUM_WORKERS_LITELLM_PROXY, which told every reader to match vCPU count regardless of how they deploy. That advice is right for a single host and wrong on Kubernetes, where the guidance is one worker per pod scaled with replicas.
yassin-berriai
force-pushed
the
litellm_env_key_reference_rows
branch
from
August 4, 2026 22:21
ea224f3 to
282bf08
Compare
yucheng-berri
approved these changes
Aug 4, 2026
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.
Adds reference rows for environment variables that LiteLLM reads at runtime but that have never appeared in the "environment variables - Reference" table on the proxy config settings page
Eight of them are read through a bare
get_secret_bool("...")call. The CI gate in the main repo that requires every user-facing environment variable to be documented,tests/documentation_tests/test_env_keys.py, only recognisesos.getenv(,litellm.get_secret(andlitellm.get_secret_str(, so aget_secret_boolread matches none of its patterns and the key silently skips the requirement. BerriAI/litellm#35833 widens that gate; this PR has to land first, otherwise the gate starts failingcode-qualityanddocumentationfor everyone the moment it mergesThe eight are
DISABLE_PRISMA_HEALTH_CHECK_ON_STARTUP,EXPERIMENTAL_OPENAI_BASE_LLM_HTTP_HANDLER,EXPERIMENTAL_UI_LOGIN,LITELLM_STORE_AUDIT_LOGS,STORE_PROMPTS_IN_SPEND_LOGS,USE_DDPROFILER,USE_DDTRACEandUSE_LITELLM_PROXY. Each description is written from the call site rather than restated from the name, so for example the row forDISABLE_PRISMA_HEALTH_CHECK_ON_STARTUPsays what actually gets skipped, which is theSELECT 1the proxy issues once Prisma has connected and migrations have run, and what that means in practice, which is that an unreachable database is discovered on the first request instead of at startup. It is distinct from thePRISMA_HEALTH_WATCHDOG_*settings already in the table, which govern the ongoing runtime probeTwo further rows,
LITELLM_PRISMA_BOOTSTRAP_TIMEOUTandLITELLM_PRISMA_COMMAND_TIMEOUT, belong to a separate change, BerriAI/litellm#35832, and are folded in here because they target the same table and a second PR against it would only conflict. They are unrelated to the gate: they live inlitellm-proxy-extras, whichtest_env_keys.pydoes not scan, so nothing goes red if they land lateOne row is a wording change rather than an addition, which is why an env-var docs PR touches prose.
DEFAULT_NUM_WORKERS_LITELLM_PROXYtold every reader to setNUM_WORKERSto the vCPU count, which is right on a single container, VM, or bare-metal host and wrong on Kubernetes, where the guidance is one worker per pod scaled with replicas. The row now scopes the recommendation to each case, notes that CPU, memory and the database connection pool are all per worker, and links the workers and scaling section of the production checklistRows are placed in alphabetical position within their existing block and follow the table's two-column layout. I confirmed each key is genuinely absent from the table before adding it, including under near-miss spellings;
EXPERIMENTAL_UI_LOGINis mentioned in the body text of theLITELLM_UI_SESSION_DURATIONrow today but has no row of its own, and the fixed 10 minute expiry that row refers to matches what the new row statesnpm ci && npm run buildsucceeds. The build reports 95 pages with broken anchors, all pre-existing; the./prod.md#workers-and-scalingtarget added here resolves and appears nowhere in that list, and the broken anchors reported against this page are the same ones present onmainbefore this branch