improve: logging for resource filter cache by csviri · Pull Request #3167 · operator-framework/java-operator-sdk

csviri · 2026-02-12T14:57:14Z

Sanitize logs:

remove redundant log message params (like ResourceID) regarding values of MDC.
Adds utility methods to MDCUtils
Add MDC support for event processing
Adds default log4j pattern that includes resource and event related information

Signed-off-by: Attila Mészáros a_meszaros@apple.com

…ork#3106) - Adds utility that provides methods to update resources using comparable resource versions - Integrates this utility to the core of the framework (thus simplifying `ReconciliationDispatcher`) - note that this introduces a change in the behavior for the `UpdateControl.patchStatus` (and others), since it won't trigger the reconiliation for the event in that update. - Renames former `ReconcilerUtils` to `ReconcilerUtilsInternal`, this is breaking but that utils was never advertised for non-internal usage - Includes also fixes for ControllerEventSource event filtering - Improves TemporaryResourceCache event filtering algorithm Signed-off-by: Attila Mészáros <a_meszaros@apple.com> Signed-off-by: Steve Hawkins <shawkins@redhat.com> Co-authored-by: Steve Hawkins <shawkins@redhat.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Copilot

Pull request overview

This pull request enhances the logging infrastructure by integrating MDC (Mapped Diagnostic Context) support for event processing and sanitizing log messages to reduce redundancy. The changes remove explicit resource ID parameters from log messages since this information is now captured in MDC, making logs cleaner while maintaining the same level of detail through structured logging patterns.

Changes:

Added MDC utility methods to capture event source information and resource IDs in logging context
Updated all log4j2.xml files with a standardized pattern that includes MDC placeholders for resource and event information
Refactored log messages across the framework to remove redundant resource ID parameters that are now in MDC
Made fields protected in Event and ResourceEvent classes to support toString implementations in subclasses

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
sample-operators/webpage/src/main/resources/log4j2.xml	Updated log pattern to include MDC placeholders for resource and event metadata
sample-operators/tomcat-operator/src/main/resources/log4j2.xml	Updated log pattern and changed log level from info to debug
sample-operators/mysql-schema/src/main/resources/log4j2.xml	Updated log pattern and changed log level from info to debug
sample-operators/leader-election/src/main/resources/log4j2.xml	Updated log pattern to include MDC placeholders
sample-operators/controller-namespace-deletion/src/main/resources/log4j2.xml	Updated log pattern to include MDC placeholders
operator-framework/src/test/resources/log4j2.xml	Updated log pattern to include MDC placeholders
operator-framework-core/src/test/resources/log4j2.xml	Updated log pattern to include MDC placeholders
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryResourceCache.java	Removed resource ID from debug logs and added new debug statements for cache operations
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java	Added withMDC method and refactored log messages to remove resource IDs
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java	Wrapped event handlers with MDC context and sanitized log messages
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/informer/ExtendedResourceEvent.java	Made previousResource field final and added toString, equals, and hashCode methods
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ResourceEvent.java	Changed action and resource fields from private to protected for subclass access
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSource.java	Wrapped event handlers with MDC context and sanitized log messages
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java	Removed resource ID parameters from log messages
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventProcessor.java	Removed resource ID parameters from log messages and added MDC resource ID info in reconciler executor
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/Event.java	Changed relatedCustomResource field from private to protected
operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java	Added new utility methods for event MDC context management

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...va/io/javaoperatorsdk/operator/processing/event/source/controller/ControllerEventSource.java

...n/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java

...ramework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/EventProcessor.java

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

Copilot · 2026-02-19T13:50:58Z

...ore/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java

    log.debug(
-        "Skipping finalizer remove for resource: {} with version: {}. delete control: {}, uses"
-            + " finalizer: {}",
-        getUID(resourceForExecution),
-        getVersion(resourceForExecution),
+        "Skipping finalizer remove for resource. Delete control: {}, uses  finalizer: {}",
        deleteControl,
        useFinalizer);


There is a double space before "finalizer" in the log message. It should be "Delete control: {}, uses finalizer: {}" with a single space.

Copilot · 2026-02-19T13:50:58Z

...ava/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryResourceCache.java

+      log.debug("Processing event for resource");
    }
    if (!unknownState) {
+      log.debug("Setting latest resource version to: {}", latestResourceVersion);


The log message is misleading. It logs "Setting latest resource version to: {}" but then shows the value of 'latestResourceVersion' (the old value) before it's updated on line 134. The message should either log the new value from 'resource.getMetadata().getResourceVersion()' or be reworded to reflect that it's showing the old value before updating.

Suggested change

log.debug("Setting latest resource version to: {}", latestResourceVersion);

log.debug(

"Setting latest resource version to: {}",

resource.getMetadata().getResourceVersion());

This seems like a valid comment and should be addressed.

...ore/src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java

Copilot · 2026-02-19T13:50:58Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

+  private static final String EVENT_RESOURCE_NAME = "eventsource.event.resource.name";
+  private static final String EVENT_RESOURCE_UID = "eventsource.event.resource.uid";
+  private static final String EVENT_RESOURCE_NAMESPACE = "eventsource.event.resource.namespace";
+  private static final String EVENT_RESOURCE_KIND = "eventsource.event.resource.kind";
+  private static final String EVENT_RESOURCE_VERSION = "eventsource.event.resource.resourceVersion";
+  private static final String EVENT_ACTION = "eventsource.event.action";
+  private static final String EVENT_SOURCE_NAME = "eventsource.name";


The MDC key names defined here do not match the keys used in the log4j2.xml pattern layouts. The log4j2.xml files reference keys like informer.name, informer.event.action, informer.event.resource.name, etc., but the code defines eventsource.name, eventsource.event.action, eventsource.event.resource.name, etc. This mismatch will cause the MDC values not to appear in the logs as expected.

Suggested change

private static final String EVENT_RESOURCE_NAME = "eventsource.event.resource.name";

private static final String EVENT_RESOURCE_UID = "eventsource.event.resource.uid";

private static final String EVENT_RESOURCE_NAMESPACE = "eventsource.event.resource.namespace";

private static final String EVENT_RESOURCE_KIND = "eventsource.event.resource.kind";

private static final String EVENT_RESOURCE_VERSION = "eventsource.event.resource.resourceVersion";

private static final String EVENT_ACTION = "eventsource.event.action";

private static final String EVENT_SOURCE_NAME = "eventsource.name";

private static final String EVENT_RESOURCE_NAME = "informer.event.resource.name";

private static final String EVENT_RESOURCE_UID = "informer.event.resource.uid";

private static final String EVENT_RESOURCE_NAMESPACE = "informer.event.resource.namespace";

private static final String EVENT_RESOURCE_KIND = "informer.event.resource.kind";

private static final String EVENT_RESOURCE_VERSION = "informer.event.resource.resourceVersion";

private static final String EVENT_ACTION = "informer.event.action";

private static final String EVENT_SOURCE_NAME = "informer.name";

This looks like an hallucination but I'm not super familiar with how MDC is used so 🤷

Actually, these should be documented in the appropriate doc section, along with the way to enable / disable it (which I don't think is documented).

Yes, will add this to the docs, although this is not that interesting for the user, since this happens outside the reconciliation, but should be in the docs at least mentioned.

Copilot · 2026-02-19T13:50:59Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

+      HasMetadata resource, Runnable runnable, String nameSourceName) {
+    withMDCForEvent(resource, null, runnable, nameSourceName);
+  }
+
+  public static void withMDCForEvent(
+      HasMetadata resource, ResourceAction action, Runnable runnable, String nameSourceName) {
+    try {
+      MDCUtils.addInformerEventInfo(resource, action, nameSourceName);


The parameter name 'nameSourceName' is misleading and appears to be a typo. It should likely be 'eventSourceName' to be consistent with the actual parameter being passed and the method signature on line 77.

Suggested change

HasMetadata resource, Runnable runnable, String nameSourceName) {

withMDCForEvent(resource, null, runnable, nameSourceName);

}

public static void withMDCForEvent(

HasMetadata resource, ResourceAction action, Runnable runnable, String nameSourceName) {

try {

MDCUtils.addInformerEventInfo(resource, action, nameSourceName);

HasMetadata resource, Runnable runnable, String eventSourceName) {

withMDCForEvent(resource, null, runnable, eventSourceName);

}

public static void withMDCForEvent(

HasMetadata resource, ResourceAction action, Runnable runnable, String eventSourceName) {

try {

MDCUtils.addInformerEventInfo(resource, action, eventSourceName);

Will fix in logger configs

...java/io/javaoperatorsdk/operator/processing/event/source/informer/ExtendedResourceEvent.java

…tor/processing/event/source/informer/InformerEventSource.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…tor/processing/event/EventProcessor.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…tor/processing/MDCUtils.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…tor/processing/event/ReconciliationDispatcher.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Signed-off-by: Chris Laprun <metacosm@gmail.com>

metacosm · 2026-02-19T16:08:22Z

...n/java/io/javaoperatorsdk/operator/processing/event/source/informer/InformerEventSource.java

      secondaryIDs = primaryToSecondaryMapper.toSecondaryResourceIDs(primary);
      log.debug(
-          "Using PrimaryToSecondaryMapper to find secondary resources for primary: {}. Found"
+          "Using PrimaryToSecondaryMapper to find secondary resources for primary. Found"


The indentation rules that split constant Strings is rather stupid.

metacosm · 2026-02-19T16:10:08Z

...io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java

                updatedForLambda != null ? updatedForLambda : extendedResourcePrevVersion;
+            if (log.isDebugEnabled()) {
+              log.debug(
+                  "Extended previous resource version: {} resource from update present: {}"


Why "extended"?

metacosm · 2026-02-19T16:10:34Z

...io/javaoperatorsdk/operator/processing/event/source/informer/ManagedInformerEventSource.java

  public R eventFilteringUpdateAndCacheResource(R resourceToUpdate, UnaryOperator<R> updateMethod) {
    ResourceID id = ResourceID.fromResource(resourceToUpdate);
-    log.debug("Update and cache: {}", id);
+    log.debug("Starting event filter and cache update");


filtering instead of filter

metacosm · 2026-02-19T16:10:54Z

...ava/io/javaoperatorsdk/operator/processing/event/source/informer/TemporaryResourceCache.java

+      log.debug("Processing event for resource");
    }
    if (!unknownState) {
+      log.debug("Setting latest resource version to: {}", latestResourceVersion);


This seems like a valid comment and should be addressed.

metacosm · 2026-02-19T16:16:11Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

+  private static final String EVENT_RESOURCE_NAME = "eventsource.event.resource.name";
+  private static final String EVENT_RESOURCE_UID = "eventsource.event.resource.uid";
+  private static final String EVENT_RESOURCE_NAMESPACE = "eventsource.event.resource.namespace";
+  private static final String EVENT_RESOURCE_KIND = "eventsource.event.resource.kind";
+  private static final String EVENT_RESOURCE_VERSION = "eventsource.event.resource.resourceVersion";
+  private static final String EVENT_ACTION = "eventsource.event.action";
+  private static final String EVENT_SOURCE_NAME = "eventsource.name";


This looks like an hallucination but I'm not super familiar with how MDC is used so 🤷

metacosm · 2026-02-19T16:18:31Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

+  private static final String EVENT_RESOURCE_NAME = "eventsource.event.resource.name";
+  private static final String EVENT_RESOURCE_UID = "eventsource.event.resource.uid";
+  private static final String EVENT_RESOURCE_NAMESPACE = "eventsource.event.resource.namespace";
+  private static final String EVENT_RESOURCE_KIND = "eventsource.event.resource.kind";
+  private static final String EVENT_RESOURCE_VERSION = "eventsource.event.resource.resourceVersion";
+  private static final String EVENT_ACTION = "eventsource.event.action";
+  private static final String EVENT_SOURCE_NAME = "eventsource.name";


Actually, these should be documented in the appropriate doc section, along with the way to enable / disable it (which I don't think is documented).

metacosm · 2026-02-19T16:19:30Z

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/MDCUtils.java

+  private static final String EVENT_ACTION = "eventsource.event.action";
+  private static final String EVENT_SOURCE_NAME = "eventsource.name";
+
+  public static void addInformerEventInfo(


More of a general comment due to my unfamiliarity with MDC: how does this work in a multi-threaded environment?

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 12, 2026

csviri changed the title ~~improve: logging for resource filter cache~~ [WIP] improve: logging for resource filter cache Feb 12, 2026

csviri linked an issue Feb 12, 2026 that may be closed by this pull request

Review logging for event caching and filtering #3166

Open

csviri force-pushed the next branch from 280b162 to 429c2c5 Compare February 16, 2026 09:11

csviri force-pushed the log-sanit branch from 2a4733a to 801e4d0 Compare February 16, 2026 09:17

csviri changed the title ~~[WIP] improve: logging for resource filter cache~~ improve: logging for resource filter cache Feb 19, 2026

csviri marked this pull request as ready for review February 19, 2026 13:47

Copilot AI review requested due to automatic review settings February 19, 2026 13:47

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 19, 2026

openshift-ci bot requested review from metacosm and xstefank February 19, 2026 13:47

csviri and others added 11 commits February 19, 2026 14:47

improve: logging for resource filter cache

99dd0be

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

603a4da

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

f33c78a

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

7991b21

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

a2a5601

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

4c4a297

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

54a0838

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

2dab16e

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

044e43c

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

wip

f0bccda

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

csviri force-pushed the log-sanit branch from fac7fea to f0bccda Compare February 19, 2026 13:47

wip

fa26af9

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

Copilot started reviewing on behalf of csviri February 19, 2026 13:47 View session

Copilot AI reviewed Feb 19, 2026

View reviewed changes

csviri and others added 4 commits February 19, 2026 14:55

Update operator-framework-core/src/main/java/io/javaoperatorsdk/opera…

6d75382

…tor/processing/event/source/informer/InformerEventSource.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update operator-framework-core/src/main/java/io/javaoperatorsdk/opera…

1a0d81f

…tor/processing/event/EventProcessor.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update operator-framework-core/src/main/java/io/javaoperatorsdk/opera…

c4369de

…tor/processing/MDCUtils.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update operator-framework-core/src/main/java/io/javaoperatorsdk/opera…

fce0a08

…tor/processing/event/ReconciliationDispatcher.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

csviri and others added 3 commits February 19, 2026 15:05

wip

08d8a58

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>

fix: potential NPE

cb30b56

Signed-off-by: Chris Laprun <metacosm@gmail.com>

fix: typo

13d8b4a

Signed-off-by: Chris Laprun <metacosm@gmail.com>

metacosm reviewed Feb 19, 2026

View reviewed changes

metacosm requested changes Feb 19, 2026

View reviewed changes

Conversation

csviri commented Feb 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 19, 2026

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!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

metacosm Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

2 participants

Comments

csviri commented Feb 12, 2026 •

edited

Loading

metacosm Feb 19, 2026 •

edited

Loading