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

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

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

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

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

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

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

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.

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

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

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?

It is bound to a ThreadLocal, so basically we set at some point when we receive the event from the informer thread and when we finished event processing removing the event.

xstefank

I didn't find anything beyond what was already reported.

…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>

…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>

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

csviri · 2026-02-23T12:54:28Z

@metacosm @xstefank I fixed the comments, added a new section to the docs! thx for the comments!

pls approve if you do not see other issues

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 force-pushed the log-sanit branch from fac7fea to f0bccda Compare February 19, 2026 13:47

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

Copilot AI reviewed Feb 19, 2026

View reviewed changes

metacosm reviewed Feb 19, 2026

View reviewed changes

metacosm requested changes Feb 19, 2026

View reviewed changes

xstefank approved these changes Feb 20, 2026

View reviewed changes

csviri and others added 13 commits February 23, 2026 13:53

improve: logging for resource filter cache

1ce32d5

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

wip

0be62b3

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

wip

c81cec7

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

wip

7f6b2ed

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

wip

cfdc6df

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

wip

b570edb

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

wip

ee699bd

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

wip

defa24d

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

wip

265415a

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

wip

855688a

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

wip

acd82c2

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

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

6a4311b

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

csviri and others added 9 commits February 23, 2026 13:53

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

1a4f728

…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…

f49672c

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

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

129a35b

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

wip

8478154

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

fix: potential NPE

65281a7

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

fix: typo

5c89b5b

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

refactor: use accessor instead of field

5abf316

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

fixes from code review

43b9826

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

update docs

1b8417c

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

csviri force-pushed the log-sanit branch from 067758f to 1b8417c Compare February 23, 2026 12:53

csviri requested a review from metacosm February 23, 2026 12:54

Comments

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!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

metacosm Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

metacosm Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

csviri Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

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!

Uh oh!

Uh oh!

Uh oh!

metacosm Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

metacosm Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

metacosm Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

csviri Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

xstefank left a comment • 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!

csviri commented Feb 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

csviri commented Feb 12, 2026 •

edited

Loading

metacosm Feb 19, 2026 •

edited

Loading

xstefank left a comment •

edited

Loading