This is an automated email from the ASF dual-hosted git repository.
paksyd pushed a commit to branch branch-2
in repository https://gitbox.apache.org/repos/asf/hbase.git
The following commit(s) were added to refs/heads/branch-2 by this push:
new 4c51e135a60 HBASE-29775 Allow inspecting log levels in Master UI in
read-only mode (#7599)
4c51e135a60 is described below
commit 4c51e135a603e9d1472afa5c9eb05a948c7b16d9
Author: JinHyuk Kim <[email protected]>
AuthorDate: Thu Jan 8 16:05:33 2026 +0900
HBASE-29775 Allow inspecting log levels in Master UI in read-only mode
(#7599)
* Refactor LogLevel CLI to separate response fetching from output
* Add tests for LogLevel readonly master UI mode
* Propagate IOException instead of catching it
Signed-off-by: Duo Zhang <[email protected]>
Signed-off-by: Dávid Paksy <[email protected]>
Signed-off-by: Nihal Jain <[email protected]>
---
.../org/apache/hadoop/hbase/http/log/LogLevel.java | 47 +++--
.../apache/hadoop/hbase/http/log/TestLogLevel.java | 215 +++++++++++++++------
2 files changed, 189 insertions(+), 73 deletions(-)
diff --git
a/hbase-http/src/main/java/org/apache/hadoop/hbase/http/log/LogLevel.java
b/hbase-http/src/main/java/org/apache/hadoop/hbase/http/log/LogLevel.java
index a9e8fa7cbe1..1a23cf46076 100644
--- a/hbase-http/src/main/java/org/apache/hadoop/hbase/http/log/LogLevel.java
+++ b/hbase-http/src/main/java/org/apache/hadoop/hbase/http/log/LogLevel.java
@@ -27,6 +27,7 @@ import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.Objects;
import java.util.regex.Pattern;
+import java.util.stream.Collectors;
import javax.net.ssl.HttpsURLConnection;
import javax.net.ssl.SSLSocketFactory;
import javax.servlet.ServletException;
@@ -61,6 +62,7 @@ public final class LogLevel {
public static final String PROTOCOL_HTTPS = "https";
public static final String READONLY_LOGGERS_CONF_KEY =
"hbase.ui.logLevels.readonly.loggers";
+ public static final String MASTER_UI_READONLY_CONF_KEY =
"hbase.master.ui.readonly";
/**
* A command line implementation
@@ -214,7 +216,11 @@ public final class LogLevel {
* @throws Exception if unable to connect
*/
private void doGetLevel() throws Exception {
- process(protocol + "://" + hostName + "/logLevel?log=" + className);
+ System.out.println(fetchGetLevelResponse());
+ }
+
+ String fetchGetLevelResponse() throws Exception {
+ return fetchResponse(protocol + "://" + hostName + "/logLevel?log=" +
className);
}
/**
@@ -223,7 +229,12 @@ public final class LogLevel {
* @throws Exception if unable to connect
*/
private void doSetLevel() throws Exception {
- process(protocol + "://" + hostName + "/logLevel?log=" + className +
"&level=" + level);
+ System.out.println(fetchSetLevelResponse());
+ }
+
+ String fetchSetLevelResponse() throws Exception {
+ return fetchResponse(
+ protocol + "://" + hostName + "/logLevel?log=" + className + "&level="
+ level);
}
/**
@@ -257,11 +268,12 @@ public final class LogLevel {
}
/**
- * Configures the client to send HTTP request to the URL. Supports SPENGO
for authentication.
+ * Send HTTP request and fetch response.
* @param urlString URL and query string to the daemon's web UI
+ * @return the response from the daemon
* @throws Exception if unable to connect
*/
- private void process(String urlString) throws Exception {
+ private String fetchResponse(String urlString) throws Exception {
URL url = new URL(urlString);
System.out.println("Connecting to " + url);
@@ -269,16 +281,14 @@ public final class LogLevel {
HttpExceptionUtils.validateResponse(connection, 200);
- // read from the servlet
-
try (
InputStreamReader streamReader =
new InputStreamReader(connection.getInputStream(),
StandardCharsets.UTF_8);
BufferedReader bufferedReader = new BufferedReader(streamReader)) {
- bufferedReader.lines().filter(Objects::nonNull).filter(line ->
line.startsWith(MARKER))
- .forEach(line ->
System.out.println(TAG.matcher(line).replaceAll("")));
- } catch (IOException ioe) {
- System.err.println("" + ioe);
+
+ return bufferedReader.lines().filter(Objects::nonNull)
+ .filter(line -> line.startsWith(MARKER)).map(line ->
TAG.matcher(line).replaceAll(""))
+ .collect(Collectors.joining("\n"));
}
}
}
@@ -300,14 +310,6 @@ public final class LogLevel {
if (!HttpServer.hasAdministratorAccess(getServletContext(), request,
response)) {
return;
}
- // Disallow modification of the LogLevel if explicitly set to readonly
- Configuration conf =
- (Configuration)
getServletContext().getAttribute(HttpServer.CONF_CONTEXT_ATTRIBUTE);
- if (conf.getBoolean("hbase.master.ui.readonly", false)) {
- sendError(response, HttpServletResponse.SC_FORBIDDEN,
- "Modification of HBase via the UI is disallowed in configuration.");
- return;
- }
response.setContentType("text/html");
PrintWriter out;
try {
@@ -323,6 +325,8 @@ public final class LogLevel {
String logName = ServletUtil.getParameter(request, "log");
String level = ServletUtil.getParameter(request, "level");
+ Configuration conf =
+ (Configuration)
getServletContext().getAttribute(HttpServer.CONF_CONTEXT_ATTRIBUTE);
String[] readOnlyLogLevels = conf.getStrings(READONLY_LOGGERS_CONF_KEY);
if (logName != null) {
@@ -332,6 +336,13 @@ public final class LogLevel {
Logger log = LoggerFactory.getLogger(logName);
out.println(MARKER + "Log Class: <b>" + log.getClass().getName() +
"</b><br />");
if (level != null) {
+ // Disallow modification of the LogLevel if explicitly set to
readonly
+ if (conf.getBoolean(MASTER_UI_READONLY_CONF_KEY, false)) {
+ sendError(response, HttpServletResponse.SC_FORBIDDEN,
+ "Modification of HBase via the UI is disallowed in
configuration.");
+ return;
+ }
+
if (!isLogLevelChangeAllowed(logName, readOnlyLogLevels)) {
sendError(response, HttpServletResponse.SC_PRECONDITION_FAILED,
"Modification of logger " + logName + " is disallowed in
configuration.");
diff --git
a/hbase-http/src/test/java/org/apache/hadoop/hbase/http/log/TestLogLevel.java
b/hbase-http/src/test/java/org/apache/hadoop/hbase/http/log/TestLogLevel.java
index 23beacfba74..5ac316e0147 100644
---
a/hbase-http/src/test/java/org/apache/hadoop/hbase/http/log/TestLogLevel.java
+++
b/hbase-http/src/test/java/org/apache/hadoop/hbase/http/log/TestLogLevel.java
@@ -20,6 +20,7 @@ package org.apache.hadoop.hbase.http.log;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
+import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
@@ -30,6 +31,8 @@ import java.net.SocketException;
import java.net.URI;
import java.security.PrivilegedExceptionAction;
import java.util.Properties;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
import javax.net.ssl.SSLException;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.io.FileUtils;
@@ -44,6 +47,7 @@ import org.apache.hadoop.hbase.http.HttpConfig;
import org.apache.hadoop.hbase.http.HttpServer;
import org.apache.hadoop.hbase.http.log.LogLevel.CLI;
import org.apache.hadoop.hbase.http.ssl.KeyStoreTestUtil;
+import org.apache.hadoop.hbase.logging.Log4jUtils;
import org.apache.hadoop.hbase.testclassification.MiscTests;
import org.apache.hadoop.hbase.testclassification.SmallTests;
import org.apache.hadoop.hdfs.DFSConfigKeys;
@@ -89,6 +93,32 @@ public class TestLogLevel {
private static String HTTP_PRINCIPAL = "HTTP/" + LOCALHOST;
private static HBaseCommonTestingUtility HTU;
private static File keyTabFile;
+ private static final Pattern EFFECTIVE_LEVEL = Pattern.compile("Effective
level:\\s*(\\S+)");
+
+ @FunctionalInterface
+ private interface ThrowingRunnable {
+ void run() throws Exception;
+ }
+
+ @FunctionalInterface
+ private interface ThrowingConsumer {
+ void accept(String url) throws Exception;
+ }
+
+ private enum Protocol {
+ C_HTTP_S_HTTP(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP),
+ C_HTTP_S_HTTPS(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTPS),
+ C_HTTPS_S_HTTP(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTP),
+ C_HTTPS_S_HTTPS(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTPS);
+
+ final String client;
+ final String server;
+
+ Protocol(String client, String server) {
+ this.client = client;
+ this.server = server;
+ }
+ }
@BeforeClass
public static void setUp() throws Exception {
@@ -261,36 +291,44 @@ public class TestLogLevel {
return server;
}
- private void testDynamicLogLevel(final String bindProtocol, final String
connectProtocol,
- final boolean isSpnego) throws Exception {
- testDynamicLogLevel(bindProtocol, connectProtocol, isSpnego, logName,
- org.apache.logging.log4j.Level.DEBUG.toString());
+ private void testGetLogLevel(Protocol protocol, boolean isSpnego, String
loggerName,
+ String expectedLevel) throws Exception {
+ withLogLevelServer(protocol, isSpnego, (authority) -> {
+ final String level = getLevel(protocol.client, authority, loggerName);
+ assertEquals("Log level not equal to expected: ", expectedLevel, level);
+ });
}
- private void testDynamicLogLevel(final String bindProtocol, final String
connectProtocol,
- final boolean isSpnego, final String newLevel) throws Exception {
- testDynamicLogLevel(bindProtocol, connectProtocol, isSpnego, logName,
newLevel);
+ private void testSetLogLevel(Protocol protocol, boolean isSpnego, String
loggerName,
+ String newLevel) throws Exception {
+ String oldLevel = Log4jUtils.getEffectiveLevel(loggerName);
+ assertNotEquals("New level is same as old level: ", newLevel, oldLevel);
+
+ try {
+ withLogLevelServer(protocol, isSpnego, (authority) -> {
+ setLevel(protocol.client, authority, loggerName, newLevel);
+ });
+ } finally {
+ // restore log level
+ Log4jUtils.setLogLevel(loggerName, oldLevel);
+ }
}
/**
- * Run both client and server using the given protocol.
- * @param bindProtocol specify either http or https for server
- * @param connectProtocol specify either http or https for client
- * @param isSpnego true if SPNEGO is enabled
- * @throws Exception if client can't accesss server.
+ * Starts a LogLevel server and executes a client action against it.
+ * @param protocol protocol configuration for client and server
+ * @param isSpnego whether SPNEGO authentication is enabled
+ * @param consumer client action executed with the server authority
(host:port)
+ * @throws Exception if server setup or client execution fails
*/
- private void testDynamicLogLevel(final String bindProtocol, final String
connectProtocol,
- final boolean isSpnego, final String loggerName, final String newLevel)
throws Exception {
- if (!LogLevel.isValidProtocol(bindProtocol)) {
- throw new Exception("Invalid server protocol " + bindProtocol);
+ private void withLogLevelServer(Protocol protocol, final boolean isSpnego,
+ ThrowingConsumer consumer) throws Exception {
+ if (!LogLevel.isValidProtocol(protocol.server)) {
+ throw new Exception("Invalid server protocol " + protocol.server);
}
- if (!LogLevel.isValidProtocol(connectProtocol)) {
- throw new Exception("Invalid client protocol " + connectProtocol);
+ if (!LogLevel.isValidProtocol(protocol.client)) {
+ throw new Exception("Invalid client protocol " + protocol.client);
}
- org.apache.logging.log4j.Logger log =
org.apache.logging.log4j.LogManager.getLogger(loggerName);
- org.apache.logging.log4j.Level oldLevel = log.getLevel();
- assertNotEquals("Get default Log Level which shouldn't be ERROR.",
- org.apache.logging.log4j.Level.ERROR, oldLevel);
// configs needed for SPNEGO at server side
if (isSpnego) {
@@ -305,28 +343,21 @@ public class TestLogLevel {
UserGroupInformation.setConfiguration(serverConf);
}
- final HttpServer server = createServer(bindProtocol, isSpnego);
- // get server port
+ final HttpServer server = createServer(protocol.server, isSpnego);
final String authority =
NetUtils.getHostPortString(server.getConnectorAddress(0));
-
String keytabFilePath = keyTabFile.getAbsolutePath();
UserGroupInformation clientUGI =
UserGroupInformation.loginUserFromKeytabAndReturnUGI(clientPrincipal,
keytabFilePath);
try {
clientUGI.doAs((PrivilegedExceptionAction<Void>) () -> {
- // client command line
- getLevel(connectProtocol, authority, loggerName);
- setLevel(connectProtocol, authority, loggerName, newLevel);
+ consumer.accept(authority);
return null;
});
} finally {
clientUGI.logoutUserFromKeytab();
server.stop();
}
-
- // restore log level
- org.apache.logging.log4j.core.config.Configurator.setLevel(log.getName(),
oldLevel);
}
/**
@@ -335,10 +366,12 @@ public class TestLogLevel {
* @param authority daemon's web UI address
* @throws Exception if unable to connect
*/
- private void getLevel(String protocol, String authority, String logName)
throws Exception {
+ private String getLevel(String protocol, String authority, String logName)
throws Exception {
String[] getLevelArgs = { "-getlevel", authority, logName, "-protocol",
protocol };
CLI cli = new CLI(protocol.equalsIgnoreCase("https") ? sslConf :
clientConf);
- cli.run(getLevelArgs);
+ cli.parseArguments(getLevelArgs);
+ final String response = cli.fetchGetLevelResponse();
+ return extractEffectiveLevel(response);
}
/**
@@ -351,19 +384,33 @@ public class TestLogLevel {
throws Exception {
String[] setLevelArgs = { "-setlevel", authority, logName, newLevel,
"-protocol", protocol };
CLI cli = new CLI(protocol.equalsIgnoreCase("https") ? sslConf :
clientConf);
- cli.run(setLevelArgs);
+ cli.parseArguments(setLevelArgs);
+ final String response = cli.fetchSetLevelResponse();
+ final String responseLevel = extractEffectiveLevel(response);
+ final String currentLevel = Log4jUtils.getEffectiveLevel(logName);
+ assertEquals("new level not equal to expected: ", newLevel, currentLevel);
+ assertSame("new level not equal to response level: ", newLevel,
responseLevel);
+ }
- org.apache.logging.log4j.Logger logger =
org.apache.logging.log4j.LogManager.getLogger(logName);
+ /**
+ * Extract effective log level from server response.
+ * @param response server body response string
+ * @return the effective log level
+ */
+ private String extractEffectiveLevel(String response) {
+ Matcher m = EFFECTIVE_LEVEL.matcher(response);
+ if (m.find()) {
+ return org.apache.logging.log4j.Level.toLevel(m.group(1)).name();
+ }
- assertEquals("new level not equal to expected: ", newLevel.toUpperCase(),
- logger.getLevel().toString());
+ fail("Cannot find effective log level from response: " + response);
+ return null;
}
@Test
public void testSettingProtectedLogLevel() throws Exception {
try {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP,
true, protectedLogName,
- "DEBUG");
+ testSetLogLevel(Protocol.C_HTTP_S_HTTP, true, protectedLogName, "DEBUG");
fail("Expected IO exception due to protected logger");
} catch (IOException e) {
assertTrue(e.getMessage().contains("" +
HttpServletResponse.SC_PRECONDITION_FAILED));
@@ -372,13 +419,26 @@ public class TestLogLevel {
}
}
+ @Test
+ public void testGetDebugLogLevel() throws Exception {
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "DEBUG");
+ }
+
+ @Test
+ public void testGetInfoLogLevel() throws Exception {
+ Log4jUtils.setLogLevel(logName, "INFO");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "INFO");
+ }
+
/**
* Test setting log level to "Info".
* @throws Exception if client can't set log level to INFO.
*/
@Test
- public void testInfoLogLevel() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP, true,
"INFO");
+ public void testSetInfoLogLevel() throws Exception {
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testSetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "INFO");
}
/**
@@ -386,8 +446,9 @@ public class TestLogLevel {
* @throws Exception if client can't set log level to ERROR.
*/
@Test
- public void testErrorLogLevel() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP, true,
"ERROR");
+ public void testSetErrorLogLevel() throws Exception {
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testSetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "ERROR");
}
/**
@@ -397,10 +458,11 @@ public class TestLogLevel {
*/
@Test
public void testLogLevelByHttp() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP, false);
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTP, false, logName, "DEBUG");
try {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTPS,
false);
- fail("An HTTPS Client should not have succeeded in connecting to a " +
"HTTP server");
+ testGetLogLevel(Protocol.C_HTTPS_S_HTTP, false, logName, "DEBUG");
+ fail("An HTTPS Client should not have succeeded in connecting to a HTTP
server");
} catch (SSLException e) {
exceptionShouldContains("Unrecognized SSL message", e);
}
@@ -413,10 +475,11 @@ public class TestLogLevel {
*/
@Test
public void testLogLevelByHttpWithSpnego() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTP, true);
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "DEBUG");
try {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTP, LogLevel.PROTOCOL_HTTPS,
true);
- fail("An HTTPS Client should not have succeeded in connecting to a " +
"HTTP server");
+ testGetLogLevel(Protocol.C_HTTPS_S_HTTP, true, logName, "DEBUG");
+ fail("An HTTPS Client should not have succeeded in connecting to a HTTP
server");
} catch (SSLException e) {
exceptionShouldContains("Unrecognized SSL message", e);
}
@@ -429,10 +492,11 @@ public class TestLogLevel {
*/
@Test
public void testLogLevelByHttps() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTPS,
false);
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTPS_S_HTTPS, false, logName, "DEBUG");
try {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTP,
false);
- fail("An HTTP Client should not have succeeded in connecting to a " +
"HTTPS server");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTPS, false, logName, "DEBUG");
+ fail("An HTTP Client should not have succeeded in connecting to a HTTPS
server");
} catch (SocketException e) {
exceptionShouldContains("Unexpected end of file from server", e);
}
@@ -445,15 +509,56 @@ public class TestLogLevel {
*/
@Test
public void testLogLevelByHttpsWithSpnego() throws Exception {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTPS,
true);
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTPS_S_HTTPS, true, logName, "DEBUG");
try {
- testDynamicLogLevel(LogLevel.PROTOCOL_HTTPS, LogLevel.PROTOCOL_HTTP,
true);
- fail("An HTTP Client should not have succeeded in connecting to a " +
"HTTPS server");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTPS, true, logName, "DEBUG");
+ fail("An HTTP Client should not have succeeded in connecting to a HTTPS
server");
} catch (SocketException e) {
exceptionShouldContains("Unexpected end of file from server", e);
}
}
+ /**
+ * Test getting log level in readonly mode.
+ * @throws Exception if a client can't get log level.
+ */
+ @Test
+ public void testGetLogLevelAllowedInReadonlyMode() throws Exception {
+ withMasterUIReadonly(() -> {
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ testGetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "DEBUG");
+ });
+ }
+
+ /**
+ * Test setting log level in readonly mode.
+ * @throws Exception if a client can set log level.
+ */
+ @Test
+ public void testSetLogLevelDisallowedInReadonlyMode() throws Exception {
+ withMasterUIReadonly(() -> {
+ Log4jUtils.setLogLevel(logName, "DEBUG");
+ try {
+ testSetLogLevel(Protocol.C_HTTP_S_HTTP, true, logName, "INFO");
+ fail("Setting log level should be disallowed in readonly mode.");
+ } catch (IOException e) {
+ exceptionShouldContains("Modification of HBase via the UI is
disallowed in configuration.",
+ e);
+ }
+ });
+ }
+
+ private void withMasterUIReadonly(ThrowingRunnable runnable) throws
Exception {
+ boolean prev = serverConf.getBoolean(LogLevel.MASTER_UI_READONLY_CONF_KEY,
false);
+ serverConf.setBoolean(LogLevel.MASTER_UI_READONLY_CONF_KEY, true);
+ try {
+ runnable.run();
+ } finally {
+ serverConf.setBoolean(LogLevel.MASTER_UI_READONLY_CONF_KEY, prev);
+ }
+ }
+
/**
* Assert that a throwable or one of its causes should contain the substr in
its message. Ideally
* we should use {@link GenericTestUtils#assertExceptionContains(String,
Throwable)} util method
