Add option to provide URIs to monitor in addition to the config file #3501
Conversation
A change detected in either the config file itself or the provided additional URIs shall result in a reconfigure Signed-off-by: MichaelMorris <[email protected]>
vy
added
api
There was a problem hiding this comment.
@MichaelMorrisEst, thanks so much for putting effort into this, much appreciated! 😍
I've dropped some remarks. I'd appreciate it if you can update the PR with requested changes. I will have some more remarks – e.g., adding docs – but I will share them last.
| Thread.sleep(100); | ||
| for (int i = 0; i < 20; i++) { | ||
| if (context.getConfiguration() != oldConfig) { | ||
| break; | ||
| } | ||
| Thread.sleep(50); | ||
| } |
There was a problem hiding this comment.
Could you use Awaitility instead of looping with sleep, please?
| final long orig = file.lastModified(); | ||
| final long newTime = orig + 10000; | ||
| assertTrue(file.setLastModified(newTime), "setLastModified should have succeeded."); | ||
| TimeUnit.SECONDS.sleep(MONITOR_INTERVAL_SECONDS + 1); |
There was a problem hiding this comment.
Ugh! Can we do something better?
Proposal
- Use a dedicated new test class (e.g.,
MonitorUriTest) - Create a random file (using
@TempDirfrom JUnit) - Programmatically create a configuration pointing to this file in a
MonitorUricomponent - Create a
LoggerContextfrom this configuration - Modify the random file
- Verify that the configuration is reloaded (I presume you can find examples in existing tests on how to perform this check.)
| @@ -64,4 +64,25 @@ void testReconfiguration(final LoggerContext context) throws Exception { | |||
| } while (newConfig == oldConfig && loopCount++ < 5); | |||
| assertNotSame(newConfig, oldConfig, "Reconfiguration failed"); | |||
| } | |||
|
|
|||
| @Test | |||
There was a problem hiding this comment.
We can remove this if we can have a dedicated MonitorUriTest I hinted earlier.
| @@ -15,7 +15,7 @@ | |||
| ~ See the License for the specific language governing permissions and | |||
| ~ limitations under the License. | |||
| --> | |||
| <Configuration status="OFF" name="XMLConfigTest" monitorInterval="1"> | |||
| <Configuration status="OFF" name="XMLConfigTest" monitorInterval="1" monitorUris="target/test-classes/org/apache/logging/log4j/core/net/ssl/keyStore.p12"> | |||
There was a problem hiding this comment.
I'm reading through the changes, I don't know if it is supported, but please use a dedicated element instead:
<Configuration monitorInterval="1">
<MonitorUris>
<Uri>file:///path/to/file</Uri> <!-- Note that this needs to be a URI, not just a path! -->
<MonitorUris>
<Configuration>
| final ConfigurationSource configSource, | ||
| final Collection<Source> auxiliarySources, |
There was a problem hiding this comment.
Why don't we just provide a single Set<Source> monitorSources?
| @@ -20,7 +20,7 @@ | |||
| * @since 2.4 | |||
| */ | |||
| @Export | |||
| @Version("2.20.1") | |||
| @Version("2.21.0") | |||
There was a problem hiding this comment.
Always target the version this feature will (supposedly) be shipped with:
| @Version("2.21.0") | |
| @Version("2.25.0") |
| initializeMonitoring(intervalSeconds, ""); | ||
| } | ||
|
|
||
| public void initializeMonitoring(final int intervalSeconds, final String monitorUris) { |
There was a problem hiding this comment.
I think this should be Set<URI> monitorUris
A change detected in either the config file itself or the provided additional URIs shall result in a reconfigure
See #3074
Checklist
2.xbranch if you are targeting Log4j 2; usemainotherwise./mvnw verifysucceeds (if it fails due to code formatting issues reported by Spotless, simply run./mvnw spotless:applyand retry)src/changelog/.2.x.xdirectory