Add option to provide URIs to monitor in addition to the config file #3501

MichaelMorrisEst · 2025-02-26T12:39:17Z

A change detected in either the config file itself or the provided additional URIs shall result in a reconfigure
See #3074

Checklist

Base your changes on 2.x branch if you are targeting Log4j 2; use main otherwise
./mvnw verify succeeds (if it fails due to code formatting issues reported by Spotless, simply run ./mvnw spotless:apply and retry)
Non-trivial changes contain an entry file in the src/changelog/.2.x.x directory
Tests for the changes are provided
Commits are signed (optional, but highly recommended)

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

@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.

vy · 2025-03-14T07:52:02Z

log4j-core-test/src/test/java/org/apache/logging/log4j/core/LoggerTest.java

+        Thread.sleep(100);
+        for (int i = 0; i < 20; i++) {
+            if (context.getConfiguration() != oldConfig) {
+                break;
+            }
+            Thread.sleep(50);
+        }


Could you use Awaitility instead of looping with sleep, please?

Used Awatility in new test class

vy · 2025-03-14T07:58:32Z

log4j-core-test/src/test/java/org/apache/logging/log4j/core/LoggerTest.java

+        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);


Ugh! Can we do something better?

Proposal

Use a dedicated new test class (e.g., MonitorUriTest)

Create a random file (using @TempDir from JUnit)

Programmatically create a configuration pointing to this file in a MonitorUri component

Create a LoggerContext from 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.)

vy · 2025-03-14T08:00:53Z

log4j-core-test/src/test/java/org/apache/logging/log4j/core/PropertiesFileConfigTest.java

@@ -64,4 +64,25 @@ void testReconfiguration(final LoggerContext context) throws Exception {
        } while (newConfig == oldConfig && loopCount++ < 5);
        assertNotSame(newConfig, oldConfig, "Reconfiguration failed");
    }
+
+    @Test


We can remove this if we can have a dedicated MonitorUriTest I hinted earlier.

vy · 2025-03-14T08:03:40Z

log4j-core-test/src/test/resources/log4j-test2.xml

@@ -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">


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>  <MonitorUris> <Configuration>

Changed the implementation to use a dedicated element instead

vy · 2025-03-14T08:05:50Z

log4j-core/src/main/java/org/apache/logging/log4j/core/config/AbstractConfiguration.java

+            final ConfigurationSource configSource,
+            final Collection<Source> auxiliarySources,


Why don't we just provide a single Set<Source> monitorSources?

Not applicable anymore with reworked impl

vy · 2025-03-14T08:07:25Z

log4j-core/src/main/java/org/apache/logging/log4j/core/config/builder/api/package-info.java

@@ -20,7 +20,7 @@
 * @since 2.4
 */
 @Export
-@Version("2.20.1")
+@Version("2.21.0")


Always target the version this feature will (supposedly) be shipped with:

Suggested change

@Version("2.21.0")

@Version("2.25.0")

vy · 2025-03-14T08:08:08Z

...core/src/main/java/org/apache/logging/log4j/core/config/builder/impl/BuiltConfiguration.java

+        initializeMonitoring(intervalSeconds, "");
+    }
+
+    public void initializeMonitoring(final int intervalSeconds, final String monitorUris) {


I think this should be Set<URI> monitorUris

Used URIs in reworked impl

…ribute of the Configuration element Signed-off-by: MichaelMorris <[email protected]>

MichaelMorrisEst · 2025-03-21T10:41:43Z

Thanks for your comments @vy. The comment to use a dedicated element instead of an attribute changes the implementation quiet a bit. Please take a look when you have time, feedback gratefully received. Thanks!

Add option to provide URIs to monitor in addition to the config file

0308808

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 self-assigned this Mar 14, 2025

vy added api Affects the public API configuration Affects the configuration system in a general way labels Mar 14, 2025

vy requested changes Mar 14, 2025

View reviewed changes

Reworked to to make monitorUris a dedicated element instead of an att…

ada292f

…ribute of the Configuration element Signed-off-by: MichaelMorris <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add option to provide URIs to monitor in addition to the config file #3501

Add option to provide URIs to monitor in addition to the config file #3501

MichaelMorrisEst commented Feb 26, 2025 •

edited

Loading

vy left a comment

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

vy Mar 14, 2025

MichaelMorrisEst Mar 21, 2025

MichaelMorrisEst commented Mar 21, 2025

		final ConfigurationSource configSource,
		final Collection<Source> auxiliarySources,

Add option to provide URIs to monitor in addition to the config file #3501

Are you sure you want to change the base?

Add option to provide URIs to monitor in addition to the config file #3501

Conversation

MichaelMorrisEst commented Feb 26, 2025 • edited Loading

Checklist

vy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Proposal

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MichaelMorrisEst commented Mar 21, 2025

MichaelMorrisEst commented Feb 26, 2025 •

edited

Loading