Skip to content

Commit 0242489

Browse files
Apache9Apache9
authored
HBASE-25696 Need to initialize SLF4JBridgeHandler in jul-to-slf4j for redirecting jul to slf4j (#3093)
Signed-off-by: Michael Stack <stack@apache.org>
1 parent 46f7d9d commit 0242489

7 files changed

Lines changed: 146 additions & 1 deletion

File tree

‎bin/hbase‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,8 @@ for f in "${HBASE_HOME}"/lib/client-facing-thirdparty/*.jar; do
311311
CLASSPATH="${CLASSPATH}:${f}"
312312
fi
313313
done
314+
# redirect java.util.logging to slf4j
315+
HBASE_OPTS="$HBASE_OPTS -Djava.util.logging.config.class=org.apache.hadoop.hbase.logging.JulToSlf4jInitializer"
314316

315317
# default log directory & file
316318
if [ "$HBASE_LOG_DIR" = "" ]; then

‎bin/hbase.cmd‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,9 @@ set HBASE_OPTS=%HBASE_OPTS% -Dhbase.home.dir="%HBASE_HOME%"
326326
set HBASE_OPTS=%HBASE_OPTS% -Dhbase.id.str="%HBASE_IDENT_STRING%"
327327
set HBASE_OPTS=%HBASE_OPTS% -XX:OnOutOfMemoryError="taskkill /F /PID %p"
328328

329+
@rem redirect java.util.logging to slf4j
330+
set HBASE_OPTS=%HBASE_OPTS% -Djava.util.logging.config.class="org.apache.hadoop.hbase.logging.JulToSlf4jInitializer"
331+
329332
if not defined HBASE_ROOT_LOGGER (
330333
set HBASE_ROOT_LOGGER=INFO,console
331334
)

‎hbase-common/src/test/java/org/apache/hadoop/hbase/logging/TestJul2Slf4j.java‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/**
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
package org.apache.hadoop.hbase.logging;
19+
20+
import static org.junit.Assert.assertEquals;
21+
import static org.mockito.ArgumentMatchers.any;
22+
import static org.mockito.Mockito.doAnswer;
23+
import static org.mockito.Mockito.mock;
24+
import static org.mockito.Mockito.times;
25+
import static org.mockito.Mockito.verify;
26+
import static org.mockito.Mockito.when;
27+
28+
import java.io.IOException;
29+
import java.util.concurrent.atomic.AtomicReference;
30+
import org.apache.hadoop.hbase.HBaseClassTestRule;
31+
import org.apache.hadoop.hbase.testclassification.MiscTests;
32+
import org.apache.hadoop.hbase.testclassification.SmallTests;
33+
import org.junit.After;
34+
import org.junit.Before;
35+
import org.junit.ClassRule;
36+
import org.junit.Test;
37+
import org.junit.experimental.categories.Category;
38+
import org.mockito.invocation.InvocationOnMock;
39+
import org.mockito.stubbing.Answer;
40+
41+
/**
42+
* This should be in the hbase-logging module but the {@link HBaseClassTestRule} is in hbase-common
43+
* so we can only put the class in hbase-common module for now...
44+
*/
45+
@Category({ MiscTests.class, SmallTests.class })
46+
public class TestJul2Slf4j {
47+
48+
@ClassRule
49+
public static final HBaseClassTestRule CLASS_RULE =
50+
HBaseClassTestRule.forClass(TestJul2Slf4j.class);
51+
52+
static {
53+
System.setProperty("java.util.logging.config.class", JulToSlf4jInitializer.class.getName());
54+
}
55+
56+
private String loggerName = getClass().getName();
57+
58+
private org.apache.logging.log4j.core.Appender mockAppender;
59+
60+
@Before
61+
public void setUp() {
62+
mockAppender = mock(org.apache.logging.log4j.core.Appender.class);
63+
when(mockAppender.getName()).thenReturn("mockAppender");
64+
when(mockAppender.isStarted()).thenReturn(true);
65+
((org.apache.logging.log4j.core.Logger) org.apache.logging.log4j.LogManager
66+
.getLogger(loggerName)).addAppender(mockAppender);
67+
}
68+
69+
@After
70+
public void tearDown() {
71+
((org.apache.logging.log4j.core.Logger) org.apache.logging.log4j.LogManager
72+
.getLogger(loggerName)).removeAppender(mockAppender);
73+
}
74+
75+
@Test
76+
public void test() throws IOException {
77+
AtomicReference<org.apache.logging.log4j.Level> level = new AtomicReference<>();
78+
AtomicReference<String> msg = new AtomicReference<String>();
79+
doAnswer(new Answer<Void>() {
80+
81+
@Override
82+
public Void answer(InvocationOnMock invocation) throws Throwable {
83+
org.apache.logging.log4j.core.LogEvent logEvent =
84+
invocation.getArgument(0, org.apache.logging.log4j.core.LogEvent.class);
85+
level.set(logEvent.getLevel());
86+
msg.set(logEvent.getMessage().getFormattedMessage());
87+
return null;
88+
}
89+
}).when(mockAppender).append(any(org.apache.logging.log4j.core.LogEvent.class));
90+
java.util.logging.Logger logger = java.util.logging.Logger.getLogger(loggerName);
91+
logger.info(loggerName);
92+
verify(mockAppender, times(1)).append(any(org.apache.logging.log4j.core.LogEvent.class));
93+
assertEquals(org.apache.logging.log4j.Level.INFO, level.get());
94+
assertEquals(loggerName, msg.get());
95+
}
96+
}

‎hbase-logging/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
<dependency>
8787
<groupId>org.slf4j</groupId>
8888
<artifactId>jul-to-slf4j</artifactId>
89-
<scope>test</scope>
89+
<scope>provided</scope>
9090
</dependency>
9191
<dependency>
9292
<groupId>org.apache.logging.log4j</groupId>

‎hbase-logging/src/main/java/org/apache/hadoop/hbase/logging/JulToSlf4jInitializer.java‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/**
2+
* Licensed to the Apache Software Foundation (ASF) under one
3+
* or more contributor license agreements. See the NOTICE file
4+
* distributed with this work for additional information
5+
* regarding copyright ownership. The ASF licenses this file
6+
* to you under the Apache License, Version 2.0 (the
7+
* "License"); you may not use this file except in compliance
8+
* with the License. You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
package org.apache.hadoop.hbase.logging;
19+
20+
import java.io.ByteArrayInputStream;
21+
import java.io.IOException;
22+
import java.nio.charset.StandardCharsets;
23+
import java.util.logging.LogManager;
24+
import org.apache.yetus.audience.InterfaceAudience;
25+
import org.slf4j.bridge.SLF4JBridgeHandler;
26+
27+
/**
28+
* Setup {@link SLF4JBridgeHandler}.
29+
* <p/>
30+
* Set the system property {@code java.util.logging.config.class} to this class to initialize the
31+
* direction for java.util.logging to slf4j.
32+
*/
33+
@InterfaceAudience.Private
34+
public class JulToSlf4jInitializer {
35+
36+
private static final String PROPERTIES = "handlers=" + SLF4JBridgeHandler.class.getName();
37+
38+
public JulToSlf4jInitializer() throws IOException {
39+
LogManager.getLogManager()
40+
.readConfiguration(new ByteArrayInputStream(PROPERTIES.getBytes(StandardCharsets.UTF_8)));
41+
}
42+
}

‎hbase-logging/src/test/resources/log4j2.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,6 @@
4141
<!-- For testing where we want to capture the log message of these special loggers -->
4242
<Logger name="org.apache.hadoop.hbase.ipc.FailedServers" level="debug" />
4343
<Logger name="org.apache.hadoop.hbase.regionserver.RSRpcServices" level="debug" />
44+
<Logger name="org.apache.hadoop.hbase.logging.TestJul2Slf4j" level="debug" />
4445
</Loggers>
4546
</Configuration>

‎pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -775,6 +775,7 @@
775775
<systemPropertyVariables>
776776
<test.build.classes>${test.build.classes}</test.build.classes>
777777
<java.io.tmpdir>${test.tmp.dir}</java.io.tmpdir>
778+
<java.util.logging.config.class>org.apache.hadoop.hbase.logging.JulToSlf4jInitializer</java.util.logging.config.class>
778779
</systemPropertyVariables>
779780
<excludes>
780781
<!-- users can add -D option to skip particular test classes

0 commit comments

Comments
 (0)