Apache Solr open-source search software
SOLR-16878: Add JUL Log4J manager for lucene logs (#1765)
Houston Putman8c3b093601c8
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 5c974d076d5..4efad9340b1 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -237,6 +237,8 @@ Improvements* SOLR-16470: `/coreName/replication?command=filelist` now has a v2 equivalent, available at`GET /api/cores/coreName/replication/files?generation=123` (Matthew Biscocho via Jason Gerlowski)+* SOLR-16878: Use Log4J JUL manager when starting Java. This is necessary for Lucene logs to be included with Solr logs. (Houston Putman, Uwe Schindler)+Optimizations---------------------diff --git a/solr/bin/solr b/solr/bin/solrindex b9aab9bbfd3..d69a974b28b 100644--- a/solr/bin/solr+++ b/solr/bin/solr@@ -1581,7 +1581,8 @@ if [ "${SOLR_HOME:0:${#EXAMPLE_DIR}}" = "$EXAMPLE_DIR" ]; thenSOLR_LOGS_DIR="$SOLR_HOME/../logs"fi-LOG4J_CONFIG=()+# Set the logging manager by default, so that Lucene JUL logs are included with Solr logs.+LOG4J_CONFIG=("-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager")if [ -n "${LOG4J_PROPS:-}" ]; thenLOG4J_CONFIG+=("-Dlog4j.configurationFile=$LOG4J_PROPS")fidiff --git a/solr/bin/solr.cmd b/solr/bin/solr.cmdindex f0ba5839468..662fc392615 100755--- a/solr/bin/solr.cmd+++ b/solr/bin/solr.cmd@@ -1237,7 +1237,7 @@ IF NOT "%SOLR_LOG_LEVEL%"=="" set "START_OPTS=%START_OPTS% -Dsolr.log.level=%SOLset SOLR_LOGS_DIR_QUOTED="%SOLR_LOGS_DIR%"set SOLR_DATA_HOME_QUOTED="%SOLR_DATA_HOME%"-set "START_OPTS=%START_OPTS% -Dsolr.log.dir=%SOLR_LOGS_DIR_QUOTED%"+set "START_OPTS=%START_OPTS% -Dsolr.log.dir=%SOLR_LOGS_DIR_QUOTED% -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager"IF NOT "%SOLR_DATA_HOME%"=="" set "START_OPTS=%START_OPTS% -Dsolr.data.home=%SOLR_DATA_HOME_QUOTED%"IF NOT DEFINED LOG4J_CONFIG set "LOG4J_CONFIG=%SOLR_SERVER_DIR%\resources\log4j2.xml"diff --git a/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java b/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.javaindex d5988f01990..2dadf94264d 100644--- a/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java+++ b/solr/core/src/java/org/apache/solr/servlet/CoreContainerProvider.java@@ -46,6 +46,7 @@ import java.util.WeakHashMap;import java.util.concurrent.CountDownLatch;import java.util.concurrent.TimeUnit;import java.util.function.Supplier;+import java.util.stream.Stream;import javax.naming.Context;import javax.naming.InitialContext;import javax.naming.NamingException;@@ -55,6 +56,8 @@ import javax.servlet.ServletContextEvent;import javax.servlet.ServletContextListener;import javax.servlet.UnavailableException;import org.apache.http.client.HttpClient;+import org.apache.lucene.store.MMapDirectory;+import org.apache.lucene.util.VectorUtil;import org.apache.solr.cloud.ZkController;import org.apache.solr.common.SolrException;import org.apache.solr.common.SolrException.ErrorCode;@@ -226,6 +229,21 @@ public class CoreContainerProvider implements ServletContextListener {StartupLoggingUtils.changeLogLevel(logLevel);}+ // Do initial logs for experimental Lucene classes.+ // TODO: Use "MethodHandles.lookup().ensureClassInitialized()" instead of "Class.forName()"+ // once JDK 15+ is mandatory+ Stream.of(MMapDirectory.class, VectorUtil.class)+ .forEach(+ cls -> {+ try {+ Class.forName(cls.getName());+ } catch (ReflectiveOperationException re) {+ throw new SolrException(+ ErrorCode.SERVER_ERROR, "Could not load Lucene class: " + cls.getName());+ }+ });+ VectorUtil.dotProduct(new byte[0], new byte[0]);+coresInit = createCoreContainer(computeSolrHome(servletContext), extraProperties);this.httpClient = coresInit.getUpdateShardHandler().getDefaultHttpClient();setupJvmMetrics(coresInit, coresInit.getNodeConfig().getMetricsConfig());diff --git a/solr/licenses/log4j-jul-2.20.0.jar.sha1 b/solr/licenses/log4j-jul-2.20.0.jar.sha1new file mode 100644index 00000000000..980c951a714--- /dev/null+++ b/solr/licenses/log4j-jul-2.20.0.jar.sha1@@ -0,0 +1 @@+8170e6118eac1ab332046c179718a0f107f688e1diff --git a/solr/licenses/log4j-jul-LICENSE-ASL.txt b/solr/licenses/log4j-jul-LICENSE-ASL.txtnew file mode 100644index 00000000000..f49a4e16e68--- /dev/null+++ b/solr/licenses/log4j-jul-LICENSE-ASL.txt@@ -0,0 +1,201 @@+ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed 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.\ No newline at end of filediff --git a/solr/licenses/log4j-jul-NOTICE.txt b/solr/licenses/log4j-jul-NOTICE.txtnew file mode 100644index 00000000000..ebba5ac0018--- /dev/null+++ b/solr/licenses/log4j-jul-NOTICE.txt@@ -0,0 +1,17 @@+Apache Log4j+Copyright 1999-2017 Apache Software Foundation++This product includes software developed at+The Apache Software Foundation (http://www.apache.org/).++ResolverUtil.java+Copyright 2005-2006 Tim Fennell++Dumbster SMTP test server+Copyright 2004 Jason Paul Kitchen++TypeUtil.java+Copyright 2002-2012 Ramnivas Laddad, Juergen Hoeller, Chris Beams++picocli (http://picocli.info)+Copyright 2017 Remko Popma\ No newline at end of filediff --git a/solr/server/build.gradle b/solr/server/build.gradleindex d44c96ec8fd..68a150d5f97 100644--- a/solr/server/build.gradle+++ b/solr/server/build.gradle@@ -67,6 +67,7 @@ dependencies {libExt 'org.apache.logging.log4j:log4j-1.2-api'libExt 'org.apache.logging.log4j:log4j-api'libExt 'org.apache.logging.log4j:log4j-core'+ libExt 'org.apache.logging.log4j:log4j-jul'libExt 'org.apache.logging.log4j:log4j-layout-template-json'libExt 'org.apache.logging.log4j:log4j-slf4j2-impl'libExt 'org.apache.logging.log4j:log4j-web'diff --git a/versions.lock b/versions.lockindex 4aa376e9f6d..ee128a6f95d 100644--- a/versions.lock+++ b/versions.lock@@ -202,8 +202,9 @@ org.apache.kerby:kerby-config:1.0.1 (4 constraints: 4d3182b9)org.apache.kerby:kerby-pkix:1.0.1 (1 constraints: 710bfce4)org.apache.kerby:kerby-util:1.0.1 (2 constraints: 6518bdb6)org.apache.logging.log4j:log4j-1.2-api:2.20.0 (1 constraints: 3605333b)-org.apache.logging.log4j:log4j-api:2.20.0 (9 constraints: 926f5bba)+org.apache.logging.log4j:log4j-api:2.20.0 (10 constraints: ea7d264d)org.apache.logging.log4j:log4j-core:2.20.0 (5 constraints: 82556aef)+org.apache.logging.log4j:log4j-jul:2.20.0 (1 constraints: 3605333b)org.apache.logging.log4j:log4j-layout-template-json:2.20.0 (1 constraints: 3605333b)org.apache.logging.log4j:log4j-slf4j2-impl:2.20.0 (1 constraints: 3605333b)org.apache.logging.log4j:log4j-web:2.20.0 (1 constraints: 3605333b)