docs: clarify send/recv msg size, normalize prefix matching#76
Conversation
- Clarify GRPCMaxSendMsgSize = response size, GRPCMaxRecvMsgSize = request size - Normalize HTTP header prefixes once at init instead of per-request - Regenerate READMEs via make doc
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation and slightly optimizes HTTP header prefix matching in the grpc-gateway header matcher to avoid per-request normalization work.
Changes:
- Clarifies
GRPCMaxSendMsgSizevsGRPCMaxRecvMsgSizesemantics (response vs request sizing) and splits the previously shared comment. - Normalizes configured HTTP header prefixes once during matcher creation (instead of lowercasing prefixes per request).
- Regenerates generated READMEs (
make doc), updating links/line references.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Updates generated doc links/line references to reflect current code layout. |
| core.go | Pre-lowercases header prefixes inside getCustomHeaderMatcher for consistent matching and less per-request work. |
| config/README.md | Updates generated config docs to reflect clarified gRPC send/recv sizing comments (and regenerated output). |
| config/config.go | Clarifies GRPCMaxSendMsgSize (responses) vs GRPCMaxRecvMsgSize (requests) field comments and default meaning. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThe PR updates API reference documentation, introduces two new configuration fields for debug logging control, clarifies gRPC message size field documentation, and optimizes header prefix matching by precomputing lowercase values instead of lowercasing during each iteration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary
GRPCMaxSendMsgSizelimits response size from the service andGRPCMaxRecvMsgSizelimits request size to the servicegetCustomHeaderMatcherinstead of per-requeststrings.ToLowermake docTest plan
make testpassesmake lintcleanmake docrun, READMEs updatedSummary by CodeRabbit
Release Notes
New Features
Documentation
Performance