org.apache.logging.log4j.simple.SimpleLogger Maven / Gradle / Ivy
/*
* 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.logging.log4j.simple;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import java.io.PrintStream;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Map;
import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Marker;
import org.apache.logging.log4j.ThreadContext;
import org.apache.logging.log4j.message.Message;
import org.apache.logging.log4j.message.MessageFactory;
import org.apache.logging.log4j.spi.AbstractLogger;
import org.apache.logging.log4j.util.PropertiesUtil;
import org.apache.logging.log4j.util.Strings;
/**
* This is the default logger that is used when no suitable logging implementation is available.
*/
public class SimpleLogger extends AbstractLogger {
private static final long serialVersionUID = 1L;
private static final char SPACE = ' ';
/**
* Used to format times.
*
* Note that DateFormat is not Thread-safe.
*
*/
private final DateFormat dateFormatter;
private Level level;
private final boolean showDateTime;
private final boolean showContextMap;
private PrintStream stream;
private final String logName;
public SimpleLogger(
final String name,
final Level defaultLevel,
final boolean showLogName,
final boolean showShortLogName,
final boolean showDateTime,
final boolean showContextMap,
final String dateTimeFormat,
final MessageFactory messageFactory,
final PropertiesUtil props,
final PrintStream stream) {
super(name, messageFactory);
final String lvl = props.getStringProperty(SimpleLoggerContext.SYSTEM_PREFIX + name + ".level");
this.level = Level.toLevel(lvl, defaultLevel);
if (showShortLogName) {
final int index = name.lastIndexOf(".");
if (index > 0 && index < name.length()) {
this.logName = name.substring(index + 1);
} else {
this.logName = name;
}
} else if (showLogName) {
this.logName = name;
} else {
this.logName = null;
}
this.showDateTime = showDateTime;
this.showContextMap = showContextMap;
this.stream = stream;
if (showDateTime) {
DateFormat format;
try {
format = new SimpleDateFormat(dateTimeFormat);
} catch (final IllegalArgumentException e) {
// If the format pattern is invalid - use the default format
format = new SimpleDateFormat(SimpleLoggerContext.DEFAULT_DATE_TIME_FORMAT);
}
this.dateFormatter = format;
} else {
this.dateFormatter = null;
}
}
@Override
public Level getLevel() {
return level;
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final Message msg, final Throwable t) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final CharSequence msg, final Throwable t) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final Object msg, final Throwable t) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final String msg) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final String msg, final Object... p1) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final String message, final Object p0) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel, final Marker marker, final String message, final Object p0, final Object p1) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7,
final Object p8) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(
final Level testLevel,
final Marker marker,
final String message,
final Object p0,
final Object p1,
final Object p2,
final Object p3,
final Object p4,
final Object p5,
final Object p6,
final Object p7,
final Object p8,
final Object p9) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
public boolean isEnabled(final Level testLevel, final Marker marker, final String msg, final Throwable t) {
return this.level.intLevel() >= testLevel.intLevel();
}
@Override
@SuppressFBWarnings(
value = "INFORMATION_EXPOSURE_THROUGH_AN_ERROR_MESSAGE",
justification = "Log4j prints stacktraces only to logs, which should be private.")
public void logMessage(
final String fqcn,
final Level mgsLevel,
final Marker marker,
final Message msg,
final Throwable throwable) {
final StringBuilder sb = new StringBuilder();
// Append date-time if so configured
if (showDateTime) {
final Date now = new Date();
String dateText;
synchronized (dateFormatter) {
dateText = dateFormatter.format(now);
}
sb.append(dateText);
sb.append(SPACE);
}
sb.append(mgsLevel.toString());
sb.append(SPACE);
if (Strings.isNotEmpty(logName)) {
sb.append(logName);
sb.append(SPACE);
}
sb.append(msg.getFormattedMessage());
if (showContextMap) {
final Map mdc = ThreadContext.getImmutableContext();
if (mdc.size() > 0) {
sb.append(SPACE);
sb.append(mdc.toString());
sb.append(SPACE);
}
}
final Object[] params = msg.getParameters();
Throwable t;
if (throwable == null
&& params != null
&& params.length > 0
&& params[params.length - 1] instanceof Throwable) {
t = (Throwable) params[params.length - 1];
} else {
t = throwable;
}
stream.println(sb.toString());
if (t != null) {
stream.print(SPACE);
t.printStackTrace(stream);
}
}
public void setLevel(final Level level) {
if (level != null) {
this.level = level;
}
}
public void setStream(final PrintStream stream) {
this.stream = stream;
}
}