Repository navigation
docs: document the pprof upstream kind - #12
Merged
Merged
Conversation
The pprof kind merged in #9 without its docs. Describe it as config.go, routes.go, and relay.go define it: targets in place of url, max_seconds (default 30, at most 45) and max_concurrent (default 1, at most 8), the six read routes, seconds as the only query key, and the 404, 400, and 429 refusals. The configuration.md example was validated with -print-routes. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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.
The pprof upstream kind merged in #9 (495db17) but the docs still said Go pprof was "next". This PR documents it exactly as
config.go,routes.go, andrelay.godefine it. Docs only.README.md: pprof in the list of kinds; drops the "next" wording; line count updated (947).docs/configuration.md: approfupstream with twotargetsin the annotated example,max_seconds(1 to 45, default 30) andmax_concurrent(1 to 8, default 1), and a short "pprof upstreams" section on routes, thesecondsquery rule, and refusals.docs/security.md: thepprofrow in the read-route table and its404 unknown target,400, and429refusals.docs/operations.md:-print-routesoutput for pprof and theunknown-target,query,busydecisions.docs/setup.md,examples/kubernetes/relay.yaml: pprof in the kind lists.Proof: the complete YAML block in
docs/configuration.mdwas extracted and run throughgo run ./cmd/perfloop-relay -config <file> -print-routes; it validates and prints the two targets, the caps, and the six routes.go test -race ./...andgo vet ./...pass.🤖 Generated with Claude Code