Fix handling of `onMatch` and `onMismatch` attributes in the properties configuration format by ramanathan1504 · Pull Request #4116 · apache/logging-log4j2

ramanathan1504 · 2026-05-06T08:39:52Z

Addressed review feedback in this update:

Properties builder robustness (log4j-core/.../PropertiesConfigurationBuilder.java)
- Added explicit guard for missing rootProperties in build().
- Replaced direct Long.parseLong(...) for shutdownTimeout with validated parsing (parseShutdownTimeout(...)) that throws a ConfigurationException with a clear message.
- Kept builder API usage compatible with current interfaces (setLevelAttribute(...), setAdditivityAttribute(...)) to avoid regressions.
Properties consumption correctness (log4j-core/.../PropertiesConfigurationBuilder.java)
- Switched logger/root levelAndRefs reads to remove the consumed key (properties.remove("")) to avoid stale/unprocessed entries.
- Ensured remaining logger/root properties are processed via processRemainingProperties(...) before returning, so extra nested attributes/components are not dropped.
Null/empty check cleanup (log4j-core/.../PropertiesConfigurationBuilder.java)
- Simplified redundant null-or-empty check to Strings.isEmpty(type) in createComponent(...).
Changelog typo fix (src/changelog/.2.x.x/2791_rework_ComponentBuilder_API.xml)
- Corrected JVerify -> JSpecify.

…Attributte (apache#2791) + more appropriate method name

@NullMarked

+ made all Default***Builder implementations @ProviderrType + added setXXXAttribute method to some component builder interfaces with default implementations + added JSpecify @NullMarked to packages and @nullable where approrpiate to fields/mehods (per last PR review) + deprecated ComponentBuilder#addAttribute(...) methods and replaced with ComponentBuilder#setAttribute(...) methods in line with other builders (i.e. Plugins) - also since they don't just add but also remove if the value is null + reorganized ConfigurationBuilder to group getters, setters, builder factory methods + incremented package-info.java @Version annoations + added some null-guards in BuiltConfiguration#setup() + moved DeffaultConfigurationBuilder XML generation code from top to bottom of source file + removed "extra" attributes in Default***Builder constructors and replaced with setXXXAttribute chained calls in DefaultConfigurrationBuilder#newXXX(...) convenience methods + javadoc'd both packages (fixing documentation errors)

…ache#2791)

…instead of void (apache#2791) + added @BaselineIgnore due to API change (but breaks no code)

…lve builder conflicts

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

vy · 2026-06-18T09:08:37Z

+     * @param level the level
+     * @return this builder (for chaining)
+     */
+    default AppenderRefComponentBuilder setLevelAttribute(@Nullable String level) {


As @ppkarwasz remarked earlier, I was expecting no set*Attribute methods. Am I missing something?

vy · 2026-06-18T09:10:39Z

+     * @param newValue the new value
+     * @return the previous value or {@code null} if none was set
+     */
+    protected @Nullable String putAttribute(final String key, final @Nullable String newValue) {


Please see @ppkarwasz's earlier remark:

Why is this protected?

It has a better sounding name than addAttribute. Maybe addAttribute should be deprecated (possibly with an Error Prone @InlineMe annotation) and this should be public?

vy · 2026-06-18T09:12:18Z

These changes are redundant, please revert 'em.

vy · 2026-06-18T09:13:41Z

+     * @return this builder (for chaining)
     */
-    ConfigurationBuilder<T> addProperty(String key, String value);
+    ConfigurationBuilder<T> add(PropertyComponentBuilder builder);


Don't we need a @throws NPE ... documentation here too?

vy · 2026-06-18T09:15:15Z

+     * @param packages a comma separated list of packages
+     * @return this builder (for chaining)
+     * @deprecated use package metadata and plugin descriptors instead of runtime package scanning
+     */


Please add a @since.

vy · 2026-06-18T09:20:55Z

    @Override
-    public T addAttribute(final String key, final int value) {
-        return put(key, Integer.toString(value));
+    public @NonNull CB getBuilder() {


See @ppkarwasz's earlier remark:

Isn't @NonNull the default?

vy · 2026-06-18T09:27:44Z

+  <issue id="2791" link="https://github.com/apache/logging-log4j2/issues/2791"/>
+  <description format="asciidoc">
+    Fix problem when null attribute values are set on DefaultComponentBuilder. GitHub issue #2791.
+    Added JSpecify annotations to config.builder.* packages.
+    Updated Builder APIs and Default***Builder implementations.


Suggested change

<issue id="2791" link="https://github.com/apache/logging-log4j2/issues/2791"/>

<description format="asciidoc">

Fix problem when null attribute values are set on DefaultComponentBuilder. GitHub issue #2791.

Added JSpecify annotations to config.builder.* packages.

Updated Builder APIs and Default***Builder implementations.

<issue id="4116" link="https://github.com/apache/logging-log4j2/pull/4116"/>

<description format="asciidoc">

Rework programmatic configuration API and its implementations.

vy · 2026-06-18T09:28:59Z

@ramanathan1504, would you mind creating one more changelog entry file with the following content, please?

Issues: Fix handling of onMatch and onMismatch attributes in the properties configuration format #2791, 2791 Fix handling of onMatch and onMismatch attributes in the properties configuration format #3505, Fix handling of onMatch and onMismatch attributes in the properties configuration format #4116

Type: fixed

Description: Fix handling of onMatch and onMismatch attributes in the properties configuration format

ok i will do that

JWT007 and others added 11 commits February 27, 2025 20:13

Fix potential NPEs in DefaultComponentBuilder in addAttribute methods (…

322cc1d

…apache#2791)

Added JVerify annotations per review (apache#2791)

3aa1ac2

Added DefaultComponentBuilderTest (apache#2791)

406b097

Replaced DefaultComponentBuilder#put with DefaultComponentBuilder#put…

5bc9762

…Attributte (apache#2791) + more appropriate method name

Update references to deprecations with new component builder APIs (ap…

fcc5d3e

…ache#2791)

Changed ConfigurationBuilder#setLoggerContext(...) to return builder …

8415abf

…instead of void (apache#2791) + added @BaselineIgnore due to API change (but breaks no code)

Adapt changelog entry for additional changes (apache#2791)

d7526eb

Fix handling of onMatch and onMismatch

2529817

Merge myfork/2.x into fix-handling-of-onmatch-and-onmismatch and reso…

ec39d61

…lve builder conflicts

Fix AsyncWaitStrategyFactory null handling and update version to 2.26.0

f3629db

github-project-automation Bot added this to Log4j pull request tracker May 6, 2026

vy mentioned this pull request May 28, 2026

2791 Fix handling of onMatch and onMismatch attributes in the properties configuration format #3505

Closed

ramanathan1504 requested a review from Copilot June 8, 2026 16:35

Copilot AI reviewed Jun 8, 2026

Copilot started reviewing on behalf of ramanathan1504 June 8, 2026 16:46 View session

vy changed the title ~~Fix handling of onmatch and onmismatch~~ 2791 Fix handling of onMatch and onMismatch attributes in the properties configuration format Jun 18, 2026

vy changed the title ~~2791 Fix handling of onMatch and onMismatch attributes in the properties configuration format~~ Fix handling of onMatch and onMismatch attributes in the properties configuration format Jun 18, 2026

vy requested changes Jun 18, 2026

View reviewed changes

github-project-automation Bot moved this to Changes requested in Log4j pull request tracker Jun 18, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Fix handling of `onMatch` and `onMismatch` attributes in the properties configuration format#4116

Fix handling of `onMatch` and `onMismatch` attributes in the properties configuration format#4116
ramanathan1504 wants to merge 11 commits into
apache:2.xfrom
ramanathan1504:fix-handling-of-onmatch-and-onmismatch

ramanathan1504 commented May 6, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

vy Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

ramanathan1504 Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

ramanathan1504 Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

vy Jun 18, 2026

Uh oh!

ramanathan1504 Jun 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

ramanathan1504 commented May 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants