Instrument HTTP clients for Observability #28341
Assignees
Labels
theme: observability
An issue related to observability and tracing
type: enhancement
A general enhancement
Milestone
Comments
bclozel
added
type: enhancement
bclozel
added a commit
that referenced
this issue
Sep 12, 2022
This commit introduces Micrometer as an API dependency to the spring-web module. Micrometer is used here to instrument `RestTemplate` and record `Observation` for HTTP client exchanges. This will replace Spring Boot's `MetricsClientHttpRequestInterceptor` which uses the request interceptor contract for instrumentation. This approach is limited as measurements and tags aren't always precise and overhead is more important than a direct instrumentation. See gh-28341
bclozel
added a commit
that referenced
this issue
Sep 12, 2022
This commit introduces Micrometer as an API dependency to the spring-webflux module. Micrometer is used here to instrument `WebClient` and record `Observation` for HTTP client exchanges. This replaces Spring Boot's `MetricsWebClientFilterFunction` which instruments `WebClient` via an `ExchangeFilterFunction`. Here, a direct instrumentation is more efficient and less prone to metrics errors. See gh-28341
bclozel
added a commit
to spring-projects/spring-boot
that referenced
this issue
Sep 27, 2022
Prior to this commit, Spring Boot would auto-configure a customizer that instruments `RestTemplate` through a `RestTemplateBuilder`. This would install a request interceptor that instrumented client exchanges for producing metrics. As of spring-projects/spring-framework#28341, the instrumentation is done at the `RestTemplate` level directly using the `Observation` API. The `Tag` (now `KeyValue`) extraction, observation name and instrumentation behavior now lives in the Spring Framework project. This commit updates the auto-configuration to switch from Boot-specific Metrics instrumentation to a generic Observation instrumentation. As a migration path, some configuration properties are deprecated in favor of the new `management.observations.*` namespace. Closes gh-32484
bclozel
added a commit
to spring-projects/spring-boot
that referenced
this issue
Sep 30, 2022
As of spring-projects/spring-framework#28341, `WebClient` is instrumented directly for `Observation`. This commit removes the custom `ExchangeFilterFunction` that previously instrumented the client for metrics. As a result, the relevant tag providers are now deprecated and adapted as `ObservationConvention` for the time being. Closes gh-32518
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Micrometer 1.10 will bring a new micrometer-observation module - this will bring a lightweight API designed for instrumenting code for observability (both metrics and tracing concerns).
We'd like to introduce a compile dependency on that in the
spring-webmodule, which will allow us to instrumentRestTemplateandWebClient. This should not only make the instrumentation more efficient and focused, but also fix a number of limitations of the current instrumentation contributed in Spring Boot.The text was updated successfully, but these errors were encountered: