[Java] Refactor webClient generator to use URI templates to capture correct metrics #4314
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.
Spring supports automatic instrumentation of
WebClient
andRestTemplate
to capture metrics when using injected clients. When instrumenting these HTTP clients, a URI template must be provided to properly group parameterized HTTP requests. For example, given a URI/resources/{id}
, metrics should be captured under/resources/{id}
instead of/resources/1234
/resources/4321
/etc.Currently, the OpenAPI generated
RestTemplate
clients use RestTemplate.getUriTemplateHandler, which can capture URI templates and resolve metrics appropriately. However,WebClient
based templates render paths asString
s directly, which erases the template and results in incorrect metric instrumentation:Refactoring the
WebClient
generated clients to use WebClient.UriSpec.uri(String, Map<String, Object> will capture URI templates and enable appropriate metric collection.Note that the URI string provided to
UriSpec.uri(String, Map)
is rendered as a template using UriComponentsBuilder.encode which was introduced inspring-webflux
5.0.8.RELEASE
, and thus, requires a minor version increase.Note that this approach is similar to that of 4299 but is less invasive.
CC: @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog
PR checklist
./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc).master
,4.1.x
,5.0.x
. Default:master
.