docs(usage_pricer): Clarify payg_budget_exhausted semantics#329
Open
armenzg wants to merge 4 commits into
Open
docs(usage_pricer): Clarify payg_budget_exhausted semantics#329armenzg wants to merge 4 commits into
armenzg wants to merge 4 commits into
Conversation
|
The latest Buf updates on your PR. Results from workflow ci / buf-checks (pull_request).
|
Document that payg_budget_exhausted means no budget remaining (pre-cap spend >= cap, or any spend when the cap is 0) rather than "had to cap", matching the producer in getsentry. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify that "no budget remaining" uses pooled pre-cap spend for shared (all-items) budgets, and that the flag is always false for uncapped-rate items (e.g. Seer) and items with no configured cap. Co-authored-by: Cursor <cursoragent@cursor.com>
armenzg
force-pushed
the
armenzg/payg-budget-exhausted-doc
branch
2 times, most recently
from
9624a06 to
a188b6e
Compare
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
1 participant
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.
Rewrites the
payg_budget_exhausteddoc comments onLineItemUsageSummary(field 4) andSharedLineItemUsageSummary(field 3) so consumers can reason about the flag without reading the getsentry producer. Comment-only; no wire-format change.The old comment ("the usage pricer had to cap the spend") was misleading: the producer sets the flag whenever there is no budget left, even when no spend was actually reduced (pre-cap spend exactly equal to the cap). The field now documents the producer's real semantics:
>=), or there is any spend when the cap is0.falsefor items priced at an uncapped rate (e.g. Seer) and for items with no configured cap, since neither counts against a PAYG budget.The shared-summary comment now points at the line-item doc instead of restating the rule, so the two cannot drift.
The regenerated Rust binding carries the same doc text; review the
.protochange and treat the.rschange as generated output.