Expose use_remote_address

[skonto]

Changes

• As per title
• When the field is set to true and num of hops is zero (Kourier at the edge) you can get the downstream ip of the client in X-Envoy-External-Address.
  To observe use in config-observability:

 logging.enable-request-log: "true"
 logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}", "XFF": "{{index .Request.Header "X-Forwarded-For"}}", "XEAA": "{{index .Request.Header "X-Envoy-External-Address"}}"}'

For more check Example 1 in here.

/kind enhancement

Fixes #1289

Release Note

Adds support for use_remote_address field.

Docs

[knative-prow]

@skonto: The label(s) kind/<kind> cannot be applied, because the repository doesn't have them.

In response to this:

Changes

• As per title
• When the field is set to true and num of hops is zero (Kourier at the edge) you can get the downstream ip of the client.
  To observe use in config-obsverability:

logging.enable-request-log: "true"
logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}", "XFF": "{{index .Request.Header "X-Forwarded-For"}}", "XEAA": "{{index .Request.Header "X-Envoy-External-Address"}}"}'

For more check Example 1 in here.

/kind

Fixes #1289

Release Note

Adds support for use_remote_address field.

Docs

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[skonto]

Are they mutual exclusive? Should we warn the user? 🤔

[ReToCode]

What do you mean by that?

[skonto]

I mean can we use proxy protocol along with use-remote-address, what if both are enabled? I will check if that creates an issue.

[skonto]

It does not seem to create a problem in gateway logs but don't have an environment to easily check this with traffic.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.38%. Comparing base (705fb63) to head (4247297).
Report is 2 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1290      +/-   ##
==========================================
+ Coverage   62.31%   62.38%   +0.06%     
==========================================
  Files          24       24              
  Lines        1632     1635       +3     
==========================================
+ Hits         1017     1020       +3     
  Misses        553      553              
  Partials       62       62              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[skonto]

@ReToCode any idea about the tls failures?

[ReToCode]

I don't see any failures?

/lgtm
/approve

/hold feel free to merge when ready.

[knative-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ReToCode, skonto

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:

• OWNERS [ReToCode,skonto]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[skonto]

I don't see any failures?

Yeah I re-run it check here: https://github.com/knative-extensions/net-kourier/actions/runs/10958128614/attempts/2?pr=1290 (it passed with the 3rd attempt).

[ReToCode]

Hm, might be flaky (don't know). But has nothing to do with your change here.

[skonto]

/unhold