Micrometer for http requests: URI templating not working with interfaces

[baiglin]

Describe the bug

Hello,

While integrating Micrometer into our application, checking the http metrics and more specifically the URI, I could see that in some case it was not templatized.
It seems to come from the fact that we used in some case an API instead of annotating the class directly and in this case it seems the @path annotation is not used to resolve the template URI.

Best Regards

Expected behavior

Have a tag with the template URI instead of the whole URI

Actual behavior

Full URI is set as metric tag.

How to Reproduce?

micrometer_reproducer.zip

This is a small reproducer that contains the two versions of a dummy resource, one usin an API, the other no to highlight the difference.

Output of uname -a or ver

No response

Output of java -version

No response

GraalVM version (if different from Java)

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

[quarkus-bot]

/cc @ebullient

[ebullient]

Thanks for opening this issue. In the meanwhile, you can use matchPattern to force usage of the templated URI.

[baiglin]

Thanks for opening this issue. In the meanwhile, you can use matchPattern to force usage of the templated URI.

Exactly, there is still a way out of it, but was really surprise it was not always working especially with the work done in #17676, unfortunately I did not have to dig more to find where the missing part comes from exactly.

[ebullient]

I may not be chasing interfaces correctly for path annotation detection. Thanks for the reproducer, that helps a lot. ;)

[imjuoy]

What is the current status of resolving this issue? This issue is affecting us for now, since we use micrometer for metrics and are getting WARNING's regarding "number of tags for http.server.requests".
Should we be moving ahead with setting "match-pattern" properties as mentioned below:
https://github.com/tomekl007/nessie/blob/be4e348f4b1b4e12453912cb594a4781dc73a5d6/servers/quarkus-server/src/main/resources/application.properties#L173

[ebullient]

You should set the match pattern as that gets you out of trouble right now, there are some things I'm waiting for to fix this issue, but the match pattern will continue to work regardless (at some future point, you may not need it, but it will work, so.. )

[imjuoy]

@ebullient Thanks for the confirmation.
I have a question regarding having multiple path parameters.
Everywhere I refer to for examples of configurations, it's mostly just one path param. For example:

• https://quarkus.io/guides/all-config#quarkus-micrometer_quarkus.micrometer.binder.http-server.match-patterns

• https://github.com/tomekl007/nessie/blob/be4e348f4b1b4e12453912cb594a4781dc73a5d6/servers/quarkus-server/src/main/resources/application.properties#L173

In our case, the application has three path parameters. Let's say:
/v1/api/param1/param2/param3

Param2 has limited set of values and will never lead to high cardinality situations.
Is it possible to just record param2 and keep param1 and param3 templatized?

[ebullient]

At the moment, no. I was making some tradeoffs re: cost because this comparison is done with every request measurement.

I could add an option to use replaceAll rather than flat assignment...

[imjuoy]

Can you please elaborate what you meant by :
"I could add an option to use replaceAll rather than flat assignment..."

[ebullient]

quarkus/extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/binder/RequestMetricInfo.java

Line 59 in 5eb3169

static String applyMatchPatterns(String path, Map<Pattern, String> matchPatterns) {

From there. I just assign the match pattern value at the moment, but the pattern is a proper regex, I could allow use of replaceAll as well (which would allow you to use matching groups)

[imjuoy]

I want to make sure, that I have explained the problem correctly.
So given that I have three path params, param1, param2, param3,
I want to write a regex such that :
/v1/api/regex=/v1/api/{param1}/value of param2/{param3}

[ebullient]

Right.
If I allowed use of replaceAll, you could specify the match string like this:
/v1/api/[^/]+/([^/]+)/.*=/v1/api/{param1}/$1/{param3}
(single group)

[rkorver]

When will there be a proper solution to the problem that micrometer doesn't properly recognize http request uri's? Thanks in advance!

[geoand]

Is this still an issue? If it is, can someone attach a reproduce that uses the latest version of Quarkus so I can look into it?

Thanks

[geoand]

Closing for lack of feedback