docs(proxy): document fail_closed_budget_enforcement - #371
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
3 tasks
Collaborator
|
bugbot run |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit a25b794. Configure here.
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
Documents the new
general_settings.fail_closed_budget_enforcementflag added in the proxy PR (BerriAI/litellm#30684), which makes budget enforcement validate spend against the authoritative database for every budgeted request and reject with a 503 when spend cannot be verified against Redis or the database.Changes
docs/proxy/config_settings.md: addsfail_closed_budget_enforcementto thegeneral_settingsYAML example and the reference table.docs/proxy/users.md: adds a "Hard budget enforcement (fail closed)" section under Budgets explaining when to use the flag, what it covers (key, team, user, organization, end-user, tag, and per-window budgets), the bounded database cost, the 503-on-unverifiable behavior, and the default behavior when the flag is off.Related
Proxy change: BerriAI/litellm#30684
Note
Low Risk
Documentation-only changes with no runtime or config parsing impact in this PR.
Overview
Documents
general_settings.fail_closed_budget_enforcementfor the proxy behavior introduced in BerriAI/litellm#30684.docs/proxy/config_settings.mdadds the flag to thegeneral_settingsYAML example and the reference table (defaultfalse, per-request DB validation whentrue, 503 when spend cannot be verified via Redis or DB, link to the users guide).docs/proxy/users.mdadds Hard budget enforcement (fail closed) under budgets: Redis hot-path vs DB authority after Redis restarts, scope (key/team/user/org/end-user/tag/per-window budgets), coalesced in-process DB reads, and how default mode differs (no per-request DB read; cross-check when Redis is below last-known spend).Reviewed by Cursor Bugbot for commit a25b794. Bugbot is set up for automated code reviews on this repo. Configure here.