Add HTTP cookie capture #147
Merged
Conversation
This file contains 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
openshift-ci-robot
added
the
do-not-merge/work-in-progress
openshift-ci-robot
added
approved
Add a --capture-http-cookie command-line flag, as well as
ROUTER_CAPTURE_HTTP_COOKIE environment variable, to allow specifying
an HTTP cookie that should be captured for logging.
The flag and environment variable each accept a name:maxLength value, where
name is an HTTP cookie and maxLength is a maximum length. The router
captures the named cookie, which may be referenced in a custom
ROUTER_SYSLOG_FORMAT string or is included in the default log message
format if no custom format string is provided. A cookie value that exceeds
its maximum length is truncated to that length. The value of the first
cookie that matches the provided name captured. By default, names are
compared using a prefix match. An equals sign ("=") may be appended to the
name to indicate that the comparison should use an exact match.
* images/router/haproxy/conf/haproxy-config.template: Add "capture cookie"
stanzas to the "public", "fe_sni", and "fe_no_sni" frontends.
* pkg/cmd/infra/router/template.go (TemplateRouter): Add
CaptureHTTPCookieString and CaptureHTTPCookie fields.
(Bind): Add the --capture-http-cookie flag, which defaults to the value of
the ROUTER_CAPTURE_HTTP_COOKIE environment variable.
(parseCaptureCookie): New function. Parse a string value (such as provided
with the newly added command-line flag) into a CaptureHTTPCookie value.
(Complete): Use parseCaptureCookie to parse CaptureHTTPCookieString into
CaptureHTTPCookie.
(Run): Specify CaptureHTTPCookie in the plugin config.
* pkg/router/template/plugin.go (TemplatePluginConfig): Add
CaptureHTTPCookie field.
(NewTemplatePlugin): Specify CaptureHTTPCookie in the internal template
router config.
* pkg/router/template/router.go (templateRouter):
(templateRouterCfg): Add captureHTTPCookie field.
(templateData): Add CaptureHTTPCookie field.
(newTemplateRouter): Specify captureHTTPCookie in the template router.
(writeConfig): Specify CaptureHTTPCookie in the template parameters.
* pkg/router/template/types.go (CaptureHTTPCookie): New type. Specify an
HTTP cookie name, maximum value length, and match type.
(CookieMatchType): New type.
(CookieMatchTypeExact, CookieMatchTypePrefix): New constants.
Miciah
force-pushed
the
add-HTTP-cookie-capture
branch
from
a7d1917
to
2353425
Compare
openshift-ci-robot
removed
the
needs-rebase
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
|
🍪 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Miciah, sgreene570 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
1 similar comment
|
/retest Please review the full test history for this PR and help us cut down flakes. |
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.
Add a
--capture-http-cookiecommand-line flag, as well asROUTER_CAPTURE_HTTP_COOKIEenvironment variable, to allow specifying an HTTP cookie that should be captured for logging.The flag and environment variable each accept a
name:maxLengthvalue, wherenameis an HTTP cookie andmaxLengthis a maximum length. The router captures the named cookie, which may be referenced in a customROUTER_SYSLOG_FORMATstring or is included in the default log message format if no custom format string is provided. A cookie value that exceeds its maximum length is truncated to that length. The value of the first cookie that matches the provided name captured. By default, names are compared using a prefix match. An equals sign ("=") may be appended to the name to indicate that the comparison should use an exact match.images/router/haproxy/conf/haproxy-config.template: Addcapture cookiestanzas to thepublic,fe_sni, andfe_no_snifrontends.pkg/cmd/infra/router/template.go(TemplateRouter): AddCaptureHTTPCookieStringandCaptureHTTPCookiefields.(
Bind): Add the--capture-http-cookieflag, which defaults to the value of theROUTER_CAPTURE_HTTP_COOKIEenvironment variable.(
parseCaptureCookie): New function. Parse a string value (such as provided with the newly added command-line flag) into aCaptureHTTPCookievalue.(
Complete): UseparseCaptureCookieto parseCaptureHTTPCookieStringintoCaptureHTTPCookie.(
Run): SpecifyCaptureHTTPCookiein the plugin config.pkg/router/template/plugin.go(TemplatePluginConfig): AddCaptureHTTPCookiefield.(
NewTemplatePlugin): SpecifyCaptureHTTPCookiein the internal template router config.pkg/router/template/router.go(templateRouter):(
templateRouterCfg): AddcaptureHTTPCookiefield.(
templateData): AddCaptureHTTPCookiefield.(
newTemplateRouter): SpecifycaptureHTTPCookiein the template router.(
writeConfig): SpecifyCaptureHTTPCookiein the template parameters.pkg/router/template/types.go(CaptureHTTPCookie): New type. Specify an HTTP cookie name, maximum value length, and match type.(
CookieMatchType): New type.(
CookieMatchTypeExact,CookieMatchTypePrefix): New constants.Depends on #139.