DOC/MINOR: update request-capture documentation to clarify header handling#780
Open
odoucet wants to merge 1 commit intohaproxytech:masterfrom
Open
DOC/MINOR: update request-capture documentation to clarify header handling#780odoucet wants to merge 1 commit intohaproxytech:masterfrom
odoucet wants to merge 1 commit intohaproxytech:masterfrom
Conversation
bc71ee5 to
1c70a24
Compare
Member
|
LGTM |
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.
This pull request updates the documentation to clarify and correct how to capture HTTP headers that may contain commas (such as
User-Agent) in HAProxy annotations. It emphasizes the importance of usingreq.fhdr(header-name)instead ofhdr(header-name)to avoid issues with truncated or malformed log entries, and updates all relevant examples accordingly.This is a followup of #729
Documentation improvements:
documentation/doc.yamlexplaining thathdr(header-name)splits values on commas, which can cause problems when capturing headers likeUser-Agent, and instructing users to usereq.fhdr(header-name)instead.documentation/doc.yamlto usereq.fhdr(user-agent)instead ofhdr(User-Agent).hdr(header-name)andreq.fhdr(header-name)for headers with commas.