Document custom metrics on Monitor.ping - #46
Open
aflanagan wants to merge 4 commits into
Open
Conversation
Keep the existing metrics dict API (encoded as repeated metric=name:value query params) for built-ins and custom names. Document server name rules, limits, and rejected_metrics. Log a warning when a 200 JSON ping body includes rejected_metrics without changing the return type. Co-authored-by: August Flanagan <aflanagan@users.noreply.github.com>
Metric validation is async in the ping worker, not returned on the ingestion response. Drop response-body inspection, warning logs, tests, and docs that suggested clients would see rejected_metrics on ping. Co-authored-by: August Flanagan <aflanagan@users.noreply.github.com>
Co-authored-by: August Flanagan <aflanagan@users.noreply.github.com>
Revert production code and tests to default. Document that arbitrary metrics use the existing metrics dict and metric=name:value encoding. Co-authored-by: August Flanagan <aflanagan@users.noreply.github.com>
cursor
Bot
changed the title
aflanagan
marked this pull request as ready for review
September 11, 2026 20:28
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
2 participants
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.
Shape for review (August)
Docs-only. Production code and tests are identical to
master.Documents the existing public API:
Monitor.ping(..., metrics={name: number, ...})→ repeatedmetric=name:valuequery params.Built-ins (
duration,count,error_count) and custom names (queue_depth,quality_score) share that dict. Server-side, names are lowercased, max 63 characters, and may contain letters, numbers, underscores, and hyphens.This client does not validate metrics locally. The ping HTTP response is not a validation channel.
Changes
monitor.pyand test changes from earlier revisions of this PROut of scope
rejected_metrics/ sync rejection feedbackTest plan
masteris README-only