Uploaded image for project: 'CXF'
  1. CXF
  2. CXF-8424

Use template URL instead of actual path values for JAX-RS micrometer metrics

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: 3.4.1, 3.3.9
    • Fix Version/s: 3.5.0, 3.4.3, 3.3.10
    • Component/s: JAX-RS
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      Description

      The JAX-RS micrometer metrics implemented in the PRs listed below generates one unique metric per combination of path parameteres in the URL. For instance if you have the following path annotation on an API:

      @Path("/user/{userId}" 

      A request to the URL /user/1234 will result in the following metric:

      cxf_server_requests_seconds_count{exception="None",method="GET",operation="getUser",outcome="SUCCESS",status="200",uri="/user/1234",} 1.0 

      Since the uri-tag in the metric uses the actual path value this could lead to a huge number of metrics since it will create one metric per user. It will also be more difficult to aggregate the metrics for one operation in tools like Prometheus/Grafana.

      A suggestion is to instead generate the metric with the uri-tag as a templated url. I think this is how the metrics generated by Spring MVC is constructed. This would result in the following metric instead:

      cxf_server_requests_seconds_count{exception="None",method="GET",operation="getUser",outcome="SUCCESS",status="200",uri="/user/{userId}",} 1.0  

      Not sure if this is possible and what the best solution is, but it might be possible to use the UriInfo class (https://javaee.github.io/javaee-spec/javadocs/javax/ws/rs/core/UriInfo.html)  to get the URI without the values, or use that class to replace the actual values with a placeholder/variable text.

      Relevant PRs:
      https://github.com/apache/cxf/pull/716
      https://github.com/apache/cxf/pull/642 

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                reta Andriy Redko
                Reporter:
                henriwi Henrik Wingerei
              • Votes:
                1 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: