feat: Add RequestID to ClientTrafficPolicy for controlling X-Request-ID header behavior #5283
+841
−1
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
|
Need to adjust the true|false logic |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5283 +/- ##
==========================================
+ Coverage 64.89% 64.97% +0.08%
==========================================
Files 213 213
Lines 33458 33474 +16
==========================================
+ Hits 21711 21750 +39
+ Misses 10413 10397 -16
+ Partials 1334 1327 -7 ☔ View full report in Codecov by Sentry. |
|
/retest |
1 similar comment
|
/retest |
guydc
reviewed
Feb 17, 2025
zirain
reviewed
Feb 18, 2025
internal/gatewayapi/testdata/clienttrafficpolicy-mtls-forward-client-cert.out.yaml
Outdated
Show resolved
Hide resolved
|
/retest |
arkodg
reviewed
Feb 18, 2025
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
jukie
force-pushed
the
api/disable-generate-request-id
branch
from
141240c to
ea676fc
Compare
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
guydc
reviewed
Feb 19, 2025
arkodg
reviewed
Feb 19, 2025
arkodg
reviewed
Feb 19, 2025
Signed-off-by: jukie <[email protected]>
Co-authored-by: Arko Dasgupta <[email protected]> Signed-off-by: Isaac <[email protected]>
Signed-off-by: jukie <[email protected]>
jukie
changed the title
arkodg
reviewed
Feb 19, 2025
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
arkodg
reviewed
Feb 19, 2025
Signed-off-by: jukie <[email protected]>
Signed-off-by: jukie <[email protected]>
sanposhiho
reviewed
Feb 20, 2025
| @@ -132,10 +132,18 @@ type HeaderSettings struct { | |||
| // PreserveXRequestID configures Envoy to keep the X-Request-ID header if passed for a request that is edge | |||
| // (Edge request is the request from external clients to front Envoy) and not reset it, which is the current Envoy behaviour. | |||
| // It defaults to false. | |||
| // Deprecated: use RequestID instead | |||
There was a problem hiding this comment.
need to mention what happens when both are set. Or, we should validate only either of them is set at CEL validation.
There was a problem hiding this comment.
also it'd be more user friendly how they can use RequestID to configure the same. (i.e. set Preserve)
| @@ -638,8 +647,14 @@ type HeaderSettings struct { | |||
| // PreserveXRequestID configures whether Envoy will keep the x-request-id header if passed for a request that is edge | |||
| // (Edge request is the request from external clients to front Envoy) and not reset it, which is the current Envoy behaviour. | |||
| // It defaults to false. | |||
| // Deprecated: use RequestID instead | |||
| PreserveXRequestID bool `json:"preserveXRequestID,omitempty" yaml:"preserveXRequestID,omitempty"` | |||
There was a problem hiding this comment.
Can we just delete this field and use only RequestID internally? Do we usually avoid breaking changes at IR level as well?
There was a problem hiding this comment.
Yah +1 to cleaning this up, can also be done in a follow up
zirain
previously approved these changes
Feb 22, 2025
Signed-off-by: Arko Dasgupta <[email protected]>
zirain
approved these changes
Feb 22, 2025
arkodg
approved these changes
Feb 22, 2025
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.
What type of PR is this?
feat: allow disabling
generate_request_idWhat this PR does / why we need it:
This allows for disabling Envoy's default behavior of generating an X-request-id header for every request. Generating a random UUID4 is expensive so in high throughput scenarios it's desirable to disable this.
Which issue(s) this PR fixes:
Fixes #5281
Release Notes: Yes