docs: warn against combining TimedAspect with Spring Boot's built-in @Timed support#7603
Open
won-seoop wants to merge 1 commit into
Conversation
…timed support micrometer-metricsGH-4621: Registering a TimedAspect bean alongside Spring Boot's auto-configured @timed processing for @Controller/@RestController results in double instrumentation: the same method is timed twice with potentially different tags. This is especially harmful with Prometheus, which rejects duplicate metric registrations. Added a WARNING callout in the @timed section explaining: - Spring Boot instruments @Controller/@RestController automatically - TimedAspect should only be used for non-web beans (services, repositories, etc.) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Closes #4621
Registering a
TimedAspectbean when Spring Boot's built-in@Timedprocessing is active for@Controller/@RestControllermethods leads to double instrumentation of web endpoints. Both mechanisms time the same method, creating duplicate meters — often with the same name but different tags. This is particularly painful with the Prometheus registry, which rejects duplicate metric names at registration time.Added a
WARNINGcallout in the@Timedsection oftimers.adocclarifying:@Controller/@RestController) — noTimedAspectneeded for thoseTimedAspectshould only be used for non-web beans (services, repositories, etc.) that Spring Boot does not instrument automaticallyTest plan