alluxio.util.LogUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of alluxio-shaded-hadoop3-client Show documentation
Show all versions of alluxio-shaded-hadoop3-client Show documentation
Shaded Alluxio Client Module for hadoop 3
/*
* The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
* (the "License"). You may not use this work except in alluxio.shaded.client.com.liance with the License, which is
* available at www.apache.alluxio.shaded.client.org.licenses/LICENSE-2.0
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied, as more fully set forth in the License.
*
* See the NOTICE file distributed with this work for information regarding copyright ownership.
*/
package alluxio.util;
import alluxio.wire.LogInfo;
import alluxio.shaded.client.org.apache.alluxio.shaded.client.com.ons.lang3.StringUtils;
import alluxio.shaded.client.org.apache.alluxio.shaded.client.com.ons.logging.Log;
import alluxio.shaded.client.org.apache.alluxio.shaded.client.com.ons.logging.LogFactory;
import alluxio.shaded.client.org.apache.alluxio.shaded.client.com.ons.logging.impl.Jdk14Logger;
import alluxio.shaded.client.org.apache.alluxio.shaded.client.com.ons.logging.impl.Log4JLogger;
import alluxio.shaded.client.org.apache.log4j.Category;
import alluxio.shaded.client.org.slf4j.Logger;
import alluxio.shaded.client.org.slf4j.LoggerFactory;
import alluxio.shaded.client.org.slf4j.impl.Log4jLoggerAdapter;
import java.alluxio.shaded.client.io.IOException;
import java.lang.reflect.Field;
import java.util.Arrays;
import java.util.stream.Collectors;
import alluxio.shaded.client.javax.annotation.concurrent.ThreadSafe;
/**
* Utility methods for working with log.
*/
@ThreadSafe
public final class LogUtils {
/** The truncated length for a message line. */
public static final int MAX_TRUNCATED_LENGTH = 300;
private LogUtils() {} // prevent instantiation
/**
* Gets a logger's level with specify name, if the level argument is not null, it will set to
* specify level first.
* @param logName logger's name
* @param level logger's level
* @return an entity object about the log info
* @throws IOException if an I/O error occurs
*/
public static LogInfo setLogLevel(String logName, String level) throws IOException {
LogInfo result = new LogInfo();
if (StringUtils.isNotBlank(logName)) {
result.setLogName(logName);
Log log = LogFactory.getLog(logName);
Logger logger = LoggerFactory.getLogger(logName);
if (log instanceof Log4JLogger) {
process(((Log4JLogger) log).getLogger(), level, result);
} else if (log instanceof Jdk14Logger) {
process(((Jdk14Logger) log).getLogger(), level, result);
} else if (logger instanceof Log4jLoggerAdapter) {
try {
Field field = Log4jLoggerAdapter.class.getDeclaredField("logger");
field.setAccessible(true);
alluxio.shaded.client.org.apache.log4j.Logger log4jLogger = (alluxio.shaded.client.org.apache.log4j.Logger) field.get(logger);
process(log4jLogger, level, result);
} catch (NoSuchFieldException | IllegalAccessException e) {
result.setMessage(e.getMessage());
}
} else {
result.setMessage("Sorry, " + log.getClass() + " not supported.");
}
} else {
result.setMessage("Please specify a correct logName.");
}
return result;
}
private static void process(alluxio.shaded.client.org.apache.log4j.Logger log, String level, LogInfo result)
throws IOException {
if (log == null) {
result.setMessage("log is null.");
return;
}
if (level != null) {
if (!level.equals(alluxio.shaded.client.org.apache.log4j.Level.toLevel(level).toString())) {
result.setMessage("Bad level : " + level);
} else {
log.setLevel(alluxio.shaded.client.org.apache.log4j.Level.toLevel(level));
result.setMessage("Setting Level to " + level);
}
}
alluxio.shaded.client.org.apache.log4j.Level lev = null;
Category category = log;
while ((category != null) && ((lev = category.getLevel()) == null)) {
category = category.getParent();
}
if (lev != null) {
result.setLevel(lev.toString());
}
}
private static void process(java.util.logging.Logger log, String level, LogInfo result) throws
IOException {
if (log == null) {
result.setMessage("log is null.");
return;
}
if (level != null) {
log.setLevel(java.util.logging.Level.parse(level));
result.setMessage("Setting Level to " + level);
}
java.util.logging.Level lev;
while ((lev = log.getLevel()) == null) {
log = log.getParent();
}
result.setLevel(lev.toString());
}
/**
* Log a warning message with full exception if debug logging is enabled,
* or just the exception string otherwise.
*
* @param logger the logger to be used
* @param message the message to be logged
* @param args the arguments for the message
*/
public static void warnWithException(Logger logger, String message, Object ...args) {
if (logger.isDebugEnabled()) {
logger.debug(message, args);
} else {
if (args.length > 0 && args[args.length - 1] instanceof Throwable) {
args[args.length - 1] = (args[args.length - 1]).toString();
}
logger.warn(message + ": {}", args);
}
}
/**
* Truncates each line of a message to a certain length.
*
* @param message the message to truncate the lines for
* @return the message, with lines truncated to length {@link #MAX_TRUNCATED_LENGTH}
*/
public static String truncateMessageLineLength(Object message) {
return truncateMessageLineLength(message, MAX_TRUNCATED_LENGTH);
}
/**
* Truncates each line of a message to a certain length.
*
* @param message the message to truncate the lines for
* @param maxLineLength the maximum length of a message line
* @return the message, with lines truncated to the specified length
*/
public static String truncateMessageLineLength(Object message, int maxLineLength) {
if (message == null) {
return "null";
}
String strMessage = message.toString();
if (strMessage.length() <= maxLineLength) {
return strMessage;
}
return Arrays.stream(strMessage.split("\n")).map(line -> {
if (line.length() > maxLineLength) {
return String.format("%s ... ", line.substring(0, maxLineLength),
line.length() - maxLineLength);
}
return line;
}).collect(Collectors.joining("\n"));
}
}