Introduce TestExecutionListener for Micrometer's ObservationRegistry in the TestContext framework
#30658
Conversation
This file contains 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
without this change we have no option to pass the ObservationRegistry that is registered in the given TestContext's ApplicationContext as the one that should be used by the ObservationThreadLocalAccessor. with this change we create a TestExecutionListener that will set an ObservationRegistry registered in the TestContext's ApplicationContext for each test class and after each test class will restore the previously stored ObservationRegistry instance
…ervation/ObservationThreadLocalTestListener.java Co-authored-by: Sam Brannen <sam@sambrannen.com>
…ervation/ObservationThreadLocalTestListener.java Co-authored-by: Sam Brannen <sam@sambrannen.com>
…ervation/ObservationThreadLocalTestListener.java Co-authored-by: Sam Brannen <sam@sambrannen.com>
…ervation/package-info.java Co-authored-by: Sam Brannen <sam@sambrannen.com>
…ervation/ObservationThreadLocalTestListenerTests.java Co-authored-by: Sam Brannen <sam@sambrannen.com>
- dependencies ordered alphabetically - renamed the test execution listener to contain "execution" and "micrometer" in the name - production code lines are smaller (up to 100 chars) - test execution attribute is a private static final field - added javadocs in the test execution listener
spring-projects-issues
added
the
status: waiting-for-triage
sbrannen
changed the title
MicrometerObservationThreadLocalTestExecutionListener in the TestContext framework
sbrannen
changed the title
MicrometerObservationThreadLocalTestExecutionListener in the TestContext frameworkTestExecutionListener for MicrometerObservationThreadLocalTestExecutionListener` in the TestContext framework
sbrannen
changed the title
TestExecutionListener for MicrometerObservationThreadLocalTestExecutionListener` in the TestContext frameworkTestExecutionListener for Micrometer's ObservationThreadLocalAccessor in the TestContext framework
sbrannen
added
in: test
snicoll
added
the
status: waiting-for-triage
sbrannen
removed
the
status: waiting-for-triage
sbrannen
pushed a commit
that referenced
this pull request
Jun 14, 2023
Prior to this commit, there was no way to specify the ObservationRegistry that is registered in the given test's ApplicationContext as the one that should be used by Micrometer's ObservationThreadLocalAccessor for context propagation. This commit introduces a TestExecutionListener for Micrometer's ObservationRegistry in the Spring TestContext Framework. Specifically, this listener obtains the ObservationRegistry registered in the test's ApplicationContext, stores it in ObservationThreadLocalAccessor for the duration of each test method execution, and restores the original ObservationRegistry in ObservationThreadLocalAccessor after each test. Co-authored-by: Sam Brannen <sam@sambrannen.com> See gh-30658
sbrannen
changed the title
TestExecutionListener for Micrometer's ObservationThreadLocalAccessor in the TestContext frameworkTestExecutionListener for Micrometer's ObservationRegistry in the TestContext framework
mdeinum
pushed a commit
to mdeinum/spring-framework
that referenced
this pull request
Jun 29, 2023
Prior to this commit, there was no way to specify the ObservationRegistry that is registered in the given test's ApplicationContext as the one that should be used by Micrometer's ObservationThreadLocalAccessor for context propagation. This commit introduces a TestExecutionListener for Micrometer's ObservationRegistry in the Spring TestContext Framework. Specifically, this listener obtains the ObservationRegistry registered in the test's ApplicationContext, stores it in ObservationThreadLocalAccessor for the duration of each test method execution, and restores the original ObservationRegistry in ObservationThreadLocalAccessor after each test. Co-authored-by: Sam Brannen <sam@sambrannen.com> See spring-projectsgh-30658
mdeinum
pushed a commit
to mdeinum/spring-framework
that referenced
this pull request
Jun 29, 2023
This commit overhauls the TestExecutionListener for Micrometer's ObservationRegistry that was introduced in the previous commit. Specifically, this commit: - Renames the listener to MicrometerObservationRegistryTestExecutionListener since the use of a ThreadLocal is an implementation detail that may change over time. - Makes the listener package-private instead of public in order to allow the team greater flexibility in evolving this feature. - Eagerly loads the ObservationThreadLocalAccessor class and verifies that it has a getObservationRegistry() method to ensure that the listener is properly skipped when SpringFactoriesLoader attempts to load it, if Micrometer 1.10.8+ is not on the classpath. - Switches the listener's automatic registration order to 2500 in order to register it after the DependencyInjectionTestExecutionListener. - Only tracks the previous ObservationRegistry in beforeTestMethod() if the test's ApplicationContext contains an ObservationRegistry bean. - Properly removes the TestContext attribute for the previous ObservationRegistry in afterTestMethod(). - Introduces DEBUG logging for diagnostics. - Adds an entry in the Javadoc for TestExecutionListener as well as in the Testing chapter in the reference manual. Closes spring-projectsgh-30658
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
supersedes #30651