SOLR-18042 Manage MDC Logging Context setup/teardown in a servlet filter. #3985
+162
−52
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc | ||
| title: SOLR 18042 - MDC Logging context lifecycle is now managed by a servlet filter | ||
| type: other # added, changed, fixed, deprecated, removed, dependency_update, security, other | ||
| authors: | ||
| - name: Gus Heck | ||
| links: | ||
| - name: SOLR-18042 | ||
| url: https://issues.apache.org/jira/browse/SOLR-18042 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.solr.servlet; | ||
|
|
||
| import jakarta.servlet.FilterConfig; | ||
| import jakarta.servlet.ServletException; | ||
| import jakarta.servlet.UnavailableException; | ||
| import jakarta.servlet.http.HttpFilter; | ||
| import java.lang.invoke.MethodHandles; | ||
| import org.apache.solr.core.CoreContainer; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** A superclass for filters that will need to interact with the CoreContainer. */ | ||
| public abstract class CoreContainerAwareHttpFilter extends HttpFilter { | ||
| private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); | ||
|
|
||
| private CoreContainerProvider containerProvider; | ||
|
|
||
| @Override | ||
| public void init(FilterConfig config) throws ServletException { | ||
| super.init(config); | ||
| containerProvider = CoreContainerProvider.serviceForContext(config.getServletContext()); | ||
| if (log.isTraceEnabled()) { | ||
| log.trace("{}.init(): {}", this.getClass().getName(), this.getClass().getClassLoader()); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The CoreContainer. It's guaranteed to be constructed before this filter is initialized, but | ||
| * could have been shut down. Never null. | ||
| */ | ||
| public CoreContainer getCores() throws UnavailableException { | ||
| return containerProvider.getCoreContainer(); | ||
| } | ||
|
|
||
| // TODO: not fond of having these here, but RateLimiter initialization can be sorted out later | ||
| RateLimitManager getRateLimitManager() { | ||
| return containerProvider.getRateLimitManager(); | ||
| } | ||
|
|
||
| void replaceRateLimitManager(RateLimitManager rlm) { | ||
| containerProvider.setRateLimitManager(rlm); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.solr.servlet; | ||
|
|
||
| import jakarta.servlet.FilterChain; | ||
| import jakarta.servlet.ServletException; | ||
| import jakarta.servlet.http.HttpServletRequest; | ||
| import jakarta.servlet.http.HttpServletResponse; | ||
| import java.io.IOException; | ||
| import java.lang.invoke.MethodHandles; | ||
| import org.apache.solr.common.util.SuppressForbidden; | ||
| import org.apache.solr.logging.MDCLoggingContext; | ||
| import org.apache.solr.logging.MDCSnapshot; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** Servlet Filter to set up and tear down MDC Logging context for each reqeust. */ | ||
| public class MdcLoggingFilter extends CoreContainerAwareHttpFilter { | ||
|
|
||
| private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); | ||
|
|
||
| @Override | ||
| @SuppressForbidden( | ||
| reason = | ||
| "Set the thread contextClassLoader for all 3rd party dependencies that we cannot control") | ||
| protected void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain) | ||
| throws IOException, ServletException { | ||
| ClassLoader contextClassLoader = Thread.currentThread().getContextClassLoader(); | ||
| // this autocloseable is here to invoke MDCSnapshot.close() which restores captured state | ||
| try (var mdcSnapshot = MDCSnapshot.create()) { | ||
| log.trace("MDC snapshot recorded {}", mdcSnapshot); // avoid both compiler and ide warning. | ||
| MDCLoggingContext.reset(); | ||
| MDCLoggingContext.setNode(getCores()); | ||
| // This doesn't belong here, but for the moment it is here to preserve it's relative | ||
| // timing of execution for now. Probably I will break this out in a subsequent change | ||
| Thread.currentThread().setContextClassLoader(getCores().getResourceLoader().getClassLoader()); | ||
| chain.doFilter(req, res); | ||
| } finally { | ||
| MDCLoggingContext.reset(); | ||
| Thread.currentThread().setContextClassLoader(contextClassLoader); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hopefully not a future Filter for just one line.
I sympathize with your characterization of SolrDispatchFilter as a kitchen sink but a few lines for certain topics at the critical Solr entrypoint is understandable IMO.