This is an automated email from the ASF dual-hosted git repository. dsmiley pushed a commit to branch branch_9x in repository https://gitbox.apache.org/repos/asf/solr.git
commit e9e034154a608bcd937575f3cb23f86e230e7df9 Author: szhou1998 <[email protected]> AuthorDate: Tue Oct 29 21:38:08 2024 -0400 SOLR-16976: Remove log4j-jul jar and use Slf4j bridge for JUL (#2703) Remove log4j-jul jar and use slf4j bridge for JUL to prevent exception from being logged when remote JMX is enabled . Updated jetty.xml to initialize the bridge super early. Co-authored-by: Eric Pugh <[email protected]> Co-authored-by: David Smiley <[email protected]> (cherry picked from commit dbf1c50a67b2e23758ae2381745898f191f0bd47) --- solr/CHANGES.txt | 3 + solr/bin/solr | 3 +- solr/bin/solr.cmd | 2 +- solr/licenses/log4j-jul-2.21.0.jar.sha1 | 1 - solr/licenses/log4j-jul-LICENSE-ASL.txt | 201 ------------------------------- solr/licenses/log4j-jul-NOTICE.txt | 17 --- solr/packaging/test/test_start_solr.bats | 19 ++- solr/server/build.gradle | 1 - solr/server/etc/jetty.xml | 2 + versions.lock | 3 +- 10 files changed, 23 insertions(+), 229 deletions(-) diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt index 6a5eb63c1a9..a6bdde2f0fc 100644 --- a/solr/CHANGES.txt +++ b/solr/CHANGES.txt @@ -87,6 +87,9 @@ Bug Fixes * SOLR-11191: Splitting shards now routes child-docs with their _root_ field when available so they maintain parent relationship. (Zack Kendall) +* SOLR-16976: Remove log4j-jul jar and use slf4j bridge for JUL to prevent exception from being logged when remote JMX + is enabled (Shawn Heisey, Stephen Zhou, Eric Pugh, Christine Poerschke, David Smiley) + Dependency Upgrades --------------------- (No changes) diff --git a/solr/bin/solr b/solr/bin/solr index dbc23b18ff8..0509f465173 100755 --- a/solr/bin/solr +++ b/solr/bin/solr @@ -1071,8 +1071,7 @@ if [ "${SOLR_HOME:0:${#EXAMPLE_DIR}}" = "$EXAMPLE_DIR" ]; then SOLR_LOGS_DIR="$SOLR_HOME/../logs" fi -# 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") +LOG4J_CONFIG=() if [ -n "${LOG4J_PROPS:-}" ]; then LOG4J_CONFIG+=("-Dlog4j.configurationFile=$LOG4J_PROPS") fi diff --git a/solr/bin/solr.cmd b/solr/bin/solr.cmd index 67c1f194061..9d56c9aa872 100755 --- a/solr/bin/solr.cmd +++ b/solr/bin/solr.cmd @@ -1187,7 +1187,7 @@ IF "%SOLR_SSL_ENABLED%"=="true" ( set 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% -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager" +set "START_OPTS=%START_OPTS% -Dsolr.log.dir=%SOLR_LOGS_DIR_QUOTED%" 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/licenses/log4j-jul-2.21.0.jar.sha1 b/solr/licenses/log4j-jul-2.21.0.jar.sha1 deleted file mode 100644 index 89f7c940953..00000000000 --- a/solr/licenses/log4j-jul-2.21.0.jar.sha1 +++ /dev/null @@ -1 +0,0 @@ -f0da61113f4a47654677e6a98b1e13ca7de2483d diff --git a/solr/licenses/log4j-jul-LICENSE-ASL.txt b/solr/licenses/log4j-jul-LICENSE-ASL.txt deleted file mode 100644 index f49a4e16e68..00000000000 --- a/solr/licenses/log4j-jul-LICENSE-ASL.txt +++ /dev/null @@ -1,201 +0,0 @@ - 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 file diff --git a/solr/licenses/log4j-jul-NOTICE.txt b/solr/licenses/log4j-jul-NOTICE.txt deleted file mode 100644 index ebba5ac0018..00000000000 --- a/solr/licenses/log4j-jul-NOTICE.txt +++ /dev/null @@ -1,17 +0,0 @@ -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 file diff --git a/solr/packaging/test/test_start_solr.bats b/solr/packaging/test/test_start_solr.bats index 6c82dc117cf..f6ca16d5fbf 100644 --- a/solr/packaging/test/test_start_solr.bats +++ b/solr/packaging/test/test_start_solr.bats @@ -43,7 +43,7 @@ teardown() { solr start -p ${SOLR2_PORT} solr assert --started http://localhost:${SOLR_PORT}/solr --timeout 5000 solr assert --started http://localhost:${SOLR2_PORT}/solr --timeout 5000 - + run solr stop -p ${SOLR2_PORT} solr assert --not-started http://localhost:${SOLR2_PORT}/solr --timeout 5000 solr assert --started http://localhost:${SOLR_PORT}/solr --timeout 5000 @@ -77,13 +77,24 @@ teardown() { @test "check stop command doesn't hang" { # for start/stop/restart we parse the args separate from picking the command # which means you don't get an error message for passing a start arg, like --jvm-opts to a stop commmand. - + # Set a timeout duration (in seconds) TIMEOUT_DURATION=2 # make sure that passing a non flag option (i.e --jvm-opts "blah") doesn't hang the stop command. run timeout $TIMEOUT_DURATION solr stop --jvm-opts - + assert_output --partial "ERROR: JVM options are required when using the --jvm-opts option!" - + +} + +@test "SOLR-16976 solr starts with remote JMX enabled" { + export ENABLE_REMOTE_JMX_OPTS=true + export RMI_PORT=65535 # need to make sure we don't exceed port range so hard code it + + solr start + solr assert --started http://localhost:${SOLR_PORT} --timeout 5000 + + run cat ${SOLR_LOGS_DIR}/solr-${SOLR_PORT}-console.log + refute_output --partial 'Exception' } diff --git a/solr/server/build.gradle b/solr/server/build.gradle index d0b722d63f6..93b1196b95b 100644 --- a/solr/server/build.gradle +++ b/solr/server/build.gradle @@ -69,7 +69,6 @@ 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/solr/server/etc/jetty.xml b/solr/server/etc/jetty.xml index ee3d3f0246f..282de87536f 100644 --- a/solr/server/etc/jetty.xml +++ b/solr/server/etc/jetty.xml @@ -47,6 +47,8 @@ <Set name="detailedDump">false</Set> </Get> + <Call class="org.slf4j.bridge.SLF4JBridgeHandler" name="removeHandlersForRootLogger"/> + <Call class="org.slf4j.bridge.SLF4JBridgeHandler" name="install"/> <!-- =========================================================== --> <!-- Http Configuration. --> diff --git a/versions.lock b/versions.lock index b9c1edce821..ef3cf0216ff 100644 --- a/versions.lock +++ b/versions.lock @@ -236,9 +236,8 @@ org.apache.kerby:kerby-config:2.0.3 (4 constraints: 593132bc) org.apache.kerby:kerby-pkix:2.0.3 (1 constraints: 740b03e5) org.apache.kerby:kerby-util:2.0.3 (2 constraints: 6b1837b7) org.apache.logging.log4j:log4j-1.2-api:2.21.0 (1 constraints: 3705363b) -org.apache.logging.log4j:log4j-api:2.21.0 (10 constraints: f07d3453) +org.apache.logging.log4j:log4j-api:2.21.0 (9 constraints: 976ff7be) org.apache.logging.log4j:log4j-core:2.21.0 (5 constraints: 5f510091) -org.apache.logging.log4j:log4j-jul:2.21.0 (1 constraints: 3705363b) org.apache.logging.log4j:log4j-layout-template-json:2.21.0 (1 constraints: 3705363b) org.apache.logging.log4j:log4j-slf4j2-impl:2.21.0 (1 constraints: 3705363b) org.apache.logging.log4j:log4j-web:2.21.0 (1 constraints: 3705363b)
