Add support for configurable target header for the request_id middleware #2040
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 PR adds the ability to choose what header to target for the X-Request-ID. Before this PR, the header used by the middleware was hardcoded for
X-Request-ID
, and exposing it via configuration will allow, among others, to set forX-Correlation-ID
.Setting a different header key is helpful for distributed traceability since
X-Request-ID
is used to trace single requests. In contrast,X-Correlation-ID
(or others) is commonly used to trace multiple servers' transactions.The default is set as the previous hardcoded header (
X-Request-ID
), which is a backward-compatible change.Example for the new configuration:
This way they can be combined and the same middleware can be used for both use-cases.
Also updated documentation: labstack/echox#239