Jackie-Jiang commented on code in PR #9180: URL: https://github.com/apache/pinot/pull/9180#discussion_r940762275
########## pinot-common/src/test/java/org/apache/pinot/common/utils/LoggerUtilsTest.java: ########## @@ -0,0 +1,84 @@ +/** + * 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.pinot.common.utils; + +import com.google.common.collect.ImmutableList; +import java.util.List; +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testng.Assert; +import org.testng.annotations.Test; + + +public class LoggerUtilsTest { + private static final Logger LOGGER = LoggerFactory.getLogger(LoggerUtilsTest.class); + + @Test + public void testGetAllLoggers() { + List<String> allLoggers = LoggerUtils.getAllLoggers(); + Assert.assertEquals(allLoggers.size(), 1); + Assert.assertEquals(allLoggers.get(0), "root"); + } + + @Test + public void testGetLoggerInfo() { + Map<String, Object> rootLoggerInfo = LoggerUtils.getLoggerInfo("root"); + Assert.assertEquals(rootLoggerInfo.get("name"), "root"); + Assert.assertEquals(rootLoggerInfo.get("level"), "WARN"); + Assert.assertNull(rootLoggerInfo.get("filter")); + + Assert.assertNull(LoggerUtils.getLoggerInfo("notExistLogger")); + } + + @Test + public void testChangeLoggerLevel() { + Assert.assertEquals(LoggerUtils.getLoggerInfo("root").get("level"), "WARN"); + for (String level : ImmutableList.of("WARN", "INFO", "DEBUG", "ERROR", "WARN")) { + LoggerUtils.setLoggerLevel("root", level); + System.out.println("Current logger level is " + level); Review Comment: (minor) Remove the console output ########## pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java: ########## @@ -0,0 +1,83 @@ +/** + * 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.pinot.broker.api.resources; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiKeyAuthDefinition; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.Authorization; +import io.swagger.annotations.SecurityDefinition; +import io.swagger.annotations.SwaggerDefinition; +import java.util.List; +import java.util.Map; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.HttpHeaders; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.pinot.common.utils.LoggerUtils; + +import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY; + + +/** + * Logger resource. + */ +@Api(tags = "Logger", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)}) +@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name = + HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY))) +@Path("/loggers/") +public class PinotBrokerLogger { + + @GET + @Path("") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation(value = "Get all the loggers", notes = "Return all the logger names") + public List<String> getLoggers( + @ApiParam(value = "Name of the table", required = true) @PathParam("tableName") String tableNameWithType) { + return LoggerUtils.getAllLoggers(); + } + + @GET + @Path("{loggerName}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation(value = "Get logger configs", notes = "Return logger info") + public Map<String, Object> getLogger( + @ApiParam(value = "Logger name", required = true) @PathParam("loggerName") String loggerName) { + Map<String, Object> loggerInfo = LoggerUtils.getLoggerInfo(loggerName); + if (loggerInfo == null) { + throw new WebApplicationException(String.format("Logger %s not found", loggerName), Response.Status.NOT_FOUND); + } + return loggerInfo; + } + + @PUT + @Path("{loggerName}/level/{logLevel}") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation(value = "Set logger level", notes = "Set logger level for a given logger") + public Map<String, Object> setLoggerLevel(@ApiParam(value = "Logger name") @PathParam("loggerName") String loggerName, + @ApiParam(value = "Logger level") @PathParam("logLevel") String logLevel) { Review Comment: Consider making level a query param ########## pinot-common/src/main/java/org/apache/pinot/common/utils/LoggerUtils.java: ########## @@ -0,0 +1,104 @@ +/** + * 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.pinot.common.utils; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import javax.annotation.Nullable; +import org.apache.logging.log4j.Level; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.core.LoggerContext; +import org.apache.logging.log4j.core.config.Configuration; +import org.apache.logging.log4j.core.config.LoggerConfig; + + +/** + * Logger utils for process level logger management. + */ +public class LoggerUtils { + private static final String ROOT = "root"; + private static final String NAME = "name"; + private static final String LEVEL = "level"; + private static final String FILTER = "filter"; + + private LoggerUtils() { + } + + /** + * Set logger level at runtime. + * @param loggerName + * @param logLevel + * @return logger info + */ + public static Map<String, Object> setLoggerLevel(String loggerName, String logLevel) { + LoggerContext context = (LoggerContext) LogManager.getContext(false); + Configuration config = context.getConfiguration(); + if (!getAllLoggers().contains(loggerName)) { + throw new RuntimeException("Logger - " + loggerName + " not found"); + } + LoggerConfig loggerConfig = getLoggerConfig(config, loggerName); + try { + loggerConfig.setLevel(Level.valueOf(logLevel)); + } catch (Exception e) { + throw new RuntimeException("Unrecognized logger level - " + logLevel, e); + } + // This causes all Loggers to re-fetch information from their LoggerConfig. + context.updateLoggers(); + return getLoggerResponse(loggerConfig); + } + + /** + * Fetch logger info of name, level and filter. + * @param loggerName + * @return logger info + */ + @Nullable + public static Map<String, Object> getLoggerInfo(String loggerName) { + LoggerContext context = (LoggerContext) LogManager.getContext(false); + Configuration config = context.getConfiguration(); + if (!getAllLoggers().contains(loggerName)) { + return null; + } + LoggerConfig loggerConfig = getLoggerConfig(config, loggerName); + return getLoggerResponse(loggerConfig); + } + + /** + * @return a list of all the logger names + */ + public static List<String> getAllLoggers() { + LoggerContext context = (LoggerContext) LogManager.getContext(false); + Configuration config = context.getConfiguration(); + return config.getLoggers().values().stream().map(LoggerConfig::toString).collect(Collectors.toList()); Review Comment: What is the key of the `config.getLoggers()`? For the root config, seems the key is empty string. What about other logger configs? Can it ever have duplicate values? If so, should we return a set instead? ########## pinot-common/src/test/java/org/apache/pinot/common/utils/LoggerUtilsTest.java: ########## @@ -0,0 +1,84 @@ +/** + * 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.pinot.common.utils; + +import com.google.common.collect.ImmutableList; +import java.util.List; +import java.util.Map; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.testng.Assert; +import org.testng.annotations.Test; + + +public class LoggerUtilsTest { + private static final Logger LOGGER = LoggerFactory.getLogger(LoggerUtilsTest.class); + + @Test + public void testGetAllLoggers() { + List<String> allLoggers = LoggerUtils.getAllLoggers(); + Assert.assertEquals(allLoggers.size(), 1); + Assert.assertEquals(allLoggers.get(0), "root"); + } + + @Test + public void testGetLoggerInfo() { + Map<String, Object> rootLoggerInfo = LoggerUtils.getLoggerInfo("root"); + Assert.assertEquals(rootLoggerInfo.get("name"), "root"); + Assert.assertEquals(rootLoggerInfo.get("level"), "WARN"); + Assert.assertNull(rootLoggerInfo.get("filter")); + + Assert.assertNull(LoggerUtils.getLoggerInfo("notExistLogger")); + } + + @Test + public void testChangeLoggerLevel() { + Assert.assertEquals(LoggerUtils.getLoggerInfo("root").get("level"), "WARN"); + for (String level : ImmutableList.of("WARN", "INFO", "DEBUG", "ERROR", "WARN")) { + LoggerUtils.setLoggerLevel("root", level); + System.out.println("Current logger level is " + level); + loggerAllLevels(); Review Comment: We should verify whether the log has the certain level enabled, e.g. `assertTrue(LOGGER.isWarnEnabled())` ########## pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java: ########## @@ -0,0 +1,83 @@ +/** + * 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.pinot.broker.api.resources; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiKeyAuthDefinition; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.Authorization; +import io.swagger.annotations.SecurityDefinition; +import io.swagger.annotations.SwaggerDefinition; +import java.util.List; +import java.util.Map; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.HttpHeaders; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.pinot.common.utils.LoggerUtils; + +import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY; + + +/** + * Logger resource. + */ +@Api(tags = "Logger", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)}) +@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name = + HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY))) +@Path("/loggers/") +public class PinotBrokerLogger { + + @GET + @Path("") + @Produces(MediaType.APPLICATION_JSON) + @ApiOperation(value = "Get all the loggers", notes = "Return all the logger names") + public List<String> getLoggers( + @ApiParam(value = "Name of the table", required = true) @PathParam("tableName") String tableNameWithType) { Review Comment: Why taking a table name? ########## pinot-broker/src/main/java/org/apache/pinot/broker/api/resources/PinotBrokerLogger.java: ########## @@ -0,0 +1,83 @@ +/** + * 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.pinot.broker.api.resources; + +import io.swagger.annotations.Api; +import io.swagger.annotations.ApiKeyAuthDefinition; +import io.swagger.annotations.ApiOperation; +import io.swagger.annotations.ApiParam; +import io.swagger.annotations.Authorization; +import io.swagger.annotations.SecurityDefinition; +import io.swagger.annotations.SwaggerDefinition; +import java.util.List; +import java.util.Map; +import javax.ws.rs.GET; +import javax.ws.rs.PUT; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.HttpHeaders; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.pinot.common.utils.LoggerUtils; + +import static org.apache.pinot.spi.utils.CommonConstants.SWAGGER_AUTHORIZATION_KEY; + + +/** + * Logger resource. + */ +@Api(tags = "Logger", authorizations = {@Authorization(value = SWAGGER_AUTHORIZATION_KEY)}) +@SwaggerDefinition(securityDefinition = @SecurityDefinition(apiKeyAuthDefinitions = @ApiKeyAuthDefinition(name = + HttpHeaders.AUTHORIZATION, in = ApiKeyAuthDefinition.ApiKeyLocation.HEADER, key = SWAGGER_AUTHORIZATION_KEY))) +@Path("/loggers/") Review Comment: (minor) Not sure if this works as expected. I remember running into some issues before, and we changed all of the root path as `"/"` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
