Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Java] Refactor WebClient clients to use URI templates to capture correct metric info #4299

Closed

Conversation

atsharp
Copy link
Contributor

@atsharp atsharp commented Oct 28, 2019

Spring supports automatic instrumentation of WebClient and RestTemplate 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 using /resources/{id} instead of distinct entries for /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 as Strings directly, which erases the template and results in incorrect metric instrumentation:

String path = UriComponentsBuilder.fromPath("{{{path}}}"){{#hasPathParams}}.buildAndExpand(uriVariables){{/hasPathParams}}{{^hasPathParams}}.build(){{/hasPathParams}}.toUriString();

Refactoring the WebClient generated clients to use a UriBuilder will capture URI templates and enable appropriate metric collection.

See this issue for more detailed information regarding metric collection for WebClient

CC: @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./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).
  • File the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@atsharp
Copy link
Contributor Author

atsharp commented Oct 28, 2019

There are a couple issues with this approach I only now discovered. Will address these and reopen once resolved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant