Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebind log4j2 metrics if configuration is changed #5810

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

pativa
Copy link

@pativa pativa commented Jan 17, 2025

Describe the issue

This PR is intended to fix #5756

When log4j2 metrics are reconfigured, metrics will no longer be recorded. For example, if monitorInterval (docs) is configured to 30 is used and configuration is reloaded after application start, metrics would only be recorded for the first 30 seconds.


By using a PropertyChangeListener, it looks like we can register the MetricsFilter in much the same way, but it will be rebound after reloading the configuration. All the previous tests seem to pass too when using this method of configuration.

* Use `PropertyChangeListener` to add the `MetricsFilter` to log4j2 if configuration is reloaded
* When adding filters, check if the filter is already added
* Keep `metricFilters` in a `HashMap` to avoid creating new filters each time configuration is reloaded

Signed-off-by: Patrik Ivarsson <[email protected]>
Signed-off-by: Patrik Ivarsson <[email protected]>
Copy link
Member

@shakuzen shakuzen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the quick turnaround time on submitting a pull request for this. It generally looks good to me. Will metrics filters still be configured on the old Configuration instance? Should that be the case? Does that not result in a memory leak of sorts?

@pativa
Copy link
Author

pativa commented Jan 20, 2025

Thank you for the quick turnaround time on submitting a pull request for this. It generally looks good to me. Will metrics filters still be configured on the old Configuration instance? Should that be the case? Does that not result in a memory leak of sorts?

Thanks for the review!

That is a good point! I don't think it would be any big issue, as the old configuration is already stopped here, but I do think it would be cleaner to clean up any old references to MetricsFilter when we rebind it.

I made a new commit here where I also do a cleanup of the old configuration instance. I also changed the changeListener to only do an update if the configuration instance is not the same object as the old instance (as no rebinding or cleanup should be needed then).

@pativa pativa force-pushed the log4j2-reconfigure-rebind branch from 96dafd3 to 4361d51 Compare January 20, 2025 08:49
@pativa pativa force-pushed the log4j2-reconfigure-rebind branch from 4361d51 to 41d0e7e Compare January 20, 2025 08:53
Intended to verify that we don't continually create more filters when reloading config

Signed-off-by: Patrik Ivarsson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rebind Log4j2Metrics when LoggerContext#reconfigure is called
2 participants